13 |
14 | Gilt is a tool which aims to make repo management, manageable. Gilt
15 | clones repositories at a particular version, then overlays the repository to
16 | the provided destination. An alternate approach to "vendoring".
17 |
18 | What makes Gilt interesting, is the ability to overlay particular files and/or
19 | directories from the specified repository to given destinations. Originally,
20 | this was quite helpful for those using Ansible, since libraries, plugins, and
21 | playbooks are often shared, but Ansible's [Galaxy][] has no mechanism to handle
22 | this. Currently, this is proving useful for overlaying [Helm charts][].
23 |
24 | docs directory.
23 |
24 | ),
25 | },
26 | {
27 | title: 'Powered by React',
28 | Svg: require('@site/static/img/undraw_docusaurus_react.svg').default,
29 | description: (
30 | <>
31 | Extend or customize your website layout by reusing React. Docusaurus can
32 | be extended while reusing the same header and footer.
33 |
34 | ),
35 | },
36 | ];
37 |
38 | function Feature({Svg, title, description}) {
39 | return (
40 |
41 |
49 | );
50 | }
51 |
52 | export default function HomepageFeatures() {
53 | return (
54 |
42 |
43 |
44 |
45 | {title}
46 |
48 | {description}
47 |
56 |
62 |
57 | {FeatureList.map((props, idx) => (
58 |
61 | 
10 |
11 | Gilt is a tool which aims to make repo management, manageable. Gilt clones
12 | repositories at a particular version, then overlays the repository to the
13 | provided destination. An alternate approach to "vendoring".
14 |
15 | What makes Gilt interesting, is the ability to overlay particular files and/or
16 | directories from the specified repository to given destinations. Originally,
17 | this was quite helpful for those using Ansible, since libraries, plugins, and
18 | playbooks are often shared, but Ansible's [Galaxy][] has no mechanism to handle
19 | this. Currently, this is proving useful for overlaying [Helm charts][].
20 |
21 | 22 | 23 | ## Alternatives 24 | 25 | - [Repo][] 26 | - [Git submodules][] 27 | - [Git subtree][] 28 | 29 | ## History 30 | 31 | This project is a golang port of [Gilt][py-gilt], and aims to correct poor decisions 32 | made in the python version, primarially around config syntax, portability, and 33 | reproducibility. 34 | 35 | 36 | [Galaxy]: https://docs.ansible.com/ansible/latest/reference_appendices/galaxy.html 37 | [Helm charts]: https://helm.sh/docs/topics/charts/ 38 | [Repo]: https://gerrit.googlesource.com/git-repo/+/refs/heads/master/README.md 39 | [Git submodules]: https://git-scm.com/book/en/v2/Git-Tools-Submodules 40 | [Git subtree]: https://github.com/git/git/blob/master/contrib/subtree/git-subtree.txt 41 | [py-gilt]: http://gilt.readthedocs.io/en/latest/ 42 | 43 | -------------------------------------------------------------------------------- /docs/versioned_docs/version-2.0.3/testing.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 5 3 | --- 4 | 5 | # Testing 6 | 7 | Check installed dependencies: 8 | 9 | ```bash 10 | task deps:check 11 | ``` 12 | 13 | To execute tests: 14 | 15 | ```bash 16 | task test 17 | ``` 18 | 19 | Auto format code: 20 | 21 | ```bash 22 | task fmt 23 | ``` 24 | 25 | List helpful targets: 26 | 27 | ```bash 28 | task 29 | ``` 30 | -------------------------------------------------------------------------------- /docs/versioned_docs/version-2.0.3/usage.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 4 3 | --- 4 | 5 | # Usage 6 | 7 | ## CLI 8 | 9 | ### Init Configuration 10 | 11 | Initializes config file in the shell's current working directory: 12 | 13 | ```bash 14 | gilt init 15 | ``` 16 | 17 | ### Overlay Repository 18 | 19 | Overlay a remote repository into the destination provided. 20 | 21 | ```bash 22 | gilt overlay 23 | ``` 24 | 25 | ### Debug 26 | 27 | Display the git commands being executed. 28 | 29 | ```bash 30 | gilt --debug overlay 31 | ``` 32 | 33 | ## Package 34 | 35 | ### Overlay Repository 36 | 37 | See example client in `examples/go-client/`. 38 | 39 | ```go 40 | func main() { 41 | debug := true 42 | logger := getLogger(debug) 43 | 44 | c := config.Repositories{ 45 | Debug: debug, 46 | GiltDir: "~/.gilt", 47 | Repositories: []config.Repository{ 48 | { 49 | Git: "https://github.com/retr0h/ansible-etcd.git", 50 | Version: "77a95b7", 51 | DstDir: "../tmp/retr0h.ansible-etcd", 52 | }, 53 | }, 54 | } 55 | 56 | var r repositoriesManager = repositories.New(c, logger) 57 | r.Overlay() 58 | } 59 | ``` 60 | -------------------------------------------------------------------------------- /docs/versioned_docs/version-2.1.1/configuration.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 3 3 | --- 4 | 5 | # Configuration 6 | 7 | Gilt uses [Viper][] to load configuation through multiple methods. 8 | 9 | ## Config File 10 | 11 | Create the giltfile (`Giltfile.yaml`). 12 | 13 | Clone the specified `url`@`version` to the configurable path `--gilt-dir`. 14 | Extract the repo the `dstDir` when `dstDir` is provided. Otherwise, copy files 15 | and/or directories to the desired destinations. 16 | 17 | ```yaml 18 | --- 19 | giltDir: ~/.gilt/clone 20 | debug: false 21 | repositories: 22 | - git: https://github.com/retr0h/ansible-etcd.git 23 | version: 77a95b7 24 | dstDir: roles/retr0h.ansible-etcd 25 | - git: https://github.com/retr0h/ansible-etcd.git 26 | version: 1.1 27 | dstDir: roles/retr0h.ansible-etcd-tag 28 | - git: https://github.com/lorin/openstack-ansible-modules.git 29 | version: 2677cc3 30 | sources: 31 | - src: '*_manage' 32 | dstDir: library 33 | - src: nova_quota 34 | dstDir: library 35 | - src: neutron_router 36 | dstFile: library/neutron_router.py 37 | - src: tests 38 | dstDir: tests 39 | commands: 40 | - cmd: ansible-playbook 41 | args: 42 | - -i, 43 | - playbook.yml 44 | - cmd: bash 45 | args: 46 | - -c 47 | - who | grep tty 48 | ``` 49 | 50 | ## Env Vars 51 | 52 | The config file can be overriden/defined through env vars. 53 | 54 | ```bash 55 | GILT_GILTFILE=Giltfile.yaml \ 56 | GILT_GILTDIR=~/.gilt/clone \ 57 | GILT_DEBUG=false \ 58 | gilt overlay 59 | ``` 60 | 61 | ## Command Flags 62 | 63 | The config file and/or env vars can be overriden/defined through cli flags. 64 | 65 | ```bash 66 | gilt \ 67 | --gilt-file=Giltfile.yaml \ 68 | --gilt-dir=~/.gilt/clone \ 69 | --debug \ 70 | overlay 71 | ``` 72 | 73 | 74 | [Viper]: https://github.com/spf13/viper 75 | 76 | -------------------------------------------------------------------------------- /docs/versioned_docs/version-2.1.1/contributing.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 6 3 | --- 4 | 5 | # Contributing 6 | 7 | Contributions to Gilt are very welcome, but we ask that you read this document 8 | before submitting a PR. 9 | 10 | :::note 11 | 12 | This document applies to the [Gilt][] repository. 13 | 14 | ::: 15 | 16 | ## Before you start 17 | 18 | - **Check existing work** - Is there an existing PR? Are there issues discussing 19 | the feature/change you want to make? Please make sure you consider/address 20 | these discussions in your work. 21 | - **Backwards compatibility** - Will your change break existing Giltfiles? It is 22 | much more likely that your change will merged if it backwards compatible. Is 23 | there an approach you can take that maintains this compatibility? If not, 24 | consider opening an issue first so that API changes can be discussed before 25 | you invest your time into a PR. 26 | 27 | ## 1. Setup 28 | 29 | - **Go** - Gilt is written in [Go][]. We always support the latest two major Go 30 | versions, so make sure your version is recent enough. 31 | - **Node.js** - [Node.js][] is used to host Gilt's documentation server and is 32 | required if you want to run this server locally. 33 | 34 | ## 2. Making changes 35 | 36 | - **Code style** - Try to maintain the existing code style where possible. Go 37 | code should be formatted by [`gofumpt`][gofumpt] and linted using 38 | [`golangci-lint`][golangci-lint]. Any Markdown or TypeScript files should be 39 | formatted and linted by [Prettier][]. This style is enforced by our CI to 40 | ensure that we have a consistent style across the project. You can use the 41 | `task fmt:check` command to lint the code locally and the `task fmt` command 42 | to automatically fix any issues that are found. 43 | - **Documentation** - Ensure that you add/update any relevant documentation. See 44 | the [updating documentation](#updating-documentation) section below. 45 | - **Tests** - Ensure that you add/update any relevant tests and that all tests 46 | are passing before submitting the PR. See the [writing tests](#writing-tests) 47 | section below. 48 | 49 | ### Running your changes 50 | 51 | To run Gilt with working changes, you can use `go run main.go overlay`. 52 | 53 | ### Updating documentation 54 | 55 | Gilt uses [Docusaurus][] to host a documentation server. The code for this is 56 | located in the Gilt repository. This can be setup and run locally by using 57 | `task docs:start` (requires `nodejs` & `yarn`). All content is written in 58 | Markdown and is located in the `docs/docs` directory. All Markdown documents 59 | should have an 80 character line wrap limit (enforced by Prettier). 60 | 61 | ### Writing tests 62 | 63 | When making a changes, consider whether new tests are required. These tests 64 | should ensure that the functionality you are adding will continue to work in the 65 | future. Existing tests may also need updating if you have changed Gilt's 66 | behavior. 67 | 68 | You may also consider adding unit tests for any new functions you have added. 69 | The unit tests should follow the Go convention of being location in a file named 70 | `*_test.go` in the same package as the code being tested. 71 | 72 | Integration tests are located in the `tests` directory and executed by [Bats][]. 73 | 74 | ## 3. Committing your code 75 | 76 | Try to write meaningful commit messages and avoid having too many commits on the 77 | PR. Most PRs should likely have a single commit (although for bigger PRs it may 78 | be reasonable to split it in a few). Git squash and rebase is your friend! 79 | 80 | If you're not sure how to format your commit message, check out [Conventional 81 | Commits][]. This style is enforced, and is a good way to make your commit 82 | messages more readable and consistent. 83 | 84 | ## 4. Submitting a PR 85 | 86 | - **Describe your changes** - Ensure that you provide a comprehensive 87 | description of your changes. 88 | - **Issue/PR links** - Link any previous work such as related issues or PRs. 89 | Please describe how your changes differ to/extend this work. 90 | - **Examples** - Add any examples or screenshots that you think are useful to 91 | demonstrate the effect of your changes. 92 | - **Draft PRs** - If your changes are incomplete, but you would like to discuss 93 | them, open the PR as a draft and add a comment to start a discussion. Using 94 | comments rather than the PR description allows the description to be updated 95 | later while preserving any discussions. 96 | 97 | ## FAQ 98 | 99 | > I want to contribute, where do I start? 100 | 101 | All kinds of contributions are welcome, whether its a typo fix or a shiny new 102 | feature. You can also contribute by upvoting/commenting on issues or helping to 103 | answer questions. 104 | 105 | > I'm stuck, where can I get help? 106 | 107 | If you have questions, feel free open a [Discussion][] on GitHub. 108 | 109 | 110 | [Gilt]: https://github.com/retr0h/gilt 111 | [Go]: https://go.dev 112 | [Node.js]: https://nodejs.org/en/ 113 | [gofumpt]: https://github.com/mvdan/gofumpt 114 | [golangci-lint]: https://golangci-lint.run 115 | [Prettier]: https://prettier.io/ 116 | [Docusaurus]: https://docusaurus.io 117 | [Discussion]: https://github.com/retr0h/gilt/discussions 118 | [Conventional Commits]: https://www.conventionalcommits.org 119 | [Bats]: https://github.com/bats-core/bats-core 120 | 121 | -------------------------------------------------------------------------------- /docs/versioned_docs/version-2.1.1/installation.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 2 3 | --- 4 | 5 | # Installation 6 | 7 | ## Homebrew Tap 8 | 9 | ```bash 10 | brew install retr0h/tap/gilt 11 | ``` 12 | 13 | ## Go Install 14 | 15 | ```bash 16 | go install github.com/retr0h/gilt@latest 17 | ``` 18 | 19 | ## Python 20 | 21 | ```bash 22 | pip3 install python-gilt 23 | ``` 24 | -------------------------------------------------------------------------------- /docs/versioned_docs/version-2.1.1/intro.md: -------------------------------------------------------------------------------- 1 | --- 2 | slug: / 3 | sidebar_position: 1 4 | title: Home 5 | --- 6 | 7 | # Gilt 8 | 9 |
10 |
11 | Gilt is a tool which aims to make repo management, manageable. Gilt clones
12 | repositories at a particular version, then overlays the repository to the
13 | provided destination. An alternate approach to "vendoring".
14 |
15 | What makes Gilt interesting, is the ability to overlay particular files and/or
16 | directories from the specified repository to given destinations. Originally,
17 | this was quite helpful for those using Ansible, since libraries, plugins, and
18 | playbooks are often shared, but Ansible's [Galaxy][] has no mechanism to handle
19 | this. Currently, this is proving useful for overlaying [Helm charts][].
20 |
21 | 22 | 23 | ## Alternatives 24 | 25 | - [Repo][] 26 | - [Git submodules][] 27 | - [Git subtree][] 28 | 29 | ## History 30 | 31 | This project is a golang port of [Gilt][py-gilt], and aims to correct poor 32 | decisions made in the python version, primarially around config syntax, 33 | portability, and reproducibility. 34 | 35 | 36 | [Galaxy]: https://docs.ansible.com/ansible/latest/reference_appendices/galaxy.html 37 | [Helm charts]: https://helm.sh/docs/topics/charts/ 38 | [Repo]: https://gerrit.googlesource.com/git-repo/+/refs/heads/master/README.md 39 | [Git submodules]: https://git-scm.com/book/en/v2/Git-Tools-Submodules 40 | [Git subtree]: https://github.com/git/git/blob/master/contrib/subtree/git-subtree.txt 41 | [py-gilt]: http://gilt.readthedocs.io/en/latest/ 42 | 43 | -------------------------------------------------------------------------------- /docs/versioned_docs/version-2.1.1/testing.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 5 3 | --- 4 | 5 | # Testing 6 | 7 | Check installed dependencies: 8 | 9 | ```bash 10 | task deps:check 11 | ``` 12 | 13 | To execute tests: 14 | 15 | ```bash 16 | task test 17 | ``` 18 | 19 | Auto format code: 20 | 21 | ```bash 22 | task fmt 23 | ``` 24 | 25 | List helpful targets: 26 | 27 | ```bash 28 | task 29 | ``` 30 | -------------------------------------------------------------------------------- /docs/versioned_docs/version-2.1.1/usage.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 4 3 | --- 4 | 5 | # Usage 6 | 7 | ## CLI 8 | 9 | ### Init Configuration 10 | 11 | Initializes config file in the shell's current working directory: 12 | 13 | ```bash 14 | gilt init 15 | ``` 16 | 17 | ### Overlay Repository 18 | 19 | Overlay a remote repository into the destination provided. 20 | 21 | ```bash 22 | gilt overlay 23 | ``` 24 | 25 | ### Debug 26 | 27 | Display the git commands being executed. 28 | 29 | ```bash 30 | gilt --debug overlay 31 | ``` 32 | 33 | ## Package 34 | 35 | ### Overlay Repository 36 | 37 | See example client in `examples/go-client/`. 38 | 39 | ```go 40 | func main() { 41 | debug := true 42 | logger := getLogger(debug) 43 | 44 | c := config.Repositories{ 45 | Debug: debug, 46 | GiltDir: "~/.gilt", 47 | Repositories: []config.Repository{ 48 | { 49 | Git: "https://github.com/retr0h/ansible-etcd.git", 50 | Version: "77a95b7", 51 | DstDir: "../tmp/retr0h.ansible-etcd", 52 | }, 53 | }, 54 | } 55 | 56 | var r repositoriesManager = repositories.New(c, logger) 57 | r.Overlay() 58 | } 59 | ``` 60 | -------------------------------------------------------------------------------- /docs/versioned_docs/version-2.1.2/configuration.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 3 3 | --- 4 | 5 | # Configuration 6 | 7 | Gilt uses [Viper][] to load configuation through multiple methods. 8 | 9 | ## Config File 10 | 11 | Create the giltfile (`Giltfile.yaml`). 12 | 13 | Clone the specified `url`@`version` to the configurable path `--gilt-dir`. 14 | Extract the repo the `dstDir` when `dstDir` is provided. Otherwise, copy files 15 | and/or directories to the desired destinations. 16 | 17 | ```yaml 18 | --- 19 | giltDir: ~/.gilt/clone 20 | debug: false 21 | repositories: 22 | - git: https://github.com/retr0h/ansible-etcd.git 23 | version: 77a95b7 24 | dstDir: roles/retr0h.ansible-etcd 25 | - git: https://github.com/retr0h/ansible-etcd.git 26 | version: 1.1 27 | dstDir: roles/retr0h.ansible-etcd-tag 28 | - git: https://github.com/lorin/openstack-ansible-modules.git 29 | version: 2677cc3 30 | sources: 31 | - src: '*_manage' 32 | dstDir: library 33 | - src: nova_quota 34 | dstDir: library 35 | - src: neutron_router 36 | dstFile: library/neutron_router.py 37 | - src: tests 38 | dstDir: tests 39 | commands: 40 | - cmd: ansible-playbook 41 | args: 42 | - -i, 43 | - playbook.yml 44 | - cmd: bash 45 | args: 46 | - -c 47 | - who | grep tty 48 | ``` 49 | 50 | ## Env Vars 51 | 52 | The config file can be overriden/defined through env vars. 53 | 54 | ```bash 55 | GILT_GILTFILE=Giltfile.yaml \ 56 | GILT_GILTDIR=~/.gilt/clone \ 57 | GILT_DEBUG=false \ 58 | gilt overlay 59 | ``` 60 | 61 | ## Command Flags 62 | 63 | The config file and/or env vars can be overriden/defined through cli flags. 64 | 65 | ```bash 66 | gilt \ 67 | --gilt-file=Giltfile.yaml \ 68 | --gilt-dir=~/.gilt/clone \ 69 | --debug \ 70 | overlay 71 | ``` 72 | 73 | 74 | [Viper]: https://github.com/spf13/viper 75 | 76 | -------------------------------------------------------------------------------- /docs/versioned_docs/version-2.1.2/contributing.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 6 3 | --- 4 | 5 | # Contributing 6 | 7 | Contributions to Gilt are very welcome, but we ask that you read this document 8 | before submitting a PR. 9 | 10 | :::note 11 | 12 | This document applies to the [Gilt][] repository. 13 | 14 | ::: 15 | 16 | ## Before you start 17 | 18 | - **Check existing work** - Is there an existing PR? Are there issues discussing 19 | the feature/change you want to make? Please make sure you consider/address 20 | these discussions in your work. 21 | - **Backwards compatibility** - Will your change break existing Giltfiles? It is 22 | much more likely that your change will merged if it backwards compatible. Is 23 | there an approach you can take that maintains this compatibility? If not, 24 | consider opening an issue first so that API changes can be discussed before 25 | you invest your time into a PR. 26 | 27 | ## 1. Setup 28 | 29 | - **Go** - Gilt is written in [Go][]. We always support the latest two major Go 30 | versions, so make sure your version is recent enough. 31 | - **Node.js** - [Node.js][] is used to host Gilt's documentation server and is 32 | required if you want to run this server locally. 33 | 34 | ## 2. Making changes 35 | 36 | - **Code style** - Try to maintain the existing code style where possible. Go 37 | code should be formatted by [`gofumpt`][gofumpt] and linted using 38 | [`golangci-lint`][golangci-lint]. Any Markdown or TypeScript files should be 39 | formatted and linted by [Prettier][]. This style is enforced by our CI to 40 | ensure that we have a consistent style across the project. You can use the 41 | `task fmt:check` command to lint the code locally and the `task fmt` command 42 | to automatically fix any issues that are found. 43 | - **Documentation** - Ensure that you add/update any relevant documentation. See 44 | the [updating documentation](#updating-documentation) section below. 45 | - **Tests** - Ensure that you add/update any relevant tests and that all tests 46 | are passing before submitting the PR. See the [writing tests](#writing-tests) 47 | section below. 48 | 49 | ### Running your changes 50 | 51 | To run Gilt with working changes, you can use `go run main.go overlay`. 52 | 53 | ### Updating documentation 54 | 55 | Gilt uses [Docusaurus][] to host a documentation server. The code for this is 56 | located in the Gilt repository. This can be setup and run locally by using 57 | `task docs:start` (requires `nodejs` & `yarn`). All content is written in 58 | Markdown and is located in the `docs/docs` directory. All Markdown documents 59 | should have an 80 character line wrap limit (enforced by Prettier). 60 | 61 | ### Writing tests 62 | 63 | When making a changes, consider whether new tests are required. These tests 64 | should ensure that the functionality you are adding will continue to work in the 65 | future. Existing tests may also need updating if you have changed Gilt's 66 | behavior. 67 | 68 | You may also consider adding unit tests for any new functions you have added. 69 | The unit tests should follow the Go convention of being location in a file named 70 | `*_test.go` in the same package as the code being tested. 71 | 72 | Integration tests are located in the `tests` directory and executed by [Bats][]. 73 | 74 | ## 3. Committing your code 75 | 76 | Try to write meaningful commit messages and avoid having too many commits on the 77 | PR. Most PRs should likely have a single commit (although for bigger PRs it may 78 | be reasonable to split it in a few). Git squash and rebase is your friend! 79 | 80 | If you're not sure how to format your commit message, check out [Conventional 81 | Commits][]. This style is enforced, and is a good way to make your commit 82 | messages more readable and consistent. 83 | 84 | ## 4. Submitting a PR 85 | 86 | - **Describe your changes** - Ensure that you provide a comprehensive 87 | description of your changes. 88 | - **Issue/PR links** - Link any previous work such as related issues or PRs. 89 | Please describe how your changes differ to/extend this work. 90 | - **Examples** - Add any examples or screenshots that you think are useful to 91 | demonstrate the effect of your changes. 92 | - **Draft PRs** - If your changes are incomplete, but you would like to discuss 93 | them, open the PR as a draft and add a comment to start a discussion. Using 94 | comments rather than the PR description allows the description to be updated 95 | later while preserving any discussions. 96 | 97 | ## FAQ 98 | 99 | > I want to contribute, where do I start? 100 | 101 | All kinds of contributions are welcome, whether its a typo fix or a shiny new 102 | feature. You can also contribute by upvoting/commenting on issues or helping to 103 | answer questions. 104 | 105 | > I'm stuck, where can I get help? 106 | 107 | If you have questions, feel free open a [Discussion][] on GitHub. 108 | 109 | 110 | [Gilt]: https://github.com/retr0h/gilt 111 | [Go]: https://go.dev 112 | [Node.js]: https://nodejs.org/en/ 113 | [gofumpt]: https://github.com/mvdan/gofumpt 114 | [golangci-lint]: https://golangci-lint.run 115 | [Prettier]: https://prettier.io/ 116 | [Docusaurus]: https://docusaurus.io 117 | [Discussion]: https://github.com/retr0h/gilt/discussions 118 | [Conventional Commits]: https://www.conventionalcommits.org 119 | [Bats]: https://github.com/bats-core/bats-core 120 | 121 | -------------------------------------------------------------------------------- /docs/versioned_docs/version-2.1.2/installation.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 2 3 | --- 4 | 5 | # Installation 6 | 7 | ## Homebrew Tap 8 | 9 | ```bash 10 | brew install retr0h/tap/gilt 11 | ``` 12 | 13 | ## Go Install 14 | 15 | ```bash 16 | go install github.com/retr0h/gilt/v2@latest 17 | ``` 18 | 19 | ## Python 20 | 21 | ```bash 22 | pip3 install python-gilt 23 | ``` 24 | -------------------------------------------------------------------------------- /docs/versioned_docs/version-2.1.2/intro.md: -------------------------------------------------------------------------------- 1 | --- 2 | slug: / 3 | sidebar_position: 1 4 | title: Home 5 | --- 6 | 7 | # Gilt 8 | 9 |
10 |
11 | Gilt is a tool which aims to make repo management, manageable. Gilt clones
12 | repositories at a particular version, then overlays the repository to the
13 | provided destination. An alternate approach to "vendoring".
14 |
15 | What makes Gilt interesting, is the ability to overlay particular files and/or
16 | directories from the specified repository to given destinations. Originally,
17 | this was quite helpful for those using Ansible, since libraries, plugins, and
18 | playbooks are often shared, but Ansible's [Galaxy][] has no mechanism to handle
19 | this. Currently, this is proving useful for overlaying [Helm charts][].
20 |
21 | 22 | 23 | ## Alternatives 24 | 25 | - [Repo][] 26 | - [Git submodules][] 27 | - [Git subtree][] 28 | 29 | ## History 30 | 31 | This project is a golang port of [Gilt][py-gilt], and aims to correct poor 32 | decisions made in the python version, primarially around config syntax, 33 | portability, and reproducibility. 34 | 35 | 36 | [Galaxy]: https://docs.ansible.com/ansible/latest/reference_appendices/galaxy.html 37 | [Helm charts]: https://helm.sh/docs/topics/charts/ 38 | [Repo]: https://gerrit.googlesource.com/git-repo/+/refs/heads/master/README.md 39 | [Git submodules]: https://git-scm.com/book/en/v2/Git-Tools-Submodules 40 | [Git subtree]: https://github.com/git/git/blob/master/contrib/subtree/git-subtree.txt 41 | [py-gilt]: http://gilt.readthedocs.io/en/latest/ 42 | 43 | -------------------------------------------------------------------------------- /docs/versioned_docs/version-2.1.2/testing.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 5 3 | --- 4 | 5 | # Testing 6 | 7 | Check installed dependencies: 8 | 9 | ```bash 10 | task deps:check 11 | ``` 12 | 13 | To execute tests: 14 | 15 | ```bash 16 | task test 17 | ``` 18 | 19 | Auto format code: 20 | 21 | ```bash 22 | task fmt 23 | ``` 24 | 25 | List helpful targets: 26 | 27 | ```bash 28 | task 29 | ``` 30 | -------------------------------------------------------------------------------- /docs/versioned_docs/version-2.1.2/usage.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 4 3 | --- 4 | 5 | # Usage 6 | 7 | ## CLI 8 | 9 | ### Init Configuration 10 | 11 | Initializes config file in the shell's current working directory: 12 | 13 | ```bash 14 | gilt init 15 | ``` 16 | 17 | ### Overlay Repository 18 | 19 | Overlay a remote repository into the destination provided. 20 | 21 | ```bash 22 | gilt overlay 23 | ``` 24 | 25 | ### Debug 26 | 27 | Display the git commands being executed. 28 | 29 | ```bash 30 | gilt --debug overlay 31 | ``` 32 | 33 | ## Package 34 | 35 | ### Overlay Repository 36 | 37 | See example client in `examples/go-client/`. 38 | 39 | ```go 40 | func main() { 41 | debug := true 42 | logger := getLogger(debug) 43 | 44 | c := config.Repositories{ 45 | Debug: debug, 46 | GiltDir: "~/.gilt", 47 | Repositories: []config.Repository{ 48 | { 49 | Git: "https://github.com/retr0h/ansible-etcd.git", 50 | Version: "77a95b7", 51 | DstDir: "../tmp/retr0h.ansible-etcd", 52 | }, 53 | }, 54 | } 55 | 56 | var r repositoriesManager = repositories.New(c, logger) 57 | r.Overlay() 58 | } 59 | ``` 60 | -------------------------------------------------------------------------------- /docs/versioned_docs/version-2.2.1/configuration.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 3 3 | --- 4 | 5 | # Configuration 6 | 7 | Gilt uses [Viper][] to load configuation through multiple methods. 8 | 9 | ## Config File 10 | 11 | Create the giltfile (`Giltfile.yaml`). 12 | 13 | Clone the specified `url`@`version` to the configurable path `--gilt-dir`. 14 | Extract the repo the `dstDir` when `dstDir` is provided. Otherwise, copy files 15 | and/or directories to the desired destinations. 16 | 17 | ```yaml 18 | --- 19 | giltDir: ~/.gilt/clone 20 | debug: false 21 | parallel: true 22 | repositories: 23 | - git: https://github.com/retr0h/ansible-etcd.git 24 | version: 77a95b7 25 | dstDir: roles/retr0h.ansible-etcd 26 | - git: https://github.com/retr0h/ansible-etcd.git 27 | version: 1.1 28 | dstDir: roles/retr0h.ansible-etcd-tag 29 | - git: https://github.com/lorin/openstack-ansible-modules.git 30 | version: 2677cc3 31 | sources: 32 | - src: '*_manage' 33 | dstDir: library 34 | - src: nova_quota 35 | dstDir: library 36 | - src: neutron_router 37 | dstFile: library/neutron_router.py 38 | - src: tests 39 | dstDir: tests 40 | commands: 41 | - cmd: ansible-playbook 42 | args: 43 | - -i, 44 | - playbook.yml 45 | - cmd: bash 46 | args: 47 | - -c 48 | - who | grep tty 49 | ``` 50 | 51 | ## Env Vars 52 | 53 | The config file can be overriden/defined through env vars. 54 | 55 | ```bash 56 | GILT_GILTFILE=Giltfile.yaml \ 57 | GILT_GILTDIR=~/.gilt/clone \ 58 | GILT_DEBUG=false \ 59 | GILT_PARALLEL=false \ 60 | gilt overlay 61 | ``` 62 | 63 | ## Command Flags 64 | 65 | The config file and/or env vars can be overriden/defined through cli flags. 66 | 67 | ```bash 68 | gilt \ 69 | --gilt-file=Giltfile.yaml \ 70 | --gilt-dir=~/.gilt/clone \ 71 | --debug \ 72 | --parallel=false \ 73 | overlay 74 | ``` 75 | 76 | 77 | [Viper]: https://github.com/spf13/viper 78 | 79 | -------------------------------------------------------------------------------- /docs/versioned_docs/version-2.2.1/contributing.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 6 3 | --- 4 | 5 | # Contributing 6 | 7 | Contributions to Gilt are very welcome, but we ask that you read this document 8 | before submitting a PR. 9 | 10 | :::note 11 | 12 | This document applies to the [Gilt][] repository. 13 | 14 | ::: 15 | 16 | ## Before you start 17 | 18 | - **Check existing work** - Is there an existing PR? Are there issues discussing 19 | the feature/change you want to make? Please make sure you consider/address 20 | these discussions in your work. 21 | - **Backwards compatibility** - Will your change break existing Giltfiles? It is 22 | much more likely that your change will merged if it backwards compatible. Is 23 | there an approach you can take that maintains this compatibility? If not, 24 | consider opening an issue first so that API changes can be discussed before 25 | you invest your time into a PR. 26 | 27 | ## 1. Setup 28 | 29 | - **Go** - Gilt is written in [Go][]. We always support the latest two major Go 30 | versions, so make sure your version is recent enough. 31 | - **Node.js** - [Node.js][] is used to host Gilt's documentation server and is 32 | required if you want to run this server locally. 33 | 34 | ## 2. Making changes 35 | 36 | - **Code style** - Try to maintain the existing code style where possible. Go 37 | code should be formatted by [`gofumpt`][gofumpt] and linted using 38 | [`golangci-lint`][golangci-lint]. Any Markdown or TypeScript files should be 39 | formatted and linted by [Prettier][]. This style is enforced by our CI to 40 | ensure that we have a consistent style across the project. You can use the 41 | `task fmt:check` command to lint the code locally and the `task fmt` command 42 | to automatically fix any issues that are found. 43 | - **Documentation** - Ensure that you add/update any relevant documentation. See 44 | the [updating documentation](#updating-documentation) section below. 45 | - **Tests** - Ensure that you add/update any relevant tests and that all tests 46 | are passing before submitting the PR. See the [writing tests](#writing-tests) 47 | section below. 48 | 49 | ### Running your changes 50 | 51 | To run Gilt with working changes, you can use `go run main.go overlay`. 52 | 53 | ### Updating documentation 54 | 55 | Gilt uses [Docusaurus][] to host a documentation server. The code for this is 56 | located in the Gilt repository. This can be setup and run locally by using 57 | `task docs:start` (requires `nodejs` & `yarn`). All content is written in 58 | Markdown and is located in the `docs/docs` directory. All Markdown documents 59 | should have an 80 character line wrap limit (enforced by Prettier). 60 | 61 | ### Writing tests 62 | 63 | When making a changes, consider whether new tests are required. These tests 64 | should ensure that the functionality you are adding will continue to work in the 65 | future. Existing tests may also need updating if you have changed Gilt's 66 | behavior. 67 | 68 | You may also consider adding unit tests for any new functions you have added. 69 | The unit tests should follow the Go convention of being location in a file named 70 | `*_test.go` in the same package as the code being tested. 71 | 72 | Integration tests are located in the `tests` directory and executed by [Bats][]. 73 | 74 | ## 3. Committing your code 75 | 76 | Try to write meaningful commit messages and avoid having too many commits on the 77 | PR. Most PRs should likely have a single commit (although for bigger PRs it may 78 | be reasonable to split it in a few). Git squash and rebase is your friend! 79 | 80 | If you're not sure how to format your commit message, check out [Conventional 81 | Commits][]. This style is enforced, and is a good way to make your commit 82 | messages more readable and consistent. 83 | 84 | ## 4. Submitting a PR 85 | 86 | - **Describe your changes** - Ensure that you provide a comprehensive 87 | description of your changes. 88 | - **Issue/PR links** - Link any previous work such as related issues or PRs. 89 | Please describe how your changes differ to/extend this work. 90 | - **Examples** - Add any examples or screenshots that you think are useful to 91 | demonstrate the effect of your changes. 92 | - **Draft PRs** - If your changes are incomplete, but you would like to discuss 93 | them, open the PR as a draft and add a comment to start a discussion. Using 94 | comments rather than the PR description allows the description to be updated 95 | later while preserving any discussions. 96 | 97 | ## FAQ 98 | 99 | > I want to contribute, where do I start? 100 | 101 | All kinds of contributions are welcome, whether its a typo fix or a shiny new 102 | feature. You can also contribute by upvoting/commenting on issues or helping to 103 | answer questions. 104 | 105 | > I'm stuck, where can I get help? 106 | 107 | If you have questions, feel free open a [Discussion][] on GitHub. 108 | 109 | 110 | [Gilt]: https://github.com/retr0h/gilt 111 | [Go]: https://go.dev 112 | [Node.js]: https://nodejs.org/en/ 113 | [gofumpt]: https://github.com/mvdan/gofumpt 114 | [golangci-lint]: https://golangci-lint.run 115 | [Prettier]: https://prettier.io/ 116 | [Docusaurus]: https://docusaurus.io 117 | [Discussion]: https://github.com/retr0h/gilt/discussions 118 | [Conventional Commits]: https://www.conventionalcommits.org 119 | [Bats]: https://github.com/bats-core/bats-core 120 | 121 | -------------------------------------------------------------------------------- /docs/versioned_docs/version-2.2.1/installation.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 2 3 | --- 4 | 5 | # Installation 6 | 7 | ## Homebrew Tap 8 | 9 | ```bash 10 | brew install retr0h/tap/gilt 11 | ``` 12 | 13 | ## Go Install 14 | 15 | ```bash 16 | go install github.com/retr0h/gilt/v2@latest 17 | ``` 18 | 19 | ## Python 20 | 21 | ```bash 22 | pip3 install python-gilt 23 | ``` 24 | -------------------------------------------------------------------------------- /docs/versioned_docs/version-2.2.1/intro.md: -------------------------------------------------------------------------------- 1 | --- 2 | slug: / 3 | sidebar_position: 1 4 | title: Home 5 | --- 6 | 7 | # Gilt 8 | 9 |
10 |
11 | Gilt is a tool which aims to make repo management, manageable. Gilt clones
12 | repositories at a particular version, then overlays the repository to the
13 | provided destination. An alternate approach to "vendoring".
14 |
15 | What makes Gilt interesting, is the ability to overlay particular files and/or
16 | directories from the specified repository to given destinations. Originally,
17 | this was quite helpful for those using Ansible, since libraries, plugins, and
18 | playbooks are often shared, but Ansible's [Galaxy][] has no mechanism to handle
19 | this. Currently, this is proving useful for overlaying [Helm charts][].
20 |
21 | 22 | 23 | ## Alternatives 24 | 25 | - [Repo][] 26 | - [Git submodules][] 27 | - [Git subtree][] 28 | 29 | ## History 30 | 31 | This project is a golang port of [Gilt][py-gilt], and aims to correct poor 32 | decisions made in the python version, primarially around config syntax, 33 | portability, and reproducibility. 34 | 35 | 36 | [Galaxy]: https://docs.ansible.com/ansible/latest/reference_appendices/galaxy.html 37 | [Helm charts]: https://helm.sh/docs/topics/charts/ 38 | [Repo]: https://gerrit.googlesource.com/git-repo/+/refs/heads/master/README.md 39 | [Git submodules]: https://git-scm.com/book/en/v2/Git-Tools-Submodules 40 | [Git subtree]: https://github.com/git/git/blob/master/contrib/subtree/git-subtree.txt 41 | [py-gilt]: http://gilt.readthedocs.io/en/latest/ 42 | 43 | -------------------------------------------------------------------------------- /docs/versioned_docs/version-2.2.1/testing.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 5 3 | --- 4 | 5 | # Testing 6 | 7 | Check installed dependencies: 8 | 9 | ```bash 10 | task deps:check 11 | ``` 12 | 13 | To execute tests: 14 | 15 | ```bash 16 | task test 17 | ``` 18 | 19 | Auto format code: 20 | 21 | ```bash 22 | task fmt 23 | ``` 24 | 25 | List helpful targets: 26 | 27 | ```bash 28 | task 29 | ``` 30 | -------------------------------------------------------------------------------- /docs/versioned_docs/version-2.2.1/usage.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 4 3 | --- 4 | 5 | # Usage 6 | 7 | ## CLI 8 | 9 | ### Init Configuration 10 | 11 | Initializes config file in the shell's current working directory: 12 | 13 | ```bash 14 | gilt init 15 | ``` 16 | 17 | ### Overlay Repository 18 | 19 | Overlay a remote repository into the destination provided. 20 | 21 | ```bash 22 | gilt overlay 23 | ``` 24 | 25 | ### Debug 26 | 27 | Display the git commands being executed. 28 | 29 | ```bash 30 | gilt --debug overlay 31 | ``` 32 | 33 | ## Package 34 | 35 | ### Overlay Repository 36 | 37 | See example client in `examples/go-client/`. 38 | 39 | ```go 40 | func main() { 41 | debug := true 42 | logger := getLogger(debug) 43 | 44 | c := config.Repositories{ 45 | Debug: debug, 46 | GiltDir: "~/.gilt", 47 | Repositories: []config.Repository{ 48 | { 49 | Git: "https://github.com/retr0h/ansible-etcd.git", 50 | Version: "77a95b7", 51 | DstDir: "../tmp/retr0h.ansible-etcd", 52 | }, 53 | }, 54 | } 55 | 56 | var r repositoriesManager = repositories.New(c, logger) 57 | r.Overlay() 58 | } 59 | ``` 60 | -------------------------------------------------------------------------------- /docs/versioned_docs/version-2.2.2/configuration.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 3 3 | --- 4 | 5 | # Configuration 6 | 7 | Gilt uses [Viper][] to load configuation through multiple methods. 8 | 9 | ## Config File 10 | 11 | Create the giltfile (`Giltfile.yaml`). 12 | 13 | Clone the specified `url`@`version` to the configurable path `--gilt-dir`. 14 | Extract the repo the `dstDir` when `dstDir` is provided. Otherwise, copy files 15 | and/or directories to the desired destinations. 16 | 17 | ```yaml 18 | --- 19 | giltDir: ~/.gilt/clone 20 | debug: false 21 | parallel: true 22 | repositories: 23 | - git: https://github.com/retr0h/ansible-etcd.git 24 | version: 77a95b7 25 | dstDir: roles/retr0h.ansible-etcd 26 | - git: https://github.com/retr0h/ansible-etcd.git 27 | version: 1.1 28 | dstDir: roles/retr0h.ansible-etcd-tag 29 | - git: https://github.com/lorin/openstack-ansible-modules.git 30 | version: 2677cc3 31 | sources: 32 | - src: '*_manage' 33 | dstDir: library 34 | - src: nova_quota 35 | dstDir: library 36 | - src: neutron_router 37 | dstFile: library/neutron_router.py 38 | - src: tests 39 | dstDir: tests 40 | commands: 41 | - cmd: ansible-playbook 42 | args: 43 | - -i, 44 | - playbook.yml 45 | - cmd: bash 46 | args: 47 | - -c 48 | - who | grep tty 49 | ``` 50 | 51 | ## Env Vars 52 | 53 | The config file can be overriden/defined through env vars. 54 | 55 | ```bash 56 | GILT_GILTFILE=Giltfile.yaml \ 57 | GILT_GILTDIR=~/.gilt/clone \ 58 | GILT_DEBUG=false \ 59 | GILT_PARALLEL=false \ 60 | gilt overlay 61 | ``` 62 | 63 | ## Command Flags 64 | 65 | The config file and/or env vars can be overriden/defined through cli flags. 66 | 67 | ```bash 68 | gilt \ 69 | --gilt-file=Giltfile.yaml \ 70 | --gilt-dir=~/.gilt/clone \ 71 | --debug \ 72 | --parallel=false \ 73 | overlay 74 | ``` 75 | 76 | 77 | [Viper]: https://github.com/spf13/viper 78 | 79 | -------------------------------------------------------------------------------- /docs/versioned_docs/version-2.2.2/contributing.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 6 3 | --- 4 | 5 | # Contributing 6 | 7 | Contributions to Gilt are very welcome, but we ask that you read this document 8 | before submitting a PR. 9 | 10 | :::note 11 | 12 | This document applies to the [Gilt][] repository. 13 | 14 | ::: 15 | 16 | ## Before you start 17 | 18 | - **Check existing work** - Is there an existing PR? Are there issues discussing 19 | the feature/change you want to make? Please make sure you consider/address 20 | these discussions in your work. 21 | - **Backwards compatibility** - Will your change break existing Giltfiles? It is 22 | much more likely that your change will merged if it backwards compatible. Is 23 | there an approach you can take that maintains this compatibility? If not, 24 | consider opening an issue first so that API changes can be discussed before 25 | you invest your time into a PR. 26 | 27 | ## 1. Setup 28 | 29 | - **Go** - Gilt is written in [Go][]. We always support the latest two major Go 30 | versions, so make sure your version is recent enough. 31 | - **Node.js** - [Node.js][] is used to host Gilt's documentation server and is 32 | required if you want to run this server locally. 33 | 34 | ## 2. Making changes 35 | 36 | - **Code style** - Try to maintain the existing code style where possible. Go 37 | code should be formatted by [`gofumpt`][gofumpt] and linted using 38 | [`golangci-lint`][golangci-lint]. Any Markdown or TypeScript files should be 39 | formatted and linted by [Prettier][]. This style is enforced by our CI to 40 | ensure that we have a consistent style across the project. You can use the 41 | `task fmt:check` command to lint the code locally and the `task fmt` command 42 | to automatically fix any issues that are found. 43 | - **Documentation** - Ensure that you add/update any relevant documentation. See 44 | the [updating documentation](#updating-documentation) section below. 45 | - **Tests** - Ensure that you add/update any relevant tests and that all tests 46 | are passing before submitting the PR. See the [writing tests](#writing-tests) 47 | section below. 48 | 49 | ### Running your changes 50 | 51 | To run Gilt with working changes, you can use `go run main.go overlay`. 52 | 53 | ### Updating documentation 54 | 55 | Gilt uses [Docusaurus][] to host a documentation server. The code for this is 56 | located in the Gilt repository. This can be setup and run locally by using 57 | `task docs:start` (requires `nodejs` & `yarn`). All content is written in 58 | Markdown and is located in the `docs/docs` directory. All Markdown documents 59 | should have an 80 character line wrap limit (enforced by Prettier). 60 | 61 | ### Writing tests 62 | 63 | When making changes, consider whether new tests are required. These tests should 64 | ensure that the functionality you are adding will continue to work in the 65 | future. Existing tests may also need updating if you have changed Gilt's 66 | behavior. 67 | 68 | You may also consider adding unit tests for any new functions you have added. 69 | The unit tests should follow the Go convention of being location in a file named 70 | `*_test.go` in the same package as the code being tested. 71 | 72 | Integration tests are located in the `tests` directory and executed by [Bats][]. 73 | 74 | ## 3. Committing your code 75 | 76 | Try to write meaningful commit messages and avoid having too many commits on the 77 | PR. Most PRs should likely have a single commit (although for bigger PRs it may 78 | be reasonable to split it in a few). Git squash and rebase is your friend! 79 | 80 | If you're not sure how to format your commit message, check out [Conventional 81 | Commits][]. This style is enforced, and is a good way to make your commit 82 | messages more readable and consistent. 83 | 84 | ## 4. Submitting a PR 85 | 86 | - **Describe your changes** - Ensure that you provide a comprehensive 87 | description of your changes. 88 | - **Issue/PR links** - Link any previous work such as related issues or PRs. 89 | Please describe how your changes differ to/extend this work. 90 | - **Examples** - Add any examples or screenshots that you think are useful to 91 | demonstrate the effect of your changes. 92 | - **Draft PRs** - If your changes are incomplete, but you would like to discuss 93 | them, open the PR as a draft and add a comment to start a discussion. Using 94 | comments rather than the PR description allows the description to be updated 95 | later while preserving any discussions. 96 | 97 | ## FAQ 98 | 99 | > I want to contribute, where do I start? 100 | 101 | All kinds of contributions are welcome, whether its a typo fix or a shiny new 102 | feature. You can also contribute by upvoting/commenting on issues or helping to 103 | answer questions. 104 | 105 | > I'm stuck, where can I get help? 106 | 107 | If you have questions, feel free open a [Discussion][] on GitHub. 108 | 109 | 110 | [Gilt]: https://github.com/retr0h/gilt 111 | [Go]: https://go.dev 112 | [Node.js]: https://nodejs.org/en/ 113 | [gofumpt]: https://github.com/mvdan/gofumpt 114 | [golangci-lint]: https://golangci-lint.run 115 | [Prettier]: https://prettier.io/ 116 | [Docusaurus]: https://docusaurus.io 117 | [Discussion]: https://github.com/retr0h/gilt/discussions 118 | [Conventional Commits]: https://www.conventionalcommits.org 119 | [Bats]: https://github.com/bats-core/bats-core 120 | 121 | -------------------------------------------------------------------------------- /docs/versioned_docs/version-2.2.2/installation.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 2 3 | --- 4 | 5 | # Installation 6 | 7 | ## Homebrew Tap 8 | 9 | ```bash 10 | brew install retr0h/tap/gilt 11 | ``` 12 | 13 | ## Go Install 14 | 15 | ```bash 16 | go install github.com/retr0h/gilt/v2@latest 17 | ``` 18 | 19 | ## Python 20 | 21 | ```bash 22 | pip3 install python-gilt 23 | ``` 24 | -------------------------------------------------------------------------------- /docs/versioned_docs/version-2.2.2/intro.md: -------------------------------------------------------------------------------- 1 | --- 2 | slug: / 3 | sidebar_position: 1 4 | title: Home 5 | --- 6 | 7 | # Gilt 8 | 9 |
10 |
11 | Gilt is a tool which aims to make repo management, manageable. Gilt clones
12 | repositories at a particular version, then overlays the repository to the
13 | provided destination. An alternate approach to "vendoring".
14 |
15 | What makes Gilt interesting, is the ability to overlay particular files and/or
16 | directories from the specified repository to given destinations. Originally,
17 | this was quite helpful for those using Ansible, since libraries, plugins, and
18 | playbooks are often shared, but Ansible's [Galaxy][] has no mechanism to handle
19 | this. Currently, this is proving useful for overlaying [Helm charts][].
20 |
21 | 22 | 23 | ## Alternatives 24 | 25 | - [Repo][] 26 | - [Git submodules][] 27 | - [Git subtree][] 28 | 29 | ## History 30 | 31 | This project is a golang port of [Gilt][py-gilt], and aims to correct poor 32 | decisions made in the python version, primarially around config syntax, 33 | portability, and reproducibility. 34 | 35 | 36 | [Galaxy]: https://docs.ansible.com/ansible/latest/reference_appendices/galaxy.html 37 | [Helm charts]: https://helm.sh/docs/topics/charts/ 38 | [Repo]: https://gerrit.googlesource.com/git-repo/+/refs/heads/master/README.md 39 | [Git submodules]: https://git-scm.com/book/en/v2/Git-Tools-Submodules 40 | [Git subtree]: https://github.com/git/git/blob/master/contrib/subtree/git-subtree.txt 41 | [py-gilt]: http://gilt.readthedocs.io/en/latest/ 42 | 43 | -------------------------------------------------------------------------------- /docs/versioned_docs/version-2.2.2/testing.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 5 3 | --- 4 | 5 | # Testing 6 | 7 | Check installed dependencies: 8 | 9 | ```bash 10 | task deps:check 11 | ``` 12 | 13 | To execute tests: 14 | 15 | ```bash 16 | task test 17 | ``` 18 | 19 | Auto format code: 20 | 21 | ```bash 22 | task fmt 23 | ``` 24 | 25 | List helpful targets: 26 | 27 | ```bash 28 | task 29 | ``` 30 | -------------------------------------------------------------------------------- /docs/versioned_docs/version-2.2.2/usage.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 4 3 | --- 4 | 5 | # Usage 6 | 7 | ## CLI 8 | 9 | ### Init Configuration 10 | 11 | Initializes config file in the shell's current working directory: 12 | 13 | ```bash 14 | gilt init 15 | ``` 16 | 17 | ### Overlay Repository 18 | 19 | Overlay a remote repository into the destination provided. 20 | 21 | ```bash 22 | gilt overlay 23 | ``` 24 | 25 | ### Debug 26 | 27 | Display the git commands being executed. 28 | 29 | ```bash 30 | gilt --debug overlay 31 | ``` 32 | 33 | ### Skipping post-commands 34 | 35 | Overlay files only, but run no other commands. 36 | 37 | ```bash 38 | gilt overlay --no-commands 39 | ``` 40 | 41 | ## Package 42 | 43 | ### Overlay Repository 44 | 45 | See example client in `examples/go-client/`. 46 | 47 | ```go 48 | func main() { 49 | debug := true 50 | logger := getLogger(debug) 51 | 52 | c := config.Repositories{ 53 | Debug: debug, 54 | GiltDir: "~/.gilt", 55 | Repositories: []config.Repository{ 56 | { 57 | Git: "https://github.com/retr0h/ansible-etcd.git", 58 | Version: "77a95b7", 59 | DstDir: "../tmp/retr0h.ansible-etcd", 60 | }, 61 | }, 62 | } 63 | 64 | var r repositoriesManager = repositories.New(c, logger) 65 | r.Overlay() 66 | } 67 | ``` 68 | -------------------------------------------------------------------------------- /docs/versioned_docs/version-2.2.3/contributing.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 6 3 | --- 4 | 5 | # Contributing 6 | 7 | Contributions to Gilt are very welcome, but we ask that you read this document 8 | before submitting a PR. 9 | 10 | :::note 11 | 12 | This document applies to the [Gilt][] repository. 13 | 14 | ::: 15 | 16 | ## Before you start 17 | 18 | - **Check existing work** - Is there an existing PR? Are there issues discussing 19 | the feature/change you want to make? Please make sure you consider/address 20 | these discussions in your work. 21 | - **Backwards compatibility** - Will your change break existing Giltfiles? It is 22 | much more likely that your change will merged if it backwards compatible. Is 23 | there an approach you can take that maintains this compatibility? If not, 24 | consider opening an issue first so that API changes can be discussed before 25 | you invest your time into a PR. 26 | 27 | ## 1. Setup 28 | 29 | - **Go** - Gilt is written in [Go][]. We always support the latest two major Go 30 | versions, so make sure your version is recent enough. 31 | - **Node.js** - [Node.js][] is used to host Gilt's documentation server and is 32 | required if you want to run this server locally. 33 | 34 | ## 2. Making changes 35 | 36 | - **Code style** - Try to maintain the existing code style where possible. Go 37 | code should be formatted by [`gofumpt`][gofumpt] and linted using 38 | [`golangci-lint`][golangci-lint]. Any Markdown or TypeScript files should be 39 | formatted and linted by [Prettier][]. This style is enforced by our CI to 40 | ensure that we have a consistent style across the project. You can use the 41 | `task fmt:check` command to lint the code locally and the `task fmt` command 42 | to automatically fix any issues that are found. 43 | - **Documentation** - Ensure that you add/update any relevant documentation. See 44 | the [updating documentation](#updating-documentation) section below. 45 | - **Tests** - Ensure that you add/update any relevant tests and that all tests 46 | are passing before submitting the PR. See the [writing tests](#writing-tests) 47 | section below. 48 | 49 | ### Running your changes 50 | 51 | To run Gilt with working changes, you can use `go run main.go overlay`. 52 | 53 | ### Updating documentation 54 | 55 | Gilt uses [Docusaurus][] to host a documentation server. The code for this is 56 | located in the Gilt repository. This can be setup and run locally by using 57 | `task docs:start` (requires `nodejs` & `yarn`). All content is written in 58 | Markdown and is located in the `docs/docs` directory. All Markdown documents 59 | should have an 80 character line wrap limit (enforced by Prettier). 60 | 61 | ### Writing tests 62 | 63 | When making changes, consider whether new tests are required. These tests should 64 | ensure that the functionality you are adding will continue to work in the 65 | future. Existing tests may also need updating if you have changed Gilt's 66 | behavior. 67 | 68 | You may also consider adding unit tests for any new functions you have added. 69 | The unit tests should follow the Go convention of being location in a file named 70 | `*_test.go` in the same package as the code being tested. 71 | 72 | Integration tests are located in the `tests` directory and executed by [Bats][]. 73 | 74 | ## 3. Committing your code 75 | 76 | Try to write meaningful commit messages and avoid having too many commits on the 77 | PR. Most PRs should likely have a single commit (although for bigger PRs it may 78 | be reasonable to split it in a few). Git squash and rebase is your friend! 79 | 80 | If you're not sure how to format your commit message, check out [Conventional 81 | Commits][]. This style is enforced, and is a good way to make your commit 82 | messages more readable and consistent. 83 | 84 | ## 4. Submitting a PR 85 | 86 | - **Describe your changes** - Ensure that you provide a comprehensive 87 | description of your changes. 88 | - **Issue/PR links** - Link any previous work such as related issues or PRs. 89 | Please describe how your changes differ to/extend this work. 90 | - **Examples** - Add any examples or screenshots that you think are useful to 91 | demonstrate the effect of your changes. 92 | - **Draft PRs** - If your changes are incomplete, but you would like to discuss 93 | them, open the PR as a draft and add a comment to start a discussion. Using 94 | comments rather than the PR description allows the description to be updated 95 | later while preserving any discussions. 96 | 97 | ## FAQ 98 | 99 | > I want to contribute, where do I start? 100 | 101 | All kinds of contributions are welcome, whether its a typo fix or a shiny new 102 | feature. You can also contribute by upvoting/commenting on issues or helping to 103 | answer questions. 104 | 105 | > I'm stuck, where can I get help? 106 | 107 | If you have questions, feel free open a [Discussion][] on GitHub. 108 | 109 | 110 | [Gilt]: https://github.com/retr0h/gilt 111 | [Go]: https://go.dev 112 | [Node.js]: https://nodejs.org/en/ 113 | [gofumpt]: https://github.com/mvdan/gofumpt 114 | [golangci-lint]: https://golangci-lint.run 115 | [Prettier]: https://prettier.io/ 116 | [Docusaurus]: https://docusaurus.io 117 | [Discussion]: https://github.com/retr0h/gilt/discussions 118 | [Conventional Commits]: https://www.conventionalcommits.org 119 | [Bats]: https://github.com/bats-core/bats-core 120 | 121 | -------------------------------------------------------------------------------- /docs/versioned_docs/version-2.2.3/installation.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 2 3 | --- 4 | 5 | # Installation 6 | 7 | ## Homebrew Tap 8 | 9 | ```bash 10 | brew install retr0h/tap/gilt 11 | ``` 12 | 13 | ## Go Install 14 | 15 | ```bash 16 | go install github.com/retr0h/gilt/v2@latest 17 | ``` 18 | 19 | ## Python 20 | 21 | ```bash 22 | pip3 install python-gilt 23 | ``` 24 | -------------------------------------------------------------------------------- /docs/versioned_docs/version-2.2.3/intro.md: -------------------------------------------------------------------------------- 1 | --- 2 | slug: / 3 | sidebar_position: 1 4 | title: Home 5 | --- 6 | 7 | # Gilt 8 | 9 |
10 |
11 | Gilt is a tool which aims to make repo management, manageable. Gilt clones
12 | repositories at a particular version, then overlays the repository to the
13 | provided destination. An alternate approach to "vendoring".
14 |
15 | What makes Gilt interesting, is the ability to overlay particular files and/or
16 | directories from the specified repository to given destinations. Originally,
17 | this was quite helpful for those using Ansible, since libraries, plugins, and
18 | playbooks are often shared, but Ansible's [Galaxy][] has no mechanism to handle
19 | this. Currently, this is proving useful for overlaying [Helm charts][].
20 |
21 | 22 | 23 | ## Alternatives 24 | 25 | - [Repo][] 26 | - [Git submodules][] 27 | - [Git subtree][] 28 | 29 | ## History 30 | 31 | This project is a golang port of [Gilt][py-gilt], and aims to correct poor 32 | decisions made in the python version, primarially around config syntax, 33 | portability, and reproducibility. 34 | 35 | 36 | [Galaxy]: https://docs.ansible.com/ansible/latest/reference_appendices/galaxy.html 37 | [Helm charts]: https://helm.sh/docs/topics/charts/ 38 | [Repo]: https://gerrit.googlesource.com/git-repo/+/refs/heads/master/README.md 39 | [Git submodules]: https://git-scm.com/book/en/v2/Git-Tools-Submodules 40 | [Git subtree]: https://github.com/git/git/blob/master/contrib/subtree/git-subtree.txt 41 | [py-gilt]: http://gilt.readthedocs.io/en/latest/ 42 | 43 | -------------------------------------------------------------------------------- /docs/versioned_docs/version-2.2.3/testing.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 5 3 | --- 4 | 5 | # Testing 6 | 7 | Check installed dependencies: 8 | 9 | ```bash 10 | task deps:check 11 | ``` 12 | 13 | To execute tests: 14 | 15 | ```bash 16 | task test 17 | ``` 18 | 19 | Auto format code: 20 | 21 | ```bash 22 | task fmt 23 | ``` 24 | 25 | List helpful targets: 26 | 27 | ```bash 28 | task 29 | ``` 30 | -------------------------------------------------------------------------------- /docs/versioned_docs/version-2.2.3/usage.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 4 3 | --- 4 | 5 | # Usage 6 | 7 | ## CLI 8 | 9 | ### Init Configuration 10 | 11 | Initializes config file in the shell's current working directory: 12 | 13 | ```bash 14 | gilt init 15 | ``` 16 | 17 | ### Overlay Repository 18 | 19 | Overlay a remote repository into the destination provided. 20 | 21 | ```bash 22 | gilt overlay 23 | ``` 24 | 25 | ### Debug 26 | 27 | Display the git commands being executed. 28 | 29 | ```bash 30 | gilt --debug overlay 31 | ``` 32 | 33 | ### Skipping post-commands 34 | 35 | Overlay files only, but run no other commands. 36 | 37 | ```bash 38 | gilt overlay --no-commands 39 | ``` 40 | 41 | ## Package 42 | 43 | ### Overlay Repository 44 | 45 | See example client in `examples/go-client/`. 46 | 47 | ```go 48 | func main() { 49 | debug := true 50 | logger := getLogger(debug) 51 | 52 | c := config.Repositories{ 53 | Debug: debug, 54 | GiltDir: "~/.gilt", 55 | Repositories: []config.Repository{ 56 | { 57 | Git: "https://github.com/retr0h/ansible-etcd.git", 58 | Version: "77a95b7", 59 | DstDir: "../tmp/retr0h.ansible-etcd", 60 | }, 61 | }, 62 | } 63 | 64 | var r repositoriesManager = repositories.New(c, logger) 65 | r.Overlay() 66 | } 67 | ``` 68 | -------------------------------------------------------------------------------- /docs/versioned_docs/version-2.2/configuration.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 3 3 | --- 4 | 5 | # Configuration 6 | 7 | Gilt uses [Viper][] to load configuation through multiple methods. 8 | 9 | ## Config File 10 | 11 | Create the giltfile (`Giltfile.yaml`). 12 | 13 | Clone the specified `url`@`version` to the configurable path `--gilt-dir`. 14 | Extract the repo the `dstDir` when `dstDir` is provided. Otherwise, copy files 15 | and/or directories to the desired destinations. 16 | 17 | ```yaml 18 | --- 19 | giltDir: ~/.gilt/clone 20 | debug: false 21 | parallel: true 22 | repositories: 23 | - git: https://github.com/retr0h/ansible-etcd.git 24 | version: 77a95b7 25 | dstDir: roles/retr0h.ansible-etcd 26 | - git: https://github.com/retr0h/ansible-etcd.git 27 | version: 1.1 28 | dstDir: roles/retr0h.ansible-etcd-tag 29 | - git: https://github.com/lorin/openstack-ansible-modules.git 30 | version: 2677cc3 31 | sources: 32 | - src: '*_manage' 33 | dstDir: library 34 | - src: nova_quota 35 | dstDir: library 36 | - src: neutron_router 37 | dstFile: library/neutron_router.py 38 | - src: tests 39 | dstDir: tests 40 | commands: 41 | - cmd: ansible-playbook 42 | args: 43 | - -i, 44 | - playbook.yml 45 | - cmd: bash 46 | args: 47 | - -c 48 | - who | grep tty 49 | ``` 50 | 51 | ## Env Vars 52 | 53 | The config file can be overriden/defined through env vars. 54 | 55 | ```bash 56 | GILT_GILTFILE=Giltfile.yaml \ 57 | GILT_GILTDIR=~/.gilt/clone \ 58 | GILT_DEBUG=false \ 59 | GILT_PARALLEL=0 \ 60 | gilt overlay 61 | ``` 62 | 63 | ## Command Flags 64 | 65 | The config file and/or env vars can be overriden/defined through cli flags. 66 | 67 | ```bash 68 | gilt \ 69 | --gilt-file=Giltfile.yaml \ 70 | --gilt-dir=~/.gilt/clone \ 71 | --debug \ 72 | --parallel=false \ 73 | overlay 74 | ``` 75 | 76 | 77 | [Viper]: https://github.com/spf13/viper 78 | 79 | -------------------------------------------------------------------------------- /docs/versioned_docs/version-2.2/installation.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 2 3 | --- 4 | 5 | # Installation 6 | 7 | ## Homebrew Tap 8 | 9 | ```bash 10 | brew install retr0h/tap/gilt 11 | ``` 12 | 13 | ## Go Install 14 | 15 | ```bash 16 | go install github.com/retr0h/gilt/v2@latest 17 | ``` 18 | 19 | ## Python 20 | 21 | ```bash 22 | pip3 install python-gilt 23 | ``` 24 | -------------------------------------------------------------------------------- /docs/versioned_docs/version-2.2/intro.md: -------------------------------------------------------------------------------- 1 | --- 2 | slug: / 3 | sidebar_position: 1 4 | title: Home 5 | --- 6 | 7 | # Gilt 8 | 9 |
10 |
11 | Gilt is a tool which aims to make repo management, manageable. Gilt clones
12 | repositories at a particular version, then overlays the repository to the
13 | provided destination. An alternate approach to "vendoring".
14 |
15 | What makes Gilt interesting, is the ability to overlay particular files and/or
16 | directories from the specified repository to given destinations. Originally,
17 | this was quite helpful for those using Ansible, since libraries, plugins, and
18 | playbooks are often shared, but Ansible's [Galaxy][] has no mechanism to handle
19 | this. Currently, this is proving useful for overlaying [Helm charts][].
20 |
21 | 22 | 23 | ## Alternatives 24 | 25 | - [Repo][] 26 | - [Git submodules][] 27 | - [Git subtree][] 28 | 29 | ## History 30 | 31 | This project is a golang port of [Gilt][py-gilt], and aims to correct poor 32 | decisions made in the python version, primarially around config syntax, 33 | portability, and reproducibility. 34 | 35 | 36 | [Galaxy]: https://docs.ansible.com/ansible/latest/reference_appendices/galaxy.html 37 | [Helm charts]: https://helm.sh/docs/topics/charts/ 38 | [Repo]: https://gerrit.googlesource.com/git-repo/+/refs/heads/master/README.md 39 | [Git submodules]: https://git-scm.com/book/en/v2/Git-Tools-Submodules 40 | [Git subtree]: https://github.com/git/git/blob/master/contrib/subtree/git-subtree.txt 41 | [py-gilt]: http://gilt.readthedocs.io/en/latest/ 42 | 43 | -------------------------------------------------------------------------------- /docs/versioned_docs/version-2.2/testing.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 5 3 | --- 4 | 5 | # Testing 6 | 7 | Check installed dependencies: 8 | 9 | ```bash 10 | task deps:check 11 | ``` 12 | 13 | To execute tests: 14 | 15 | ```bash 16 | task test 17 | ``` 18 | 19 | Auto format code: 20 | 21 | ```bash 22 | task fmt 23 | ``` 24 | 25 | List helpful targets: 26 | 27 | ```bash 28 | task 29 | ``` 30 | -------------------------------------------------------------------------------- /docs/versioned_docs/version-2.2/usage.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 4 3 | --- 4 | 5 | # Usage 6 | 7 | ## CLI 8 | 9 | ### Init Configuration 10 | 11 | Initializes config file in the shell's current working directory: 12 | 13 | ```bash 14 | gilt init 15 | ``` 16 | 17 | ### Overlay Repository 18 | 19 | Overlay a remote repository into the destination provided. 20 | 21 | ```bash 22 | gilt overlay 23 | ``` 24 | 25 | ### Debug 26 | 27 | Display the git commands being executed. 28 | 29 | ```bash 30 | gilt --debug overlay 31 | ``` 32 | 33 | ## Package 34 | 35 | ### Overlay Repository 36 | 37 | See example client in `examples/go-client/`. 38 | 39 | ```go 40 | func main() { 41 | debug := true 42 | logger := getLogger(debug) 43 | 44 | c := config.Repositories{ 45 | Debug: debug, 46 | GiltDir: "~/.gilt", 47 | Repositories: []config.Repository{ 48 | { 49 | Git: "https://github.com/retr0h/ansible-etcd.git", 50 | Version: "77a95b7", 51 | DstDir: "../tmp/retr0h.ansible-etcd", 52 | }, 53 | }, 54 | } 55 | 56 | var r repositoriesManager = repositories.New(c, logger) 57 | r.Overlay() 58 | } 59 | ``` 60 | -------------------------------------------------------------------------------- /docs/versioned_docs/version-v2.2.4/installation.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 2 3 | --- 4 | 5 | # Installation 6 | 7 | ## Homebrew Tap 8 | 9 | ```bash 10 | brew install retr0h/tap/gilt 11 | ``` 12 | 13 | ## Go Install 14 | 15 | ```bash 16 | go install github.com/retr0h/gilt/v2@latest 17 | ``` 18 | 19 | ## Python 20 | 21 | ```bash 22 | pip3 install python-gilt 23 | ``` 24 | -------------------------------------------------------------------------------- /docs/versioned_docs/version-v2.2.4/intro.md: -------------------------------------------------------------------------------- 1 | --- 2 | slug: / 3 | sidebar_position: 1 4 | title: Home 5 | --- 6 | 7 | # Gilt 8 | 9 |
10 |
11 | Gilt is a tool which aims to make repo management, manageable. Gilt clones
12 | repositories at a particular version, then overlays the repository to the
13 | provided destination. An alternate approach to "vendoring".
14 |
15 | What makes Gilt interesting, is the ability to overlay particular files and/or
16 | directories from the specified repository to given destinations. Originally,
17 | this was quite helpful for those using Ansible, since libraries, plugins, and
18 | playbooks are often shared, but Ansible's [Galaxy][] has no mechanism to handle
19 | this. Currently, this is proving useful for overlaying [Helm charts][].
20 |
21 | 22 | 23 | ## Alternatives 24 | 25 | - [Repo][] 26 | - [Git submodules][] 27 | - [Git subtree][] 28 | 29 | ## History 30 | 31 | This project is a golang port of [Gilt][py-gilt], and aims to correct poor 32 | decisions made in the python version, primarially around config syntax, 33 | portability, and reproducibility. 34 | 35 | 36 | [Galaxy]: https://docs.ansible.com/ansible/latest/reference_appendices/galaxy.html 37 | [Helm charts]: https://helm.sh/docs/topics/charts/ 38 | [Repo]: https://gerrit.googlesource.com/git-repo/+/refs/heads/master/README.md 39 | [Git submodules]: https://git-scm.com/book/en/v2/Git-Tools-Submodules 40 | [Git subtree]: https://github.com/git/git/blob/master/contrib/subtree/git-subtree.txt 41 | [py-gilt]: http://gilt.readthedocs.io/en/latest/ 42 | 43 | -------------------------------------------------------------------------------- /docs/versioned_docs/version-v2.2.4/testing.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 5 3 | --- 4 | 5 | # Testing 6 | 7 | Check installed dependencies: 8 | 9 | ```bash 10 | task deps:check 11 | ``` 12 | 13 | To execute tests: 14 | 15 | ```bash 16 | task test 17 | ``` 18 | 19 | Auto format code: 20 | 21 | ```bash 22 | task fmt 23 | ``` 24 | 25 | List helpful targets: 26 | 27 | ```bash 28 | task 29 | ``` 30 | -------------------------------------------------------------------------------- /docs/versioned_docs/version-v2.2.4/usage.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 4 3 | --- 4 | 5 | # Usage 6 | 7 | ## CLI 8 | 9 | ### Init Configuration 10 | 11 | Initializes config file in the shell's current working directory: 12 | 13 | ```bash 14 | gilt init 15 | ``` 16 | 17 | ### Overlay Repository 18 | 19 | Overlay a remote repository into the destination provided. 20 | 21 | ```bash 22 | gilt overlay 23 | ``` 24 | 25 | ### Debug 26 | 27 | Display the git commands being executed. 28 | 29 | ```bash 30 | gilt --debug overlay 31 | ``` 32 | 33 | ### Skipping post-commands 34 | 35 | Overlay files only, but run no other commands. 36 | 37 | ```bash 38 | gilt overlay --no-commands 39 | ``` 40 | 41 | ## Package 42 | 43 | ### Overlay Repository 44 | 45 | See example client in `examples/go-client/`. 46 | 47 | ```go 48 | func main() { 49 | debug := true 50 | logger := getLogger(debug) 51 | 52 | c := config.Repositories{ 53 | Debug: debug, 54 | GiltDir: "~/.gilt", 55 | Repositories: []config.Repository{ 56 | { 57 | Git: "https://github.com/retr0h/ansible-etcd.git", 58 | Version: "77a95b7", 59 | DstDir: "../tmp/retr0h.ansible-etcd", 60 | }, 61 | }, 62 | } 63 | 64 | var r repositoriesManager = repositories.New(c, logger) 65 | r.Overlay() 66 | } 67 | ``` 68 | -------------------------------------------------------------------------------- /docs/versioned_sidebars/version-2.0.3-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "docsSidebar": [ 3 | { 4 | "type": "autogenerated", 5 | "dirName": "." 6 | } 7 | ] 8 | } 9 | -------------------------------------------------------------------------------- /docs/versioned_sidebars/version-2.1.1-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "docsSidebar": [ 3 | { 4 | "type": "autogenerated", 5 | "dirName": "." 6 | } 7 | ] 8 | } 9 | -------------------------------------------------------------------------------- /docs/versioned_sidebars/version-2.1.2-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "docsSidebar": [ 3 | { 4 | "type": "autogenerated", 5 | "dirName": "." 6 | } 7 | ] 8 | } 9 | -------------------------------------------------------------------------------- /docs/versioned_sidebars/version-2.2-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "docsSidebar": [ 3 | { 4 | "type": "autogenerated", 5 | "dirName": "." 6 | } 7 | ] 8 | } 9 | -------------------------------------------------------------------------------- /docs/versioned_sidebars/version-2.2.1-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "docsSidebar": [ 3 | { 4 | "type": "autogenerated", 5 | "dirName": "." 6 | } 7 | ] 8 | } 9 | -------------------------------------------------------------------------------- /docs/versioned_sidebars/version-2.2.2-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "docsSidebar": [ 3 | { 4 | "type": "autogenerated", 5 | "dirName": "." 6 | } 7 | ] 8 | } 9 | -------------------------------------------------------------------------------- /docs/versioned_sidebars/version-2.2.3-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "docsSidebar": [ 3 | { 4 | "type": "autogenerated", 5 | "dirName": "." 6 | } 7 | ] 8 | } 9 | -------------------------------------------------------------------------------- /docs/versioned_sidebars/version-v2.2.4-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "docsSidebar": [ 3 | { 4 | "type": "autogenerated", 5 | "dirName": "." 6 | } 7 | ] 8 | } 9 | -------------------------------------------------------------------------------- /docs/versions.json: -------------------------------------------------------------------------------- 1 | [ 2 | "v2.2.4", 3 | "2.2.3", 4 | "2.2.2", 5 | "2.2.1", 6 | "2.2", 7 | "2.1.2", 8 | "2.1.1", 9 | "2.0.3" 10 | ] 11 | -------------------------------------------------------------------------------- /examples/go-client/go.mod: -------------------------------------------------------------------------------- 1 | module example.com/client 2 | 3 | go 1.23 4 | 5 | toolchain go1.23.3 6 | 7 | replace github.com/retr0h/gilt/v2 => ../../../gilt/ 8 | 9 | require ( 10 | github.com/lmittmann/tint v1.0.5 11 | github.com/retr0h/gilt/v2 v2.2.0 12 | ) 13 | 14 | require ( 15 | github.com/avfs/avfs v0.34.0 // indirect 16 | github.com/danjacques/gofslock v0.0.0-20230728142113-ae8f59f9e88b // indirect 17 | github.com/gabriel-vasile/mimetype v1.4.3 // indirect 18 | github.com/go-playground/locales v0.14.1 // indirect 19 | github.com/go-playground/universal-translator v0.18.1 // indirect 20 | github.com/go-playground/validator/v10 v10.22.1 // indirect 21 | github.com/leodido/go-urn v1.4.0 // indirect 22 | golang.org/x/crypto v0.21.0 // indirect 23 | golang.org/x/net v0.23.0 // indirect 24 | golang.org/x/sys v0.26.0 // indirect 25 | golang.org/x/text v0.14.0 // indirect 26 | ) 27 | -------------------------------------------------------------------------------- /examples/go-client/go.sum: -------------------------------------------------------------------------------- 1 | github.com/avfs/avfs v0.34.0 h1:1smP9udOqkYM0PyTb44vZZwzrrMaNQOxNL18kZ7f5L4= 2 | github.com/avfs/avfs v0.34.0/go.mod h1:LnzrUO5acMU5NCkohHcUN15YrnkxiJ/lRLQOZSp39ow= 3 | github.com/danjacques/gofslock v0.0.0-20230728142113-ae8f59f9e88b h1:BBkZ6LZYtzMQ2Oo5LkovMmUp0gxAD+AnXzfknZlFTBo= 4 | github.com/danjacques/gofslock v0.0.0-20230728142113-ae8f59f9e88b/go.mod h1:9LABMmUSkKzt6FVQNEWdUTM0bz8Bt8MPyEcuZe0Sr8c= 5 | github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc h1:U9qPSI2PIWSS1VwoXQT9A3Wy9MM3WgvqSxFWenqJduM= 6 | github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= 7 | github.com/gabriel-vasile/mimetype v1.4.3 h1:in2uUcidCuFcDKtdcBxlR0rJ1+fsokWf+uqxgUFjbI0= 8 | github.com/gabriel-vasile/mimetype v1.4.3/go.mod h1:d8uq/6HKRL6CGdk+aubisF/M5GcPfT7nKyLpA0lbSSk= 9 | github.com/go-playground/assert/v2 v2.2.0 h1:JvknZsQTYeFEAhQwI4qEt9cyV5ONwRHC+lYKSsYSR8s= 10 | github.com/go-playground/assert/v2 v2.2.0/go.mod h1:VDjEfimB/XKnb+ZQfWdccd7VUvScMdVu0Titje2rxJ4= 11 | github.com/go-playground/locales v0.14.1 h1:EWaQ/wswjilfKLTECiXz7Rh+3BjFhfDFKv/oXslEjJA= 12 | github.com/go-playground/locales v0.14.1/go.mod h1:hxrqLVvrK65+Rwrd5Fc6F2O76J/NuW9t0sjnWqG1slY= 13 | github.com/go-playground/universal-translator v0.18.1 h1:Bcnm0ZwsGyWbCzImXv+pAJnYK9S473LQFuzCbDbfSFY= 14 | github.com/go-playground/universal-translator v0.18.1/go.mod h1:xekY+UJKNuX9WP91TpwSH2VMlDf28Uj24BCp08ZFTUY= 15 | github.com/go-playground/validator/v10 v10.22.1 h1:40JcKH+bBNGFczGuoBYgX4I6m/i27HYW8P9FDk5PbgA= 16 | github.com/go-playground/validator/v10 v10.22.1/go.mod h1:dbuPbCMFw/DrkbEynArYaCwl3amGuJotoKCe95atGMM= 17 | github.com/golang/mock v1.6.0 h1:ErTB+efbowRARo13NNdxyJji2egdxLGQhRaY+DUumQc= 18 | github.com/golang/mock v1.6.0/go.mod h1:p6yTPP+5HYm5mzsMV8JkE6ZKdX+/wYM6Hr+LicevLPs= 19 | github.com/leodido/go-urn v1.4.0 h1:WT9HwE9SGECu3lg4d/dIA+jxlljEa1/ffXKmRjqdmIQ= 20 | github.com/leodido/go-urn v1.4.0/go.mod h1:bvxc+MVxLKB4z00jd1z+Dvzr47oO32F/QSNjSBOlFxI= 21 | github.com/lmittmann/tint v1.0.5 h1:NQclAutOfYsqs2F1Lenue6OoWCajs5wJcP3DfWVpePw= 22 | github.com/lmittmann/tint v1.0.5/go.mod h1:HIS3gSy7qNwGCj+5oRjAutErFBl4BzdQP6cJZ0NfMwE= 23 | github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 h1:Jamvg5psRIccs7FGNTlIRMkT8wgtp5eCXdBlqhYGL6U= 24 | github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= 25 | github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg= 26 | github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= 27 | golang.org/x/crypto v0.21.0 h1:X31++rzVUdKhX5sWmSOFZxx8UW/ldWx55cbf08iNAMA= 28 | golang.org/x/crypto v0.21.0/go.mod h1:0BP7YvVV9gBbVKyeTG0Gyn+gZm94bibOW5BjDEYAOMs= 29 | golang.org/x/net v0.23.0 h1:7EYJ93RZ9vYSZAIb2x3lnuvqO5zneoD6IvWjuhfxjTs= 30 | golang.org/x/net v0.23.0/go.mod h1:JKghWKKOSdJwpW2GEx0Ja7fmaKnMsbu+MWVZTokSYmg= 31 | golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= 32 | golang.org/x/sys v0.26.0 h1:KHjCJyddX0LoSTb3J+vWpupP9p0oznkqVk/IfjymZbo= 33 | golang.org/x/sys v0.26.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= 34 | golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ= 35 | golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU= 36 | gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= 37 | gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= 38 | -------------------------------------------------------------------------------- /examples/go-client/main.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "log/slog" 5 | "os" 6 | "time" 7 | 8 | "github.com/lmittmann/tint" 9 | 10 | "github.com/retr0h/gilt/v2/pkg/config" 11 | "github.com/retr0h/gilt/v2/pkg/repositories" 12 | ) 13 | 14 | type repositoriesManager interface { 15 | Overlay() error 16 | } 17 | 18 | func getLogger(debug bool) *slog.Logger { 19 | logLevel := slog.LevelInfo 20 | if debug { 21 | logLevel = slog.LevelDebug 22 | } 23 | 24 | logger := slog.New( 25 | tint.NewHandler(os.Stderr, &tint.Options{ 26 | Level: logLevel, 27 | TimeFormat: time.Kitchen, 28 | }), 29 | ) 30 | 31 | return logger 32 | } 33 | 34 | func main() { 35 | debug := true 36 | logger := getLogger(debug) 37 | 38 | c := config.Repositories{ 39 | Debug: debug, 40 | GiltDir: "~/.gilt", 41 | Repositories: []config.Repository{ 42 | { 43 | Git: "https://github.com/retr0h/ansible-etcd.git", 44 | Version: "77a95b7", 45 | DstDir: "../../test/integration/tmp/retr0h.ansible-etcd", 46 | }, 47 | }, 48 | } 49 | 50 | var r repositoriesManager = repositories.New(c, logger) 51 | r.Overlay() 52 | } 53 | -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/retr0h/gilt/v2 2 | 3 | go 1.23.0 4 | 5 | toolchain go1.23.8 6 | 7 | require ( 8 | github.com/avfs/avfs v0.35.0 9 | github.com/caarlos0/go-version v0.2.0 10 | github.com/danjacques/gofslock v0.0.0-20230728142113-ae8f59f9e88b 11 | github.com/go-playground/validator/v10 v10.26.0 12 | github.com/golang/mock v1.6.0 13 | github.com/lmittmann/tint v1.1.1 14 | github.com/spf13/cobra v1.9.1 15 | github.com/spf13/viper v1.20.1 16 | github.com/stretchr/testify v1.10.0 17 | golang.org/x/term v0.32.0 18 | gopkg.in/yaml.v3 v3.0.1 19 | ) 20 | 21 | require ( 22 | github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect 23 | github.com/fsnotify/fsnotify v1.8.0 // indirect 24 | github.com/gabriel-vasile/mimetype v1.4.8 // indirect 25 | github.com/go-playground/locales v0.14.1 // indirect 26 | github.com/go-playground/universal-translator v0.18.1 // indirect 27 | github.com/go-viper/mapstructure/v2 v2.2.1 // indirect 28 | github.com/inconshreveable/mousetrap v1.1.0 // indirect 29 | github.com/leodido/go-urn v1.4.0 // indirect 30 | github.com/pelletier/go-toml/v2 v2.2.3 // indirect 31 | github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect 32 | github.com/sagikazarmark/locafero v0.7.0 // indirect 33 | github.com/sourcegraph/conc v0.3.0 // indirect 34 | github.com/spf13/afero v1.12.0 // indirect 35 | github.com/spf13/cast v1.7.1 // indirect 36 | github.com/spf13/pflag v1.0.6 // indirect 37 | github.com/subosito/gotenv v1.6.0 // indirect 38 | go.uber.org/atomic v1.9.0 // indirect 39 | go.uber.org/multierr v1.9.0 // indirect 40 | golang.org/x/crypto v0.33.0 // indirect 41 | golang.org/x/net v0.34.0 // indirect 42 | golang.org/x/sys v0.33.0 // indirect 43 | golang.org/x/text v0.22.0 // indirect 44 | gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c // indirect 45 | ) 46 | -------------------------------------------------------------------------------- /internal/exec.go: -------------------------------------------------------------------------------- 1 | // Copyright (c) 2023 John Dewey 2 | 3 | // Permission is hereby granted, free of charge, to any person obtaining a copy 4 | // of this software and associated documentation files (the "Software"), to 5 | // deal in the Software without restriction, including without limitation the 6 | // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or 7 | // sell copies of the Software, and to permit persons to whom the Software is 8 | // furnished to do so, subject to the following conditions: 9 | 10 | // The above copyright notice and this permission notice shall be included in 11 | // all copies or substantial portions of the Software. 12 | 13 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 15 | // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 16 | // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 17 | // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 18 | // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 19 | // DEALINGS IN THE SOFTWARE. 20 | 21 | package internal 22 | 23 | // ExecManager manager responsible for exec operations. 24 | type ExecManager interface { 25 | RunCmd(name string, args []string) (string, error) 26 | RunCmdInDir(name string, args []string, cwd string) (string, error) 27 | RunInTempDir(dir, pattern string, fn func(string) error) error 28 | } 29 | -------------------------------------------------------------------------------- /internal/exec/exec.go: -------------------------------------------------------------------------------- 1 | // Copyright (c) 2023 John Dewey 2 | 3 | // Permission is hereby granted, free of charge, to any person obtaining a copy 4 | // of this software and associated documentation files (the "Software"), to 5 | // deal in the Software without restriction, including without limitation the 6 | // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or 7 | // sell copies of the Software, and to permit persons to whom the Software is 8 | // furnished to do so, subject to the following conditions: 9 | 10 | // The above copyright notice and this permission notice shall be included in 11 | // all copies or substantial portions of the Software. 12 | 13 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 15 | // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 16 | // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 17 | // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 18 | // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 19 | // DEALINGS IN THE SOFTWARE. 20 | 21 | package exec 22 | 23 | import ( 24 | "log/slog" 25 | "os/exec" 26 | "strings" 27 | 28 | "github.com/avfs/avfs" 29 | ) 30 | 31 | // New factory to create a new Exec instance. 32 | func New( 33 | appFs avfs.VFS, 34 | logger *slog.Logger, 35 | ) *Exec { 36 | return &Exec{ 37 | appFs: appFs, 38 | logger: logger, 39 | } 40 | } 41 | 42 | func (e *Exec) RunCmdImpl( 43 | name string, 44 | args []string, 45 | cwd string, 46 | ) (string, error) { 47 | cmd := exec.Command(name, args...) 48 | if cwd != "" { 49 | cmd.Dir = cwd 50 | } 51 | out, err := cmd.CombinedOutput() 52 | e.logger.Debug( 53 | "exec", 54 | slog.String("command", strings.Join(cmd.Args, " ")), 55 | slog.String("cwd", cwd), 56 | slog.String("output", string(out)), 57 | slog.Any("error", err), 58 | ) 59 | if err != nil { 60 | return string(out), err 61 | } 62 | 63 | return string(out), nil 64 | } 65 | 66 | // RunCmd execute the provided command with args. 67 | // Yeah, yeah, yeah, I know I cheated by using Exec in this package. 68 | func (e *Exec) RunCmd( 69 | name string, 70 | args []string, 71 | ) (string, error) { 72 | return e.RunCmdImpl(name, args, "") 73 | } 74 | 75 | func (e *Exec) RunCmdInDir( 76 | name string, 77 | args []string, 78 | cwd string, 79 | ) (string, error) { 80 | return e.RunCmdImpl(name, args, cwd) 81 | } 82 | 83 | // RunInTempDir creates a temporary directory, and runs the provided function 84 | // with the name of the directory as input. Then it cleans up the temporary 85 | // directory. 86 | func (e *Exec) RunInTempDir(dir, pattern string, fn func(string) error) error { 87 | tmpDir, err := e.appFs.MkdirTemp(dir, pattern) 88 | if err != nil { 89 | return err 90 | } 91 | e.logger.Debug("created tempdir", slog.String("dir", tmpDir)) 92 | 93 | // Ignoring errors as there's not much we can do and this is a cleanup function. 94 | defer func() { 95 | e.logger.Debug("removing tempdir", slog.String("dir", tmpDir)) 96 | _ = e.appFs.RemoveAll(tmpDir) 97 | }() 98 | 99 | // Run the provided function. 100 | return fn(tmpDir) 101 | } 102 | -------------------------------------------------------------------------------- /internal/exec/exec_public_test.go: -------------------------------------------------------------------------------- 1 | // Copyright (c) 2023 John Dewey 2 | 3 | // Permission is hereby granted, free of charge, to any person obtaining a copy 4 | // of this software and associated documentation files (the "Software"), to 5 | // deal in the Software without restriction, including without limitation the 6 | // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or 7 | // sell copies of the Software, and to permit persons to whom the Software is 8 | // furnished to do so, subject to the following conditions: 9 | 10 | // The above copyright notice and this permission notice shall be included in 11 | // all copies or substantial portions of the Software. 12 | 13 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 15 | // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 16 | // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 17 | // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 18 | // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 19 | // DEALINGS IN THE SOFTWARE. 20 | 21 | package exec_test 22 | 23 | import ( 24 | "log/slog" 25 | "os" 26 | "testing" 27 | 28 | "github.com/avfs/avfs/vfs/memfs" 29 | "github.com/stretchr/testify/assert" 30 | "github.com/stretchr/testify/suite" 31 | 32 | "github.com/retr0h/gilt/v2/internal" 33 | "github.com/retr0h/gilt/v2/internal/exec" 34 | ) 35 | 36 | type ExecManagerPublicTestSuite struct { 37 | suite.Suite 38 | } 39 | 40 | func (suite *ExecManagerPublicTestSuite) NewTestExecManager() internal.ExecManager { 41 | return exec.New( 42 | memfs.New(), 43 | slog.New(slog.NewTextHandler(os.Stdout, &slog.HandlerOptions{ 44 | Level: slog.LevelDebug, 45 | })), 46 | ) 47 | } 48 | 49 | func (suite *ExecManagerPublicTestSuite) TestRunCmdOk() { 50 | em := suite.NewTestExecManager() 51 | 52 | _, err := em.RunCmd("ls", []string{}) 53 | assert.NoError(suite.T(), err) 54 | } 55 | 56 | func (suite *ExecManagerPublicTestSuite) TestRunCmdWithDebug() { 57 | suite.T().Skip("cannot seem to capture Stdout when logging in em") 58 | 59 | em := suite.NewTestExecManager() 60 | 61 | _, err := em.RunCmd("echo", []string{"-n", "foo"}) 62 | assert.NoError(suite.T(), err) 63 | } 64 | 65 | func (suite *ExecManagerPublicTestSuite) TestRunCmdReturnsError() { 66 | em := suite.NewTestExecManager() 67 | 68 | _, err := em.RunCmd("invalid", []string{"foo"}) 69 | assert.Error(suite.T(), err) 70 | assert.Contains(suite.T(), err.Error(), "not found") 71 | } 72 | 73 | func (suite *ExecManagerPublicTestSuite) TestRunCmdInDirOk() { 74 | em := suite.NewTestExecManager() 75 | 76 | _, err := em.RunCmdInDir("ls", []string{}, "/tmp") 77 | assert.NoError(suite.T(), err) 78 | } 79 | 80 | func (suite *ExecManagerPublicTestSuite) TestRunCmdInDirWithDebug() { 81 | suite.T().Skip("cannot seem to capture Stdout when logging in em") 82 | 83 | em := suite.NewTestExecManager() 84 | 85 | _, err := em.RunCmdInDir("echo", []string{"-n", "foo"}, "/tmp") 86 | assert.NoError(suite.T(), err) 87 | } 88 | 89 | func (suite *ExecManagerPublicTestSuite) TestRunCmdInDirReturnsError() { 90 | em := suite.NewTestExecManager() 91 | 92 | _, err := em.RunCmdInDir("invalid", []string{"foo"}, "/tmp") 93 | assert.Error(suite.T(), err) 94 | assert.Contains(suite.T(), err.Error(), "not found") 95 | } 96 | 97 | func (suite *ExecManagerPublicTestSuite) TestRunInTempDirOk() { 98 | em := suite.NewTestExecManager() 99 | 100 | dir := "" 101 | pattern := "test" 102 | fn := func(string) error { return nil } 103 | 104 | err := em.RunInTempDir(dir, pattern, fn) 105 | assert.NoError(suite.T(), err) 106 | } 107 | 108 | func (suite *ExecManagerPublicTestSuite) TestRunInTempDirError() { 109 | em := suite.NewTestExecManager() 110 | 111 | dir := "\x00" // Null character is invalid in a filepath 112 | pattern := "test" 113 | fn := func(string) error { return nil } 114 | 115 | err := em.RunInTempDir(dir, pattern, fn) 116 | assert.Error(suite.T(), err) 117 | } 118 | 119 | // In order for `go test` to run this suite, we need to create 120 | // a normal test function and pass our suite to suite.Run. 121 | func TestExecPublicTestSuite(t *testing.T) { 122 | suite.Run(t, new(ExecManagerPublicTestSuite)) 123 | } 124 | -------------------------------------------------------------------------------- /internal/exec/types.go: -------------------------------------------------------------------------------- 1 | // Copyright (c) 2023 John Dewey 2 | 3 | // Permission is hereby granted, free of charge, to any person obtaining a copy 4 | // of this software and associated documentation files (the "Software"), to 5 | // deal in the Software without restriction, including without limitation the 6 | // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or 7 | // sell copies of the Software, and to permit persons to whom the Software is 8 | // furnished to do so, subject to the following conditions: 9 | 10 | // The above copyright notice and this permission notice shall be included in 11 | // all copies or substantial portions of the Software. 12 | 13 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 15 | // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 16 | // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 17 | // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 18 | // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 19 | // DEALINGS IN THE SOFTWARE. 20 | 21 | package exec 22 | 23 | import ( 24 | "log/slog" 25 | 26 | "github.com/avfs/avfs" 27 | ) 28 | 29 | // Exec disk implementation. 30 | type Exec struct { 31 | appFs avfs.VFS 32 | logger *slog.Logger 33 | } 34 | -------------------------------------------------------------------------------- /internal/git.go: -------------------------------------------------------------------------------- 1 | // Copyright (c) 2023 John Dewey 2 | 3 | // Permission is hereby granted, free of charge, to any person obtaining a copy 4 | // of this software and associated documentation files (the "Software"), to 5 | // deal in the Software without restriction, including without limitation the 6 | // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or 7 | // sell copies of the Software, and to permit persons to whom the Software is 8 | // furnished to do so, subject to the following conditions: 9 | 10 | // The above copyright notice and this permission notice shall be included in 11 | // all copies or substantial portions of the Software. 12 | 13 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 15 | // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 16 | // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 17 | // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 18 | // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 19 | // DEALINGS IN THE SOFTWARE. 20 | 21 | package internal 22 | 23 | // GitManager manager responsible for Git operations. 24 | type GitManager interface { 25 | Clone(gitURL, origin, cloneDir string) error 26 | Worktree(cloneDir, version, dstDir string) error 27 | Update(origin, cloneDir string) error 28 | Remote(cloneDir string) (string, error) 29 | } 30 | -------------------------------------------------------------------------------- /internal/git/git.go: -------------------------------------------------------------------------------- 1 | // Copyright (c) 2018 John Dewey 2 | 3 | // Permission is hereby granted, free of charge, to any person obtaining a copy 4 | // of this software and associated documentation files (the "Software"), to 5 | // deal in the Software without restriction, including without limitation the 6 | // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or 7 | // sell copies of the Software, and to permit persons to whom the Software is 8 | // furnished to do so, subject to the following conditions: 9 | 10 | // The above copyright notice and this permission notice shall be included in 11 | // all copies or substantial portions of the Software. 12 | 13 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 15 | // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 16 | // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 17 | // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 18 | // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 19 | // DEALINGS IN THE SOFTWARE. 20 | 21 | // Package git package needs reworked into proper Git libraries. However, this 22 | // package will remain using exec as it was easiest to port from gilt's 23 | // python counterpart. 24 | package git 25 | 26 | import ( 27 | "log/slog" 28 | 29 | "github.com/avfs/avfs" 30 | 31 | "github.com/retr0h/gilt/v2/internal" 32 | ) 33 | 34 | // New factory to create a new Git instance. 35 | func New( 36 | appFs avfs.VFS, 37 | execManager internal.ExecManager, 38 | logger *slog.Logger, 39 | ) *Git { 40 | return &Git{ 41 | appFs: appFs, 42 | execManager: execManager, 43 | logger: logger, 44 | } 45 | } 46 | 47 | // Clone the repo. This is a bare repo, with only metadata to start with. 48 | func (g *Git) Clone(gitURL, origin, cloneDir string) error { 49 | _, err := g.execManager.RunCmd( 50 | "git", 51 | []string{ 52 | "-c", "clone.defaultRemoteName=" + origin, 53 | "clone", "--bare", "--filter=blob:none", gitURL, cloneDir, 54 | }, 55 | ) 56 | // NOTE(nic): Workaround truly ancient versions of git that do not support 57 | // `clone.defaultRemoteName`, and explicitly rename the remote to "our" value. 58 | // The `git remote rename` command will report a fatal error here, but will 59 | // actually still rename the remote. On newer versions, the remote name will 60 | // already be set by `git clone`, and the command will fail. So either way, 61 | // we want to throw out the result. 62 | if err == nil { 63 | _, _ = g.execManager.RunCmdInDir( 64 | "git", 65 | []string{"remote", "rename", "origin", origin}, 66 | cloneDir, 67 | ) 68 | } 69 | return err 70 | } 71 | 72 | // Update the repo. Fetch the current HEAD and any new tags that may have 73 | // appeared, and update the cache. 74 | func (g *Git) Update(origin, cloneDir string) error { 75 | _, err := g.execManager.RunCmdInDir( 76 | "git", 77 | []string{"fetch", "--tags", "--force", origin, "+refs/heads/*:refs/heads/*"}, 78 | cloneDir, 79 | ) 80 | return err 81 | } 82 | 83 | // Worktree create a working tree from the repo in `cloneDir` at `version` in `dstDir`. 84 | // Under the covers, this will download any/all required objects from origin 85 | // into the cache 86 | func (g *Git) Worktree( 87 | cloneDir string, 88 | version string, 89 | dstDir string, 90 | ) error { 91 | dst, err := g.appFs.Abs(dstDir) 92 | if err != nil { 93 | return err 94 | } 95 | 96 | g.logger.Info( 97 | "extracting", 98 | slog.String("from", cloneDir), 99 | slog.String("version", version), 100 | slog.String("to", dst), 101 | ) 102 | 103 | _, err = g.execManager.RunCmdInDir( 104 | "git", 105 | []string{"worktree", "add", "--force", dst, version}, 106 | cloneDir, 107 | ) 108 | // `git worktree add` creates a breadcrumb file back to the original repo; 109 | // this is just junk data in our use case, so get rid of it 110 | if err == nil { 111 | _ = g.appFs.Remove(g.appFs.Join(dst, ".git")) 112 | _, _ = g.execManager.RunCmdInDir( 113 | "git", 114 | []string{"worktree", "prune", "--verbose"}, 115 | cloneDir, 116 | ) 117 | } 118 | return err 119 | } 120 | 121 | // Return the name of the repo remote. 122 | func (g *Git) Remote(cloneDir string) (string, error) { 123 | return g.execManager.RunCmdInDir("git", []string{"remote"}, cloneDir) 124 | } 125 | -------------------------------------------------------------------------------- /internal/git/types.go: -------------------------------------------------------------------------------- 1 | // Copyright (c) 2023 John Dewey 2 | 3 | // Permission is hereby granted, free of charge, to any person obtaining a copy 4 | // of this software and associated documentation files (the "Software"), to 5 | // deal in the Software without restriction, including without limitation the 6 | // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or 7 | // sell copies of the Software, and to permit persons to whom the Software is 8 | // furnished to do so, subject to the following conditions: 9 | 10 | // The above copyright notice and this permission notice shall be included in 11 | // all copies or substantial portions of the Software. 12 | 13 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 15 | // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 16 | // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 17 | // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 18 | // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 19 | // DEALINGS IN THE SOFTWARE. 20 | 21 | package git 22 | 23 | import ( 24 | "log/slog" 25 | 26 | "github.com/avfs/avfs" 27 | 28 | "github.com/retr0h/gilt/v2/internal" 29 | ) 30 | 31 | // Git implementation responsible for Git operations. 32 | type Git struct { 33 | appFs avfs.VFS 34 | execManager internal.ExecManager 35 | logger *slog.Logger 36 | } 37 | -------------------------------------------------------------------------------- /internal/mocks/exec.go: -------------------------------------------------------------------------------- 1 | // Copyright (c) 2023 John Dewey 2 | 3 | // Permission is hereby granted, free of charge, to any person obtaining a copy 4 | // of this software and associated documentation files (the "Software"), to 5 | // deal in the Software without restriction, including without limitation the 6 | // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or 7 | // sell copies of the Software, and to permit persons to whom the Software is 8 | // furnished to do so, subject to the following conditions: 9 | 10 | // The above copyright notice and this permission notice shall be included in 11 | // all copies or substantial portions of the Software. 12 | 13 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 15 | // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 16 | // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 17 | // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 18 | // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 19 | // DEALINGS IN THE SOFTWARE. 20 | 21 | package mocks 22 | 23 | // ExecManager manager responsible for exec operations. 24 | type ExecManager interface { 25 | RunCmd(name string, args []string) error 26 | RunCmdInDir(name string, args []string, cwd string) error 27 | RunInTempDir(dir, pattern string, fn func(string) error) error 28 | } 29 | -------------------------------------------------------------------------------- /internal/mocks/exec/exec_mock.go: -------------------------------------------------------------------------------- 1 | // Code generated by MockGen. DO NOT EDIT. 2 | // Source: internal/exec.go 3 | 4 | // Package exec is a generated GoMock package. 5 | package exec 6 | 7 | import ( 8 | reflect "reflect" 9 | 10 | gomock "github.com/golang/mock/gomock" 11 | ) 12 | 13 | // MockExecManager is a mock of ExecManager interface. 14 | type MockExecManager struct { 15 | ctrl *gomock.Controller 16 | recorder *MockExecManagerMockRecorder 17 | } 18 | 19 | // MockExecManagerMockRecorder is the mock recorder for MockExecManager. 20 | type MockExecManagerMockRecorder struct { 21 | mock *MockExecManager 22 | } 23 | 24 | // NewMockExecManager creates a new mock instance. 25 | func NewMockExecManager(ctrl *gomock.Controller) *MockExecManager { 26 | mock := &MockExecManager{ctrl: ctrl} 27 | mock.recorder = &MockExecManagerMockRecorder{mock} 28 | return mock 29 | } 30 | 31 | // EXPECT returns an object that allows the caller to indicate expected use. 32 | func (m *MockExecManager) EXPECT() *MockExecManagerMockRecorder { 33 | return m.recorder 34 | } 35 | 36 | // RunCmd mocks base method. 37 | func (m *MockExecManager) RunCmd(name string, args []string) (string, error) { 38 | m.ctrl.T.Helper() 39 | ret := m.ctrl.Call(m, "RunCmd", name, args) 40 | ret0, _ := ret[0].(string) 41 | ret1, _ := ret[1].(error) 42 | return ret0, ret1 43 | } 44 | 45 | // RunCmd indicates an expected call of RunCmd. 46 | func (mr *MockExecManagerMockRecorder) RunCmd(name, args interface{}) *gomock.Call { 47 | mr.mock.ctrl.T.Helper() 48 | return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "RunCmd", reflect.TypeOf((*MockExecManager)(nil).RunCmd), name, args) 49 | } 50 | 51 | // RunCmdInDir mocks base method. 52 | func (m *MockExecManager) RunCmdInDir(name string, args []string, cwd string) (string, error) { 53 | m.ctrl.T.Helper() 54 | ret := m.ctrl.Call(m, "RunCmdInDir", name, args, cwd) 55 | ret0, _ := ret[0].(string) 56 | ret1, _ := ret[1].(error) 57 | return ret0, ret1 58 | } 59 | 60 | // RunCmdInDir indicates an expected call of RunCmdInDir. 61 | func (mr *MockExecManagerMockRecorder) RunCmdInDir(name, args, cwd interface{}) *gomock.Call { 62 | mr.mock.ctrl.T.Helper() 63 | return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "RunCmdInDir", reflect.TypeOf((*MockExecManager)(nil).RunCmdInDir), name, args, cwd) 64 | } 65 | 66 | // RunInTempDir mocks base method. 67 | // NOTE(nic): mockgen creates this mock wrong, and I'm not sure what to do 68 | // about it. If you've run `task mockgen`, and it removed this code, and now 69 | // your tests are failing, put this code back. 70 | func (m *MockExecManager) RunInTempDir(dir, pattern string, fn func(string) error) error { 71 | m.ctrl.T.Helper() 72 | ret := m.ctrl.Call(m, "RunInTempDir", dir, pattern, fn) 73 | // BEGIN extra code that mockgen can't be bothered to generate 74 | if fn != nil { 75 | return fn("stub") 76 | } 77 | // END extra code that mockgen can't be bothered to generate 78 | ret0, _ := ret[0].(error) 79 | return ret0 80 | } 81 | 82 | // RunInTempDir indicates an expected call of RunInTempDir. 83 | func (mr *MockExecManagerMockRecorder) RunInTempDir(dir, pattern, fn interface{}) *gomock.Call { 84 | mr.mock.ctrl.T.Helper() 85 | return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "RunInTempDir", reflect.TypeOf((*MockExecManager)(nil).RunInTempDir), dir, pattern, fn) 86 | } 87 | -------------------------------------------------------------------------------- /internal/mocks/git.go: -------------------------------------------------------------------------------- 1 | // Copyright (c) 2023 John Dewey 2 | 3 | // Permission is hereby granted, free of charge, to any person obtaining a copy 4 | // of this software and associated documentation files (the "Software"), to 5 | // deal in the Software without restriction, including without limitation the 6 | // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or 7 | // sell copies of the Software, and to permit persons to whom the Software is 8 | // furnished to do so, subject to the following conditions: 9 | 10 | // The above copyright notice and this permission notice shall be included in 11 | // all copies or substantial portions of the Software. 12 | 13 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 15 | // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 16 | // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 17 | // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 18 | // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 19 | // DEALINGS IN THE SOFTWARE. 20 | 21 | package mocks 22 | 23 | // GitManager manager responsible for Git operations. 24 | type GitManager interface { 25 | Clone(gitURL, origin, cloneDir string) error 26 | Worktree(cloneDir, version, dstDir string) error 27 | Update(origin, cloneDir string) error 28 | Remote(cloneDir string) (string, error) 29 | } 30 | -------------------------------------------------------------------------------- /internal/mocks/git/git_mock.go: -------------------------------------------------------------------------------- 1 | // Code generated by MockGen. DO NOT EDIT. 2 | // Source: internal/git.go 3 | 4 | // Package git is a generated GoMock package. 5 | package git 6 | 7 | import ( 8 | reflect "reflect" 9 | 10 | gomock "github.com/golang/mock/gomock" 11 | ) 12 | 13 | // MockGitManager is a mock of GitManager interface. 14 | type MockGitManager struct { 15 | ctrl *gomock.Controller 16 | recorder *MockGitManagerMockRecorder 17 | } 18 | 19 | // MockGitManagerMockRecorder is the mock recorder for MockGitManager. 20 | type MockGitManagerMockRecorder struct { 21 | mock *MockGitManager 22 | } 23 | 24 | // NewMockGitManager creates a new mock instance. 25 | func NewMockGitManager(ctrl *gomock.Controller) *MockGitManager { 26 | mock := &MockGitManager{ctrl: ctrl} 27 | mock.recorder = &MockGitManagerMockRecorder{mock} 28 | return mock 29 | } 30 | 31 | // EXPECT returns an object that allows the caller to indicate expected use. 32 | func (m *MockGitManager) EXPECT() *MockGitManagerMockRecorder { 33 | return m.recorder 34 | } 35 | 36 | // Clone mocks base method. 37 | func (m *MockGitManager) Clone(gitURL, origin, cloneDir string) error { 38 | m.ctrl.T.Helper() 39 | ret := m.ctrl.Call(m, "Clone", gitURL, origin, cloneDir) 40 | ret0, _ := ret[0].(error) 41 | return ret0 42 | } 43 | 44 | // Clone indicates an expected call of Clone. 45 | func (mr *MockGitManagerMockRecorder) Clone(gitURL, origin, cloneDir interface{}) *gomock.Call { 46 | mr.mock.ctrl.T.Helper() 47 | return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Clone", reflect.TypeOf((*MockGitManager)(nil).Clone), gitURL, origin, cloneDir) 48 | } 49 | 50 | // Remote mocks base method. 51 | func (m *MockGitManager) Remote(cloneDir string) (string, error) { 52 | m.ctrl.T.Helper() 53 | ret := m.ctrl.Call(m, "Remote", cloneDir) 54 | ret0, _ := ret[0].(string) 55 | ret1, _ := ret[1].(error) 56 | return ret0, ret1 57 | } 58 | 59 | // Remote indicates an expected call of Remote. 60 | func (mr *MockGitManagerMockRecorder) Remote(cloneDir interface{}) *gomock.Call { 61 | mr.mock.ctrl.T.Helper() 62 | return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Remote", reflect.TypeOf((*MockGitManager)(nil).Remote), cloneDir) 63 | } 64 | 65 | // Update mocks base method. 66 | func (m *MockGitManager) Update(origin, cloneDir string) error { 67 | m.ctrl.T.Helper() 68 | ret := m.ctrl.Call(m, "Update", origin, cloneDir) 69 | ret0, _ := ret[0].(error) 70 | return ret0 71 | } 72 | 73 | // Update indicates an expected call of Update. 74 | func (mr *MockGitManagerMockRecorder) Update(origin, cloneDir interface{}) *gomock.Call { 75 | mr.mock.ctrl.T.Helper() 76 | return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Update", reflect.TypeOf((*MockGitManager)(nil).Update), origin, cloneDir) 77 | } 78 | 79 | // Worktree mocks base method. 80 | func (m *MockGitManager) Worktree(cloneDir, version, dstDir string) error { 81 | m.ctrl.T.Helper() 82 | ret := m.ctrl.Call(m, "Worktree", cloneDir, version, dstDir) 83 | ret0, _ := ret[0].(error) 84 | return ret0 85 | } 86 | 87 | // Worktree indicates an expected call of Worktree. 88 | func (mr *MockGitManagerMockRecorder) Worktree(cloneDir, version, dstDir interface{}) *gomock.Call { 89 | mr.mock.ctrl.T.Helper() 90 | return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Worktree", reflect.TypeOf((*MockGitManager)(nil).Worktree), cloneDir, version, dstDir) 91 | } 92 | -------------------------------------------------------------------------------- /internal/mocks/repository.go: -------------------------------------------------------------------------------- 1 | // Copyright (c) 2023 John Dewey 2 | 3 | // Permission is hereby granted, free of charge, to any person obtaining a copy 4 | // of this software and associated documentation files (the "Software"), to 5 | // deal in the Software without restriction, including without limitation the 6 | // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or 7 | // sell copies of the Software, and to permit persons to whom the Software is 8 | // furnished to do so, subject to the following conditions: 9 | 10 | // The above copyright notice and this permission notice shall be included in 11 | // all copies or substantial portions of the Software. 12 | 13 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 15 | // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 16 | // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 17 | // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 18 | // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 19 | // DEALINGS IN THE SOFTWARE. 20 | 21 | package mocks 22 | 23 | import ( 24 | "github.com/retr0h/gilt/v2/pkg/config" 25 | ) 26 | 27 | // RepositoryManager manager responsible for Repository operations. 28 | type RepositoryManager interface { 29 | Clone(config config.Repository, cloneDir string) (string, error) 30 | Worktree(config config.Repository, cloneDir string, targetDir string) error 31 | CopySources(config config.Repository, cloneDir string) error 32 | } 33 | -------------------------------------------------------------------------------- /internal/mocks/repository/copy_mock.go: -------------------------------------------------------------------------------- 1 | // Code generated by MockGen. DO NOT EDIT. 2 | // Source: internal/repository/types.go 3 | 4 | // Package repository is a generated GoMock package. 5 | package repository 6 | 7 | import ( 8 | reflect "reflect" 9 | 10 | gomock "github.com/golang/mock/gomock" 11 | ) 12 | 13 | // MockCopyManager is a mock of CopyManager interface. 14 | type MockCopyManager struct { 15 | ctrl *gomock.Controller 16 | recorder *MockCopyManagerMockRecorder 17 | } 18 | 19 | // MockCopyManagerMockRecorder is the mock recorder for MockCopyManager. 20 | type MockCopyManagerMockRecorder struct { 21 | mock *MockCopyManager 22 | } 23 | 24 | // NewMockCopyManager creates a new mock instance. 25 | func NewMockCopyManager(ctrl *gomock.Controller) *MockCopyManager { 26 | mock := &MockCopyManager{ctrl: ctrl} 27 | mock.recorder = &MockCopyManagerMockRecorder{mock} 28 | return mock 29 | } 30 | 31 | // EXPECT returns an object that allows the caller to indicate expected use. 32 | func (m *MockCopyManager) EXPECT() *MockCopyManagerMockRecorder { 33 | return m.recorder 34 | } 35 | 36 | // CopyDir mocks base method. 37 | func (m *MockCopyManager) CopyDir(src, dst string) error { 38 | m.ctrl.T.Helper() 39 | ret := m.ctrl.Call(m, "CopyDir", src, dst) 40 | ret0, _ := ret[0].(error) 41 | return ret0 42 | } 43 | 44 | // CopyDir indicates an expected call of CopyDir. 45 | func (mr *MockCopyManagerMockRecorder) CopyDir(src, dst interface{}) *gomock.Call { 46 | mr.mock.ctrl.T.Helper() 47 | return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "CopyDir", reflect.TypeOf((*MockCopyManager)(nil).CopyDir), src, dst) 48 | } 49 | 50 | // CopyFile mocks base method. 51 | func (m *MockCopyManager) CopyFile(src, dst string) error { 52 | m.ctrl.T.Helper() 53 | ret := m.ctrl.Call(m, "CopyFile", src, dst) 54 | ret0, _ := ret[0].(error) 55 | return ret0 56 | } 57 | 58 | // CopyFile indicates an expected call of CopyFile. 59 | func (mr *MockCopyManagerMockRecorder) CopyFile(src, dst interface{}) *gomock.Call { 60 | mr.mock.ctrl.T.Helper() 61 | return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "CopyFile", reflect.TypeOf((*MockCopyManager)(nil).CopyFile), src, dst) 62 | } 63 | -------------------------------------------------------------------------------- /internal/mocks/repository/repository_mock.go: -------------------------------------------------------------------------------- 1 | // Code generated by MockGen. DO NOT EDIT. 2 | // Source: internal/repository.go 3 | 4 | // Package repository is a generated GoMock package. 5 | package repository 6 | 7 | import ( 8 | reflect "reflect" 9 | 10 | gomock "github.com/golang/mock/gomock" 11 | config "github.com/retr0h/gilt/v2/pkg/config" 12 | ) 13 | 14 | // MockRepositoryManager is a mock of RepositoryManager interface. 15 | type MockRepositoryManager struct { 16 | ctrl *gomock.Controller 17 | recorder *MockRepositoryManagerMockRecorder 18 | } 19 | 20 | // MockRepositoryManagerMockRecorder is the mock recorder for MockRepositoryManager. 21 | type MockRepositoryManagerMockRecorder struct { 22 | mock *MockRepositoryManager 23 | } 24 | 25 | // NewMockRepositoryManager creates a new mock instance. 26 | func NewMockRepositoryManager(ctrl *gomock.Controller) *MockRepositoryManager { 27 | mock := &MockRepositoryManager{ctrl: ctrl} 28 | mock.recorder = &MockRepositoryManagerMockRecorder{mock} 29 | return mock 30 | } 31 | 32 | // EXPECT returns an object that allows the caller to indicate expected use. 33 | func (m *MockRepositoryManager) EXPECT() *MockRepositoryManagerMockRecorder { 34 | return m.recorder 35 | } 36 | 37 | // Clone mocks base method. 38 | func (m *MockRepositoryManager) Clone(config config.Repository, cloneDir string) (string, error) { 39 | m.ctrl.T.Helper() 40 | ret := m.ctrl.Call(m, "Clone", config, cloneDir) 41 | ret0, _ := ret[0].(string) 42 | ret1, _ := ret[1].(error) 43 | return ret0, ret1 44 | } 45 | 46 | // Clone indicates an expected call of Clone. 47 | func (mr *MockRepositoryManagerMockRecorder) Clone(config, cloneDir interface{}) *gomock.Call { 48 | mr.mock.ctrl.T.Helper() 49 | return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Clone", reflect.TypeOf((*MockRepositoryManager)(nil).Clone), config, cloneDir) 50 | } 51 | 52 | // CopySources mocks base method. 53 | func (m *MockRepositoryManager) CopySources(config config.Repository, cloneDir string) error { 54 | m.ctrl.T.Helper() 55 | ret := m.ctrl.Call(m, "CopySources", config, cloneDir) 56 | ret0, _ := ret[0].(error) 57 | return ret0 58 | } 59 | 60 | // CopySources indicates an expected call of CopySources. 61 | func (mr *MockRepositoryManagerMockRecorder) CopySources(config, cloneDir interface{}) *gomock.Call { 62 | mr.mock.ctrl.T.Helper() 63 | return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "CopySources", reflect.TypeOf((*MockRepositoryManager)(nil).CopySources), config, cloneDir) 64 | } 65 | 66 | // Worktree mocks base method. 67 | func (m *MockRepositoryManager) Worktree(config config.Repository, cloneDir, targetDir string) error { 68 | m.ctrl.T.Helper() 69 | ret := m.ctrl.Call(m, "Worktree", config, cloneDir, targetDir) 70 | ret0, _ := ret[0].(error) 71 | return ret0 72 | } 73 | 74 | // Worktree indicates an expected call of Worktree. 75 | func (mr *MockRepositoryManagerMockRecorder) Worktree(config, cloneDir, targetDir interface{}) *gomock.Call { 76 | mr.mock.ctrl.T.Helper() 77 | return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Worktree", reflect.TypeOf((*MockRepositoryManager)(nil).Worktree), config, cloneDir, targetDir) 78 | } 79 | -------------------------------------------------------------------------------- /internal/path/path.go: -------------------------------------------------------------------------------- 1 | // Copyright (c) 2023 John Dewey 2 | 3 | // Permission is hereby granted, free of charge, to any person obtaining a copy 4 | // of this software and associated documentation files (the "Software"), to 5 | // deal in the Software without restriction, including without limitation the 6 | // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or 7 | // sell copies of the Software, and to permit persons to whom the Software is 8 | // furnished to do so, subject to the following conditions: 9 | 10 | // The above copyright notice and this permission notice shall be included in 11 | // all copies or substantial portions of the Software. 12 | 13 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 15 | // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 16 | // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 17 | // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 18 | // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 19 | // DEALINGS IN THE SOFTWARE. 20 | 21 | package path 22 | 23 | import ( 24 | "os/user" 25 | "strings" 26 | ) 27 | 28 | // CurrentUserFn function to switch when testing 29 | var CurrentUserFn = user.Current 30 | 31 | // ExpandUser on Unix and Windows, return the argument with an initial 32 | // component of ~ or ~user replaced by that user’s home directory. 33 | func ExpandUser( 34 | path string, 35 | ) (string, error) { 36 | if !strings.HasPrefix(path, "~") { 37 | return path, nil 38 | } 39 | 40 | usr, err := CurrentUserFn() 41 | if err != nil { 42 | return "", err 43 | } 44 | 45 | return strings.Replace(path, "~", usr.HomeDir, 1), nil 46 | } 47 | -------------------------------------------------------------------------------- /internal/path/path_public_test.go: -------------------------------------------------------------------------------- 1 | // Copyright (c) 2023 John Dewey 2 | 3 | // Permission is hereby granted, free of charge, to any person obtaining a copy 4 | // of this software and associated documentation files (the "Software"), to 5 | // deal in the Software without restriction, including without limitation the 6 | // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or 7 | // sell copies of the Software, and to permit persons to whom the Software is 8 | // furnished to do so, subject to the following conditions: 9 | 10 | // The above copyright notice and this permission notice shall be included in 11 | // all copies or substantial portions of the Software. 12 | 13 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 15 | // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 16 | // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 17 | // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 18 | // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 19 | // DEALINGS IN THE SOFTWARE. 20 | 21 | package path_test 22 | 23 | import ( 24 | "fmt" 25 | "os/user" 26 | "testing" 27 | 28 | "github.com/stretchr/testify/assert" 29 | "github.com/stretchr/testify/suite" 30 | 31 | "github.com/retr0h/gilt/v2/internal/path" 32 | ) 33 | 34 | type PathPublicTestSuite struct { 35 | suite.Suite 36 | } 37 | 38 | func (suite *PathPublicTestSuite) TestexpandUserOk() { 39 | originalCurrentUserFn := path.CurrentUserFn 40 | path.CurrentUserFn = func() (*user.User, error) { 41 | return &user.User{ 42 | HomeDir: "/testUser", 43 | }, nil 44 | } 45 | defer func() { path.CurrentUserFn = originalCurrentUserFn }() 46 | 47 | got, err := path.ExpandUser("~/foo/bar") 48 | assert.NoError(suite.T(), err) 49 | assert.Equal(suite.T(), got, "/testUser/foo/bar") 50 | } 51 | 52 | // Test expandUser when there is no work to do 53 | func (suite *PathPublicTestSuite) TestexpandUserNoop() { 54 | testpath := "/foo/bar" 55 | got, err := path.ExpandUser(testpath) 56 | assert.NoError(suite.T(), err) 57 | assert.Equal(suite.T(), got, testpath) 58 | } 59 | 60 | func (suite *PathPublicTestSuite) TestexpandUserReturnsError() { 61 | originalCurrentUserFn := path.CurrentUserFn 62 | path.CurrentUserFn = func() (*user.User, error) { 63 | return nil, fmt.Errorf("failed to get current user") 64 | } 65 | defer func() { path.CurrentUserFn = originalCurrentUserFn }() 66 | 67 | _, err := path.ExpandUser("~/foo/bar") 68 | assert.Error(suite.T(), err) 69 | } 70 | 71 | // In order for `go test` to run this suite, we need to create 72 | // a normal test function and pass our suite to suite.Run. 73 | func TestPathPublicTestSuite(t *testing.T) { 74 | suite.Run(t, new(PathPublicTestSuite)) 75 | } 76 | -------------------------------------------------------------------------------- /internal/repositories.go: -------------------------------------------------------------------------------- 1 | // Copyright (c) 2023 John Dewey 2 | 3 | // Permission is hereby granted, free of charge, to any person obtaining a copy 4 | // of this software and associated documentation files (the "Software"), to 5 | // deal in the Software without restriction, including without limitation the 6 | // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or 7 | // sell copies of the Software, and to permit persons to whom the Software is 8 | // furnished to do so, subject to the following conditions: 9 | 10 | // The above copyright notice and this permission notice shall be included in 11 | // all copies or substantial portions of the Software. 12 | 13 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 15 | // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 16 | // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 17 | // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 18 | // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 19 | // DEALINGS IN THE SOFTWARE. 20 | 21 | package internal 22 | 23 | // RepositoriesManager manager responsible for Repositories operations. 24 | type RepositoriesManager interface { 25 | Overlay() error 26 | } 27 | -------------------------------------------------------------------------------- /internal/repositories/types.go: -------------------------------------------------------------------------------- 1 | // Copyright (c) 2023 John Dewey 2 | 3 | // Permission is hereby granted, free of charge, to any person obtaining a copy 4 | // of this software and associated documentation files (the "Software"), to 5 | // deal in the Software without restriction, including without limitation the 6 | // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or 7 | // sell copies of the Software, and to permit persons to whom the Software is 8 | // furnished to do so, subject to the following conditions: 9 | 10 | // The above copyright notice and this permission notice shall be included in 11 | // all copies or substantial portions of the Software. 12 | 13 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 15 | // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 16 | // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 17 | // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 18 | // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 19 | // DEALINGS IN THE SOFTWARE. 20 | 21 | package repositories 22 | 23 | import ( 24 | "log/slog" 25 | 26 | "github.com/avfs/avfs" 27 | 28 | "github.com/retr0h/gilt/v2/internal" 29 | "github.com/retr0h/gilt/v2/pkg/config" 30 | ) 31 | 32 | // Repositories perform repository operations. 33 | type Repositories struct { 34 | appFs avfs.VFS 35 | config config.Repositories 36 | logger *slog.Logger 37 | 38 | repoManager internal.RepositoryManager 39 | execManager internal.ExecManager 40 | 41 | cloneCache map[string]string 42 | } 43 | -------------------------------------------------------------------------------- /internal/repository.go: -------------------------------------------------------------------------------- 1 | // Copyright (c) 2023 John Dewey 2 | 3 | // Permission is hereby granted, free of charge, to any person obtaining a copy 4 | // of this software and associated documentation files (the "Software"), to 5 | // deal in the Software without restriction, including without limitation the 6 | // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or 7 | // sell copies of the Software, and to permit persons to whom the Software is 8 | // furnished to do so, subject to the following conditions: 9 | 10 | // The above copyright notice and this permission notice shall be included in 11 | // all copies or substantial portions of the Software. 12 | 13 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 15 | // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 16 | // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 17 | // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 18 | // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 19 | // DEALINGS IN THE SOFTWARE. 20 | 21 | package internal 22 | 23 | import ( 24 | "github.com/retr0h/gilt/v2/pkg/config" 25 | ) 26 | 27 | // RepositoryManager manager responsible for Repository operations. 28 | type RepositoryManager interface { 29 | Clone(config config.Repository, cloneDir string) (string, error) 30 | Worktree(config config.Repository, cloneDir string, targetDir string) error 31 | CopySources(config config.Repository, cloneDir string) error 32 | } 33 | -------------------------------------------------------------------------------- /internal/repository/copy.go: -------------------------------------------------------------------------------- 1 | // Copyright (c) 2018 John Dewey 2 | 3 | // Permission is hereby granted, free of charge, to any person obtaining a copy 4 | // of this software and associated documentation files (the "Software"), to 5 | // deal in the Software without restriction, including without limitation the 6 | // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or 7 | // sell copies of the Software, and to permit persons to whom the Software is 8 | // furnished to do so, subject to the following conditions: 9 | 10 | // The above copyright notice and this permission notice shall be included in 11 | // all copies or substantial portions of the Software. 12 | 13 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 15 | // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 16 | // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 17 | // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 18 | // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 19 | // DEALINGS IN THE SOFTWARE. 20 | 21 | package repository 22 | 23 | import ( 24 | "fmt" 25 | "io" 26 | "log/slog" 27 | 28 | "github.com/avfs/avfs" 29 | ) 30 | 31 | // NewCopy factory to create a new copy instance. 32 | func NewCopy( 33 | appFs avfs.VFS, 34 | logger *slog.Logger, 35 | ) *Copy { 36 | return &Copy{ 37 | appFs: appFs, 38 | logger: logger, 39 | } 40 | } 41 | 42 | // CopyFile copies the contents of the file named src to the file named 43 | // by dst. The file will be created if it does not already exist. If the 44 | // destination file exists, all it's contents will be replaced by the contents 45 | // of the source file. The file mode will be copied from the source and 46 | // the copied data is synced/flushed to stable storage. 47 | func (r *Copy) CopyFile( 48 | src string, 49 | dst string, 50 | ) (err error) { 51 | baseSrc := r.appFs.Base(src) 52 | 53 | r.logger.Info( 54 | "copying file", 55 | slog.String("srcFile", baseSrc), 56 | slog.String("dstFile", dst), 57 | ) 58 | 59 | // Open the source file for reading, and record its metadata 60 | in, err := r.appFs.Open(src) 61 | if err != nil { 62 | return err 63 | } 64 | defer func() { _ = in.Close() }() 65 | 66 | si, err := in.Stat() 67 | if err != nil { 68 | return err 69 | } 70 | 71 | // Ensure target directory exists; it will be created with the same mode as 72 | // the target file, plus x-bits. 73 | dirMode := si.Mode() & 0o777 74 | dirMode |= ((dirMode & 0o444) >> 2) | ((dirMode & 0o222) >> 1) 75 | _ = r.appFs.MkdirAll(r.appFs.Dir(dst), dirMode) 76 | // Open dest file for writing; make it owner-only perms before putting 77 | // anything in it 78 | out, err := r.appFs.Create(dst) 79 | if err != nil { 80 | return err 81 | } 82 | defer func() { _ = out.Close() }() 83 | 84 | err = out.Chmod(0o600) 85 | if err != nil { 86 | return err 87 | } 88 | 89 | _, err = io.Copy(out, in) 90 | if err != nil { 91 | return err 92 | } 93 | 94 | err = out.Sync() 95 | if err != nil { 96 | return err 97 | } 98 | 99 | // All done; make the permissions match 100 | err = out.Chmod(si.Mode()) 101 | if err != nil { 102 | return err 103 | } 104 | 105 | return nil 106 | } 107 | 108 | // CopyDir recursively copies a directory tree, attempting to preserve permissions. 109 | // Source directory must exist, destination directory must *not* exist. 110 | // Symlinks are implicitly dereferenced. 111 | func (r *Copy) CopyDir( 112 | src string, 113 | dst string, 114 | ) (err error) { 115 | src = r.appFs.Clean(src) 116 | dst = r.appFs.Clean(dst) 117 | baseSrc := r.appFs.Base(src) 118 | 119 | r.logger.Info( 120 | "copying dir", 121 | slog.String("srcDir", baseSrc), 122 | slog.String("dstDir", dst), 123 | ) 124 | 125 | si, err := r.appFs.Stat(src) 126 | if err != nil { 127 | return err 128 | } 129 | if !si.IsDir() { 130 | return fmt.Errorf("source is not a directory") 131 | } 132 | 133 | d, err := r.appFs.Open(dst) 134 | _ = d.Close() 135 | if err == nil { 136 | return fmt.Errorf("destination already exists") 137 | } 138 | 139 | err = r.appFs.MkdirAll(dst, si.Mode()) 140 | if err != nil { 141 | return err 142 | } 143 | 144 | entries, err := r.appFs.ReadDir(src) 145 | if err != nil { 146 | return err 147 | } 148 | 149 | for _, entry := range entries { 150 | srcPath := r.appFs.Join(src, entry.Name()) 151 | dstPath := r.appFs.Join(dst, entry.Name()) 152 | 153 | // Dereference any symlinks and copy their contents instead 154 | target, err := r.appFs.Stat(srcPath) 155 | if err != nil { 156 | return err 157 | } 158 | 159 | if target.IsDir() { 160 | err = r.CopyDir(srcPath, dstPath) 161 | if err != nil { 162 | return err 163 | } 164 | } else { 165 | err = r.CopyFile(srcPath, dstPath) 166 | if err != nil { 167 | return err 168 | } 169 | } 170 | } 171 | 172 | return nil 173 | } 174 | -------------------------------------------------------------------------------- /internal/repository/helper_test.go: -------------------------------------------------------------------------------- 1 | // Copyright (c) 2018 John Dewey 2 | 3 | // Permission is hereby granted, free of charge, to any person obtaining a copy 4 | // of this software and associated documentation files (the "Software"), to 5 | // deal in the Software without restriction, including without limitation the 6 | // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or 7 | // sell copies of the Software, and to permit persons to whom the Software is 8 | // furnished to do so, subject to the following conditions: 9 | 10 | // The above copyright notice and this permission notice shall be included in 11 | // all copies or substantial portions of the Software. 12 | 13 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 15 | // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 16 | // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 17 | // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 18 | // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 19 | // DEALINGS IN THE SOFTWARE. 20 | 21 | package repository_test 22 | 23 | import ( 24 | "github.com/avfs/avfs" 25 | ) 26 | 27 | type FileSpec struct { 28 | appFs avfs.VFS 29 | srcDir string 30 | srcFile string 31 | srcFiles []string 32 | } 33 | 34 | func createFileSpecs(specs []FileSpec) { 35 | for _, s := range specs { 36 | if s.srcDir != "" { 37 | _ = s.appFs.MkdirAll(s.srcDir, 0o755) 38 | } 39 | 40 | if s.srcFile != "" { 41 | _, _ = s.appFs.Create(s.srcFile) 42 | } 43 | 44 | if len(s.srcFiles) > 0 { 45 | for _, f := range s.srcFiles { 46 | _, _ = s.appFs.Create(f) 47 | } 48 | } 49 | } 50 | } 51 | -------------------------------------------------------------------------------- /internal/repository/repository.go: -------------------------------------------------------------------------------- 1 | // Copyright (c) 2018 John Dewey 2 | 3 | // Permission is hereby granted, free of charge, to any person obtaining a copy 4 | // of this software and associated documentation files (the "Software"), to 5 | // deal in the Software without restriction, including without limitation the 6 | // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or 7 | // sell copies of the Software, and to permit persons to whom the Software is 8 | // furnished to do so, subject to the following conditions: 9 | 10 | // The above copyright notice and this permission notice shall be included in 11 | // all copies or substantial portions of the Software. 12 | 13 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 15 | // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 16 | // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 17 | // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 18 | // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 19 | // DEALINGS IN THE SOFTWARE. 20 | 21 | package repository 22 | 23 | import ( 24 | "errors" 25 | "fmt" 26 | "log/slog" 27 | "strings" 28 | 29 | "github.com/avfs/avfs" 30 | 31 | "github.com/retr0h/gilt/v2/internal" 32 | "github.com/retr0h/gilt/v2/pkg/config" 33 | ) 34 | 35 | const ORIGIN = "gilt" 36 | 37 | // We'll use this to normalize Git URLs as "safe" filenames 38 | var replacer = strings.NewReplacer("/", "-", ":", "-") 39 | 40 | // New factory to create a new Repository instance. 41 | func New( 42 | appFs avfs.VFS, 43 | copyManager CopyManager, 44 | gitManager internal.GitManager, 45 | logger *slog.Logger, 46 | ) *Repository { 47 | return &Repository{ 48 | appFs: appFs, 49 | copyManager: copyManager, 50 | gitManager: gitManager, 51 | logger: logger, 52 | } 53 | } 54 | 55 | // Clone Repository.Git under Repository.getCloneDir 56 | func (r *Repository) Clone( 57 | c config.Repository, 58 | cloneDir string, 59 | ) (string, error) { 60 | targetDir := r.appFs.Join(cloneDir, replacer.Replace(c.Git)) 61 | remote, err := r.gitManager.Remote(targetDir) 62 | if err == nil && !strings.Contains(remote, ORIGIN) { 63 | r.logger.Info( 64 | "remote does not exist in clone, invalidating cache", 65 | slog.Any("remote", ORIGIN), 66 | slog.String("dstDir", targetDir), 67 | ) 68 | _ = r.appFs.RemoveAll(targetDir) 69 | err = errors.New("cache does not exist") 70 | } 71 | if err != nil { 72 | r.logger.Info("cloning", slog.String("repository", c.Git), slog.String("dstDir", targetDir)) 73 | if err := r.gitManager.Clone(c.Git, ORIGIN, targetDir); err != nil { 74 | return targetDir, err 75 | } 76 | } else { 77 | r.logger.Info("clone already exists", slog.String("dstDir", targetDir)) 78 | if err := r.gitManager.Update(ORIGIN, targetDir); err != nil { 79 | return targetDir, err 80 | } 81 | } 82 | return targetDir, nil 83 | } 84 | 85 | // Worktree create a git workingtree at the given version in Repository.DstDir. 86 | func (r *Repository) Worktree( 87 | c config.Repository, 88 | cloneDir string, 89 | targetDir string, 90 | ) error { 91 | return r.gitManager.Worktree(cloneDir, c.Version, targetDir) 92 | } 93 | 94 | // CopySources copy Repository.Src to Repository.DstFile or Repository.DstDir. 95 | func (r *Repository) CopySources( 96 | c config.Repository, 97 | cloneDir string, 98 | ) error { 99 | r.logger.Debug("copy", slog.String("origin", cloneDir)) 100 | for _, source := range c.Sources { 101 | cloneDirWithSrcPath := r.appFs.Join(cloneDir, source.Src) // join clone dir with head 102 | globbedSrc, err := r.appFs.Glob(cloneDirWithSrcPath) 103 | if err != nil { 104 | return err 105 | } 106 | 107 | for _, src := range globbedSrc { 108 | // The source is a directory 109 | if info, err := r.appFs.Stat(src); err == nil && info.IsDir() { 110 | // ... and dst dir exists 111 | if info, err := r.appFs.Stat(source.DstDir); err == nil && info.IsDir() { 112 | if err := r.appFs.RemoveAll(source.DstDir); err != nil { 113 | return err 114 | } 115 | } 116 | if err := r.copyManager.CopyDir(src, source.DstDir); err != nil { 117 | return err 118 | } 119 | } else { 120 | if source.DstFile != "" { 121 | if err := r.copyManager.CopyFile(src, source.DstFile); err != nil { 122 | return err 123 | } 124 | } else if source.DstDir != "" { 125 | if err := r.appFs.MkdirAll(source.DstDir, 0o755); err != nil { 126 | return fmt.Errorf("unable to create dest dir: %s", err) 127 | } 128 | srcBaseFile := r.appFs.Base(src) 129 | newDst := r.appFs.Join(source.DstDir, srcBaseFile) 130 | if err := r.copyManager.CopyFile(src, newDst); err != nil { 131 | return err 132 | } 133 | } 134 | } 135 | } 136 | } 137 | 138 | return nil 139 | } 140 | -------------------------------------------------------------------------------- /internal/repository/types.go: -------------------------------------------------------------------------------- 1 | // Copyright (c) 2023 John Dewey 2 | 3 | // Permission is hereby granted, free of charge, to any person obtaining a copy 4 | // of this software and associated documentation files (the "Software"), to 5 | // deal in the Software without restriction, including without limitation the 6 | // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or 7 | // sell copies of the Software, and to permit persons to whom the Software is 8 | // furnished to do so, subject to the following conditions: 9 | 10 | // The above copyright notice and this permission notice shall be included in 11 | // all copies or substantial portions of the Software. 12 | 13 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 15 | // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 16 | // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 17 | // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 18 | // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 19 | // DEALINGS IN THE SOFTWARE. 20 | 21 | package repository 22 | 23 | import ( 24 | "log/slog" 25 | 26 | "github.com/avfs/avfs" 27 | 28 | "github.com/retr0h/gilt/v2/internal" 29 | ) 30 | 31 | // Repository contains the repository's details for cloning. 32 | type Repository struct { 33 | appFs avfs.VFS 34 | copyManager CopyManager 35 | gitManager internal.GitManager 36 | logger *slog.Logger 37 | } 38 | 39 | // CopyManager manager responsible for Copy operations. 40 | type CopyManager interface { 41 | CopyDir(src string, dst string) error 42 | CopyFile(src string, dst string) error 43 | } 44 | 45 | // Copy copy implementation. 46 | type Copy struct { 47 | appFs avfs.VFS 48 | logger *slog.Logger 49 | } 50 | -------------------------------------------------------------------------------- /main.go: -------------------------------------------------------------------------------- 1 | // Copyright (c) 2018 John Dewey 2 | 3 | // Permission is hereby granted, free of charge, to any person obtaining a copy 4 | // of this software and associated documentation files (the "Software"), to 5 | // deal in the Software without restriction, including without limitation the 6 | // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or 7 | // sell copies of the Software, and to permit persons to whom the Software is 8 | // furnished to do so, subject to the following conditions: 9 | 10 | // The above copyright notice and this permission notice shall be included in 11 | // all copies or substantial portions of the Software. 12 | 13 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 15 | // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 16 | // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 17 | // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 18 | // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 19 | // DEALINGS IN THE SOFTWARE. 20 | 21 | package main 22 | 23 | import ( 24 | "github.com/retr0h/gilt/v2/cmd" 25 | ) 26 | 27 | func main() { 28 | cmd.Execute() 29 | } 30 | -------------------------------------------------------------------------------- /pkg/config/schema.go: -------------------------------------------------------------------------------- 1 | // Copyright (c) 2023 John Dewey 2 | 3 | // Permission is hereby granted, free of charge, to any person obtaining a copy 4 | // of this software and associated documentation files (the "Software"), to 5 | // deal in the Software without restriction, including without limitation the 6 | // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or 7 | // sell copies of the Software, and to permit persons to whom the Software is 8 | // furnished to do so, subject to the following conditions: 9 | 10 | // The above copyright notice and this permission notice shall be included in 11 | // all copies or substantial portions of the Software. 12 | 13 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 15 | // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 16 | // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 17 | // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 18 | // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 19 | // DEALINGS IN THE SOFTWARE. 20 | 21 | package config 22 | 23 | import ( 24 | "github.com/go-playground/validator/v10" 25 | ) 26 | 27 | // regsiterValidatorsFn function to switch when testing 28 | var registerValidatorsFn = registerValidators 29 | 30 | // registerValidators register customer validators. 31 | func registerValidators(v *validator.Validate) error { 32 | // noop - hook for future validators 33 | return nil 34 | } 35 | 36 | // Validate validates a structs exposed fields. 37 | func Validate( 38 | c *Repositories, 39 | ) error { 40 | validate := validator.New() 41 | 42 | err := registerValidatorsFn(validate) 43 | if err != nil { 44 | return err 45 | } 46 | 47 | return validate.Struct(c) 48 | } 49 | -------------------------------------------------------------------------------- /pkg/config/types.go: -------------------------------------------------------------------------------- 1 | // Copyright (c) 2023 John Dewey 2 | 3 | // Permission is hereby granted, free of charge, to any person obtaining a copy 4 | // of this software and associated documentation files (the "Software"), to 5 | // deal in the Software without restriction, including without limitation the 6 | // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or 7 | // sell copies of the Software, and to permit persons to whom the Software is 8 | // furnished to do so, subject to the following conditions: 9 | 10 | // The above copyright notice and this permission notice shall be included in 11 | // all copies or substantial portions of the Software. 12 | 13 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 15 | // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 16 | // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 17 | // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 18 | // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 19 | // DEALINGS IN THE SOFTWARE. 20 | 21 | package config 22 | 23 | // Repositories perform repository operations. 24 | type Repositories struct { 25 | // Debug enable or disable debug option set from CLI. 26 | Debug bool `mapstruture:"debug"` 27 | // Parallel enable or disable concurrent clone fetches. 28 | Parallel bool ` mapstructure:"parallel"` 29 | // SkipCommands run post-commands as part of the overlay process 30 | SkipCommands bool 31 | // GiltFile path to Gilt's config file option set from CLI. 32 | GiltFile string ` mapstructure:"giltFile" validate:"required"` 33 | // GiltDir path to Gilt's clone dir option set from CLI. 34 | GiltDir string ` mapstructure:"giltDir" validate:"required"` 35 | // Repositories a slice of repository configurations to overlay. 36 | Repositories []Repository `mapstruture:"repositories" validate:"required,dive"` 37 | } 38 | 39 | // Source mapping of files and/or directories needing copied. 40 | type Source struct { 41 | // Src source file or directory to copy. 42 | Src string `mapstructure:"src" validate:"required"` 43 | // DstFile destination of file copy. 44 | DstFile string `mapstructure:"dstFile" validate:"required_without=DstDir,excluded_with=DstDir"` 45 | // DstDir destination of directory copy. 46 | DstDir string `mapstructure:"dstDir" validate:"required_without=DstFile,excluded_with=DstFile,ne=.,ne=.."` 47 | } 48 | 49 | // Water string `validate:"required_without=Fire,excluded_with=Fire"` 50 | 51 | // Command command to execute. 52 | type Command struct { 53 | Cmd string `mapstructure:"cmd" validate:"required"` 54 | Args []string `mapstructure:"args"` 55 | } 56 | 57 | // Repository contains the repository's details for cloning. 58 | type Repository struct { 59 | // Git url of Git repository to clone. 60 | Git string `mapstructure:"git" validate:"required"` 61 | // Version the commit SHA or tag to use. 62 | Version string `mapstructure:"version" validate:"required"` 63 | // DstDir destination directory to copy clone to. 64 | DstDir string `mapstructure:"dstDir" validate:"required_without=Sources,excluded_with=Sources,ne=.,ne=.."` 65 | // Sources containing files and/or directories to copy. 66 | Sources []Source `mapstructure:"sources" validate:"dive,required_without=DstDir,excluded_with=DstDir"` 67 | // Commands commands to execute on Repository. 68 | Commands []Command `mapstructure:"commands"` 69 | } 70 | -------------------------------------------------------------------------------- /pkg/repositories.go: -------------------------------------------------------------------------------- 1 | // Copyright (c) 2023 John Dewey 2 | 3 | // Permission is hereby granted, free of charge, to any person obtaining a copy 4 | // of this software and associated documentation files (the "Software"), to 5 | // deal in the Software without restriction, including without limitation the 6 | // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or 7 | // sell copies of the Software, and to permit persons to whom the Software is 8 | // furnished to do so, subject to the following conditions: 9 | 10 | // The above copyright notice and this permission notice shall be included in 11 | // all copies or substantial portions of the Software. 12 | 13 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 15 | // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 16 | // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 17 | // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 18 | // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 19 | // DEALINGS IN THE SOFTWARE. 20 | 21 | package pkg 22 | 23 | // RepositoriesManager manager responsible for public Repositories operations. 24 | type RepositoriesManager interface { 25 | Overlay() error 26 | } 27 | -------------------------------------------------------------------------------- /pkg/repositories/types.go: -------------------------------------------------------------------------------- 1 | // Copyright (c) 2023 John Dewey 2 | 3 | // Permission is hereby granted, free of charge, to any person obtaining a copy 4 | // of this software and associated documentation files (the "Software"), to 5 | // deal in the Software without restriction, including without limitation the 6 | // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or 7 | // sell copies of the Software, and to permit persons to whom the Software is 8 | // furnished to do so, subject to the following conditions: 9 | 10 | // The above copyright notice and this permission notice shall be included in 11 | // all copies or substantial portions of the Software. 12 | 13 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 15 | // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 16 | // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 17 | // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 18 | // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 19 | // DEALINGS IN THE SOFTWARE. 20 | 21 | package repositories 22 | 23 | import ( 24 | "log/slog" 25 | 26 | "github.com/avfs/avfs" 27 | 28 | "github.com/retr0h/gilt/v2/internal" 29 | "github.com/retr0h/gilt/v2/pkg/config" 30 | ) 31 | 32 | // Repositories perform repository operations. 33 | type Repositories struct { 34 | appFs avfs.VFS 35 | c config.Repositories 36 | reposManager internal.RepositoriesManager 37 | logger *slog.Logger 38 | } 39 | -------------------------------------------------------------------------------- /test/Giltfile.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | debug: false 3 | repositories: 4 | - git: https://github.com/retr0h/ansible-etcd.git 5 | version: 77a95b7 6 | dstDir: retr0h.ansible-etcd 7 | commands: 8 | - cmd: touch 9 | args: ansible-etcd-repo-post-command-1 10 | - git: https://github.com/retr0h/ansible-etcd.git 11 | version: 1.1 12 | dstDir: retr0h.ansible-etcd-tag 13 | - git: https://github.com/lorin/openstack-ansible-modules.git 14 | version: 2677cc3 15 | sources: 16 | - src: "*_manage" 17 | dstDir: library 18 | - src: nova_quota 19 | dstDir: library 20 | - src: neutron_router 21 | dstFile: library/neutron_router.py 22 | - src: tests 23 | dstDir: tests 24 | commands: 25 | - cmd: touch 26 | args: openstack-ansible-modules-repo-post-command-1 27 | - cmd: touch 28 | args: openstack-ansible-modules-repo-post-command-2 29 | --------------------------------------------------------------------------------