Merge pull request #470 from LFd3v/master

community repo was merged with extra, please refer to:

https://archlinux.org/news/git-migration-announcement/
https://archlinux.org/news/git-migration-completed/

.gitattributes

@@ -0,0 +1 @@
+yadm text eol=lf

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,77 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at <yadm@yadm.io>. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq
+

.github/CONTRIBUTING.md

@@ -0,0 +1,385 @@
+# Introduction
+
+Thank you for considering contributing to **yadm**. I develop this project in my
+limited spare time, so help is very appreciated.
+
+All contributors must follow our [Code of Conduct][conduct]. Please make sure
+you are welcoming and friendly during your interactions, and report any
+unacceptable behavior to <yadm@yadm.io>.
+
+Contributions can take many forms, and often don’t require writing code—maybe
+something could be documented more clearly, maybe a feature could be more
+helpful, maybe installation could be easier. Help is welcome in any of these
+areas.
+
+To contribute, you can:
+
+* Star the yadm repo, the star count helps others discover yadm.
+* Report [bugs](#reporting-a-bug)
+* Request [features/enhancements](#suggesting-a-feature-or-enhancement)
+* Contribute changes to [code, tests](#contributing-code), and [documentation](#improving-documentation)
+* Maintain installation [packages](#maintaining-packages)
+* Help other users by [answering support questions](#answering-support-questions)
+
+# Reporting a bug
+
+Notice something amiss? You’re already helping by reporting the problem! Bugs
+are tracked using GitHub issues. Here are some steps you can take to help
+problems get fixed quickly and effectively:
+
+### Before submitting an issue
+
+Please take a quick look to see whether the problem has been reported already
+(there’s a list of [open issues][open-issues]). You can try the search function
+with some related terms for a cursory check. If you do find a previous report,
+please add a comment there instead of opening a new issue.
+
+### Security issues
+
+If you have found a security vulnerability, do **NOT** open an issue.
+
+Any security issues should be emailed directly to <yadm@yadm.io>. In order to
+determine whether you are dealing with a security issue, ask yourself these two
+questions:
+
+* Can I access something that's not mine, or something I shouldn't have access to?
+* Can I disable something for other people?
+
+If the answer to either of those two questions is "yes", then you're probably
+dealing with a security issue.
+
+### Submitting a (great) bug report
+
+Choose the "[Bug report][new-bug]" issue type.
+
+Pick a descriptive title that clearly identifies the issue.
+
+Describe the steps that led to the problem so that we can go through the same
+sequence. A clear set of steps to reproduce the problem is key to fixing an
+issue. If possible, attach a [`script.gz`](#attaching-a-scriptgz) to the bug
+report.
+
+Describe what you had expected and how that differed from what happened, and
+possibly, why.
+
+Include the version numbers of your operating system, of **yadm**, and of Git.
+
+### Attaching a script.gz
+
+Consider trying to reproduce the bug inside a docker container using the
+[yadm/testbed][] docker image. Doing so will greatly increase the likelihood of
+the problem being fixed.
+
+The easiest way to start this container, is to clone the [TheLocehiliosan/yadm
+repo][yadm-repo], and use the `scripthost` make target. _(You will need `make`
+and `docker` installed.)_
+
+For example:
+
+```text
+$ git clone https://github.com/TheLocehiliosan/yadm.git
+$ cd yadm
+$ make scripthost version=1.12.0
+Starting scripthost version="1.12.0" (recording script)
+root@scripthost:~# ### run commands which
+root@scripthost:~# ### demonstrate the problem
+root@scripthost:~# ### a succinct set of commands is best
+root@scripthost:~# exit
+logout
+
+Script saved to script.gz
+$
+```
+
+A `script.gz` like this can be useful to developers to make a repeatable test
+for the problem. You can attach the `script.gz` file to an issue. Look
+[here][attach-help] for help with [attaching a file][attach-help].
+
+# Suggesting a feature or enhancement
+
+Have an idea for an improvement? Creating a feature request is a good way to
+communicate it.
+
+### Before submitting an issue
+
+Please take a quick look to see whether your idea has been suggested already
+(there’s a list of [open issues][open-issues]). You can try the search function
+with some related terms for a cursory check. If you do find a previous feature
+request, please add a comment there instead of opening a new issue.
+
+### Submitting a (great) feature request
+
+Choose the "[Feature request][new-feature]" issue type.
+
+Summarize your idea with a clear title.
+
+Describe your suggestion in as much detail as possible.
+
+Explain alternatives you've considered.
+
+# Contributing code
+
+Wow, thank you for considering making a contribution of code!
+
+### Before you begin
+
+Please take a quick look to see whether a similar change is already being worked
+on. A similar pull request may already exist. If the change is related to an
+issue, look to see if that issue has an assignee.
+
+Consider reaching out before you start working. It's possible developers may
+have some ideas and code lying around, and might be able to give you a head
+start.
+
+[Creating a hook][hooks-help] is an easy way to begin adding features to an
+already existing **yadm** operation. If the hook works well, it could be the
+basis of a **yadm** feature addition. Or it might just be a [useful
+hook][contrib-hooks] for someone else.
+
+### Design principles
+
+**yadm** was created with a few core design principles in mind. Please adhere to
+these principles when making changes.
+
+* **Single repository**
+    * **yadm** is designed to maintain dotfiles in a single repository.
+
+* **Very few dependencies**
+    * **yadm** should be as portable as possible. This is one of the main
+      reasons it has only two dependencies (Bash and Git). Features using other
+      dependencies should gracefully downgrade instead of breaking. For example,
+      encryption requires GnuPG installed, and displays that information if it
+      is not.
+
+* **Sparse configuration**
+    * **yadm** should require very little configuration, and come with sensible
+      defaults. Changes requiring users to define meta-data for all of their
+      dotfiles will not be accepted.
+
+* **Maintain dotfiles in place**
+    * The default treatment for tracked data should be to allow it to remain a
+      file, in the location it is normally kept.
+
+* **Leverage Git**
+    * Stay out of the way and let Git do what it’s good at. Git has a deep and
+      rich set of features for just about every use case. Staying hands off for
+      almost all Git operations will make **yadm** more flexible and
+      future-proof.
+
+### Repository branches and tags
+
+* `master`
+    * This branch will always represent the latest release of **yadm**.
+* `#.#.#` _(tags)_
+    * Every release of **yadm** will have a commit tagged with the version number.
+* `develop`
+    * This branch should be used for the basis of every change. As changes are
+      accepted, they will be merged into `develop`.
+* `release/*`
+    * These are ephemeral branches used to prepare new releases.
+* `hotfix/*`
+    * These are ephemeral branches used to prepare a patch release, which only
+      includes bug fixes.
+* `gh-pages`
+    * This branch contains the yadm.io website source.
+* `dev-pages`
+    * This branch should be used for the basis of every website change. As
+      changes are accepted, they will be merged into dev-pages.
+* `netlify/*`
+    * These branches deploy configurations to Netlify websites. Currently this
+      is only used to drive redirections for
+      [bootstrap.yadm.io](https://bootstrap.yadm.io/).
+
+### GitHub workflow
+
+1. Fork the [yadm repository][yadm-repo] on GitHub.
+
+2. Clone your fork locally.
+
+    ```text
+    $ git clone <url-to-your-fork>
+    ```
+
+3. Add the official repository (`upstream`) as a remote repository.
+
+    ```text
+    $ git remote add upstream https://github.com/TheLocehiliosan/yadm.git
+    ```
+
+4. Verify you can run the test harness. _(This will require dependencies:
+   `make` and `docker`)_.
+
+    ```text
+    $ make test
+    ```
+    If you don't use `docker` but an OCI engine akin to `podman`, you can set it through the `OCI` switch for every target
+
+    ```text
+    $ make test OCI=podman
+    ```
+
+5. Create a feature branch, based off the `develop` branch.
+
+    ```text
+    $ git checkout -b <name-of-feature-branch> upstream/develop
+    ```
+
+6. Add changes to your feature branch.
+
+7. If your changes take a few days, be sure to occasionally pull the latest
+   changes from upstream, to ensure that your local branch is up-to-date.
+
+    ```text
+    $ git pull --rebase upstream develop
+    ```
+
+8. When your work is done, push your local branch to your fork.
+
+    ```text
+    $ git push origin <name-of-feature-branch>
+    ```
+
+9. [Create a pull request][pr-help] using `develop` as the "base".
+
+### Code conventions
+
+When updating the yadm code, please follow these guidelines:
+
+* Code linting
+    * Bash code should pass the scrutiny of [ShellCheck][shellcheck].
+    * Python code must pass the scrutiny of [pylint][] and [flake8][].
+    * Any YAML must pass the scrutiny of [yamllint][].
+    * Running `make test_syntax.py` is an easy way to run all linters.
+* Interface changes
+    * Any changes to **yadm**'s interface should include a commit that updates
+      the `yadm.1` man page.
+
+### Test conventions
+
+The test system is written in Python 3 using [pytest][]. Tests should be written
+for all bugs fixed and features added. To make testing portable and uniform,
+tests should be performed via the [yadm/testbed][] docker image. The `Makefile`
+has several "make targets" for testing. Running `make` by itself will produce a
+help page.
+
+Please follow these guidelines while writing tests:
+
+* Organization
+    * Tests should be kept in the `test/` directory.
+    * Every test module name should start with `test_`.
+    * Unit tests, which test individual functions should have names that begin
+      with `test_unit_`.
+    * Completely new features should get their own test modules, while updates
+      to existing features should have updated test modules.
+* Efficiency
+    * Care should be taken to make tests run as efficiently as possible.
+    * Scope large, unchanging, fixtures appropriately so they do not have to be
+      recreated multiple times.
+
+### Commit conventions
+
+When arranging your commits, please adhere to the following conventions.
+
+* Commit messages
+    * Use the "[Tim Pope][tpope-style]" style of commit messages. Here is a
+      [great guide][commit-style] to writing commit messages.
+* Atomic commits
+    * Please create only [atomic commits][atomic-commits].
+* Signed commits
+    * All commits must be [cryptographically signed][signing-commits].
+
+# Improving documentation
+
+Wow, thank you for considering making documentation improvements!
+
+There is overlap between the content of the man page, and the information on the
+website. Consider reviewing both sets of documentation, and submitting similar
+changes for both to improve consistency.
+
+### Man page changes
+
+The man page documentation is contained in the file `yadm.1`. This file is
+formatted using [groff man macros][groff-man]. Changes to this file can be
+tested using "make targets":
+
+```text
+$ make man
+$ make man-wide
+$ make man-ps
+```
+
+While the [markdown version of the man page][yadm-man] is generated from
+`yadm.1`, please do not include changes to `yadm.md` within any pull request.
+That file is only updated during software releases.
+
+### Website changes
+
+The yadm.io website is generated using [Jekyll][jekyll]. The bulk of the
+documentation is created as an ordered collection within `_docs`. To make
+website testing easy and portable, use the [yadm/jekyll][] docker image. The
+`Makefile` has several "make targets" for testing. Running `make` by itself will
+produce a help page.
+
+* `make test`:
+    Perform tests done by continuous integration.
+* `make up`:
+    Start a container to locally test the website. The test website will be
+    hosted at http://localhost:4000/
+* `make clean`:
+    Remove previously built data any any Jekyll containers.
+
+When making website changes, be sure to adhere to [code](#code-conventions) and
+[commit](#commit-conventions) conventions. Use the same [GitHub
+workflow](#github-workflow) when creating a pull request. However use the
+`dev-pages` branch as a base instead of `develop`.
+
+# Maintaining packages
+
+Maintaining installation packages is very important for making **yadm**
+accessible to as many people as possible. Thank you for considering contributing
+in this way. Please consider the following:
+
+* Watch releases
+    * GitHub allows users to "watch" a project for "releases". Doing so will
+      provide you with notifications when a new version of **yadm** has been
+      released.
+* Include License
+    * Any package of **yadm** should include the license file from the
+      repository.
+* Dependencies
+    * Be sure to include dependencies in a manner appropriate to the packaging
+      system being used. **yadm** won't work very well without Git. :)
+
+# Answering support questions
+
+Are you an experienced **yadm** user, with an advanced knowledge of Git? Your
+expertise could be useful to someone else who is starting out or struggling with
+a problem. Consider reviewing the list of [open support questions][questions] to
+see if you can help.
+
+[atomic-commits]: https://www.google.com/search?q=atomic+commits
+[attach-help]: https://help.github.com/en/articles/file-attachments-on-issues-and-pull-requests
+[commit-style]: https://chris.beams.io/posts/git-commit/#seven-rules
+[conduct]: CODE_OF_CONDUCT.md
+[contrib-hooks]: https://github.com/TheLocehiliosan/yadm/tree/master/contrib/hooks
+[flake8]: https://pypi.org/project/flake8/
+[groff-man]: https://www.gnu.org/software/groff/manual/html_node/man.html
+[hooks-help]: https://github.com/TheLocehiliosan/yadm/blob/master/yadm.md#hooks
+[html-proofer]: https://github.com/gjtorikian/html-proofer
+[jekyll]: https://jekyllrb.com
+[new-bug]: https://github.com/TheLocehiliosan/yadm/issues/new?template=BUG_REPORT.md
+[new-feature]: https://github.com/TheLocehiliosan/yadm/issues/new?template=FEATURE_REQUEST.md
+[open-issues]: https://github.com/TheLocehiliosan/yadm/issues
+[pr-help]: https://help.github.com/en/articles/creating-a-pull-request-from-a-fork
+[pylint]: https://pylint.org/
+[pytest]: https://pytest.org/
+[questions]: https://github.com/TheLocehiliosan/yadm/labels/question
+[refactor]: https://github.com/TheLocehiliosan/yadm/issues/146
+[shellcheck]: https://www.shellcheck.net
+[signing-commits]: https://help.github.com/en/articles/signing-commits
+[tpope-style]: https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+[yadm-man]: https://github.com/TheLocehiliosan/yadm/blob/master/yadm.md
+[yadm-repo]: https://github.com/TheLocehiliosan/yadm
+[yadm/jekyll]: https://hub.docker.com/r/yadm/jekyll
+[yadm/testbed]: https://hub.docker.com/r/yadm/testbed
+[yamllint]: https://github.com/adrienverge/yamllint

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,7 @@
+<!--
+Before submitting, please search open and closed issues at
+https://github.com/TheLocehiliosan/yadm/issues to avoid duplication.
+
+If you have found a security vulnerability, do NOT open an issue.
+Email yadm@yadm.io instead.
+-->

.github/ISSUE_TEMPLATE/BUG_REPORT.md

@@ -0,0 +1,68 @@
+---
+name: Bug report
+about: Create a report to help improve yadm
+title: ''
+labels: bug
+assignees: ''
+
+---
+<!--
+Before submitting, please search open and closed issues at
+https://github.com/TheLocehiliosan/yadm/issues to avoid duplication.
+
+If you have found a security vulnerability, do NOT open an issue.
+Email yadm@yadm.io instead.
+-->
+
+### Describe the bug
+
+[A clear and concise description of what the bug is.]
+
+### To reproduce
+
+Can this be reproduced with the yadm/testbed docker image: [Yes/No]
+<!--
+Consider trying to reproduce the bug inside a docker container using the
+yadm/testbed docker image. https://hub.docker.com/r/yadm/testbed
+
+The easiest way to start this container, is to clone the TheLocehiliosan/yadm
+repo, and use the "scripthost" make target. For example:
+
+  $ git clone https://github.com/TheLocehiliosan/yadm.git
+  $ cd yadm
+  $ make scripthost version=1.11.0
+  Starting scripthost version="1.11.0" (recording script)
+  root@scripthost:~# ### run commands which
+  root@scripthost:~# ### demonstrate the problem
+  root@scripthost:~# ### a succinct set of commands is best
+  root@scripthost:~# exit
+  logout
+
+  Script saved to script.gz
+  $
+
+A script like this can be useful to developers to make a repeatable test for the
+problem. You can attach a script.gz file to an issue.
+https://help.github.com/en/articles/file-attachments-on-issues-and-pull-requests
+-->
+
+Steps to reproduce the behavior:
+
+1. Run command '....'
+2. Run command '....'
+3. Run command '....'
+4. See error
+
+### Expected behavior
+
+[A clear and concise description of what you expected to happen.]
+
+### Environment
+
+ - Operating system: [Ubuntu 18.04, yadm/testbed, etc.]
+ - Version yadm: [found via `yadm version`]
+ - Version Git: [found via `git --version`]
+
+### Additional context
+
+[Add any other context about the problem here.]

.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

@@ -0,0 +1,29 @@
+---
+name: Feature request
+about: Suggest an idea for yadm
+title: ''
+labels: feature
+assignees: ''
+
+---
+<!--
+Before submitting, please search open and closed issues at
+https://github.com/TheLocehiliosan/yadm/issues to avoid duplication.
+-->
+
+### Is your feature request related to a problem? Please describe.
+
+[A clear and concise description of what the problem is. Ex. I'm always frustrated when ...]
+
+### Describe the solution you'd like
+
+[A clear and concise description of what you want to happen.]
+
+### Describe alternatives you've considered
+
+[A clear and concise description of any alternative solutions or features you've
+considered. For example, have you considered using yadm "hooks" as a solution?]
+
+### Additional context
+
+[Add any other context or screenshots about the feature request here.]

.github/ISSUE_TEMPLATE/OTHER.md

@@ -0,0 +1,23 @@
+---
+name: Other issue
+about: Report issues with documentation, packaging, or something else
+title: ''
+labels: ''
+assignees: ''
+
+---
+<!--
+Before submitting, please search open and closed issues at
+https://github.com/TheLocehiliosan/yadm/issues to avoid duplication.
+-->
+
+### This issue is about
+
+* [ ] Man pages or command-line usage
+* [ ] Website documentation
+* [ ] Packaging
+* [ ] Other
+
+### Describe the issue
+
+[A clear and concise description of the issue.]

.github/ISSUE_TEMPLATE/SUPPORT.md

@@ -0,0 +1,36 @@
+---
+name: Support
+about: Get help using yadm
+title: ''
+labels: 'question'
+assignees: ''
+
+---
+<!--
+Before submitting, please search open and closed issues at
+https://github.com/TheLocehiliosan/yadm/issues to avoid duplication.
+
+Please also consult:
+  * The FAQ: https://yadm.io/docs/faq
+  * The manual: https://github.com/TheLocehiliosan/yadm/blob/master/yadm.md
+-->
+
+### This question is about
+
+* [ ] Installation
+* [ ] Initializing / Cloning
+* [ ] Alternate files
+* [ ] Jinja templates
+* [ ] Encryption
+* [ ] Bootstrap
+* [ ] Hooks
+* [ ] Other
+
+### Describe your question
+
+<!--
+Consider including:
+  * the commands you've run, and the output produced
+  * links to any public repo/branch involved
+-->
+[A clear and concise description of the question.]

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,34 @@
+### What does this PR do?
+
+[A clear and concise description of what this pull request accomplishes.]
+
+### What issues does this PR fix or reference?
+
+<!--
+Be sure to preface the issue/PR numbers with a "#".
+-->
+[A list of related issues / pull requests.]
+
+### Previous Behavior
+
+[Describe the existing behavior.]
+
+### New Behavior
+
+[Describe the behavior, after this PR is applied.]
+
+### Have [tests][1] been written for this change?
+
+[Yes / No]
+
+### Have these commits been [signed with GnuPG][2]?
+
+[Yes / No]
+
+---
+
+Please review [yadm's Contributing Guide][3] for best practices.
+
+[1]: https://github.com/TheLocehiliosan/yadm/blob/master/.github/CONTRIBUTING.md#test-conventions
+[2]: https://help.github.com/en/articles/signing-commits
+[3]: https://github.com/TheLocehiliosan/yadm/blob/master/.github/CONTRIBUTING.md

.github/workflows/schedule.yml

@@ -0,0 +1,20 @@
+---
+name: Scheduled Site Tests
+on:  # yamllint disable-line rule:truthy
+  schedule:
+    - cron: "0 0 1 * *"  # Monthly
+jobs:
+  Tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          ref: gh-pages
+      - run: >-
+          docker create -t
+          --name yadm-website
+          --entrypoint test/validate
+          yadm/jekyll:2019-10-17;
+          docker cp ./ yadm-website:/srv/jekyll
+      - name: Test Site
+        run: docker start yadm-website -a

.github/workflows/stale.yml

@@ -0,0 +1,25 @@
+---
+name: Close Stale Issues
+on:  # yamllint disable-line rule:truthy
+  schedule:
+    - cron: "30 1 * * *"  # Daily
+jobs:
+  Stale:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/stale@v4
+        with:
+          close-issue-message: >-
+            This issue was closed because it has been labeled as stale for 7
+            days with no activity.
+          days-before-close: 7
+          days-before-stale: 60
+          exempt-all-assignees: true
+          exempt-issue-labels: in develop, 1, 2, 3
+          exempt-pr-labels: in develop, 1, 2, 3
+          stale-issue-label: stale
+          stale-issue-message: >-
+            This issue has been labeled as stale because it has been open 60
+            days with no activity. Remove stale label or comment or this will
+            be closed in 7 days.
+          stale-pr-label: stale

.github/workflows/test.yml

@@ -0,0 +1,13 @@
+---
+name: Tests
+on:  # yamllint disable-line rule:truthy
+  - push
+  - pull_request
+  - workflow_dispatch
+jobs:
+  Tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Tests
+        run: make test

.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+.jekyll-metadata
+.pytest_cache
+.sass-cache
+.testyadm
+_site
+testenv

CHANGES

@@ -0,0 +1,193 @@
+3.2.2
+  * Support spaces in distro/distro-family (#432)
+  * Fix zsh hanging when tab completing add/checkout (#417)
+  * Add yadm-untracked script to contributed files (#418)
+  * Fix documentation typos (#425)
+  * Support docker-like OCI engines for dev testing (#431)
+
+3.2.1
+  * Fix Bash 3 bad array subscript bug (#411)
+
+3.2.0
+  * Support architecture for alternates/templates (#202, #203, #393)
+  * Support distro_family for alternates/templates (#213)
+  * Support setting multiple classes (#185, #304)
+  * Support environment variables in default template processor (#347)
+  * Update version command to include Bash & Git versions (#377)
+
+3.1.1
+  * Fix clone support for older versions of Git (#348)
+  * Fix support for multiple GPG recipients (#342)
+  * Find symlinks in bootstrap-in-dir (#340)
+
+3.1.0
+  * Use `git clone` directly during clone (#289, #323)
+  * Fix compatibility bug with Git completions (#318, #321)
+  * Support relative paths for --yadm-* and -w (#301)
+  * Improve parsing of if-statement in default template (#303)
+  * Read files without running cat in subshells (#317)
+  * Improve portability of updating read-only files (#320)
+  * Various code improvements (#306, #307, #311)
+
+3.0.2
+  * Fix parsing by sh (#299)
+
+3.0.1
+  * Improve handling of submodules at upgrade (#284, #285, #293)
+  * Improve Zsh completions (#292, #298)
+  * Use stderr for error messages (#297)
+
+3.0.0
+  * Support encryption with OpenSSL (#138)
+  * Support "include" directive in built-in template processor (#255)
+  * Support extensions for alternate files and templates (#257)
+  * Improve support for default branches (#231, #232)
+  * Add --version and --help as yadm internal commands (#267)
+  * Improve support for XDG base directory specification
+  * Use XDG_DATA_HOME used for encrypted data and repository (#208)
+  * Default repo is now ~/.local/share/yadm/repo.git
+  * Default encrypted archive is now ~/.local/share/yadm/archive
+  * Improve shell completions (#238, #274, #275)
+  * Remove support for YADM_COMPATIBILITY=1 (#242)
+  * Remove deprecated option cygwin-copy
+  * Fix template mode inheritance on FreeBSD (#243, #246)
+  * Fix hook execution under MinGW (#150)
+  * Improve compatibility with Oil shell (#210)
+
+2.5.0
+  * Support for transcrypt (#197)
+  * Support ESH templates (#220)
+  * Preserve file mode of template (#193)
+  * Fish shell completions (#224)
+  * Fix alt processing when worktree is `/` (#198)
+  * Assert config directory if missing (#226, #227)
+  * Documentation improvements (#229)
+
+2.4.0
+  * Support multiple keys in `yadm.gpg-recipient` (#139)
+  * Ensure all templates are written atomically (#142)
+  * Add encrypt_with_checksums to the hooks collection (#188)
+  * Escape white space in YADM_HOOK_FULL_COMMAND (#187)
+  * Improve parsing of os-release (#194)
+  * Improve identification of WSL (#196)
+  * Fix troff warnings emitted by man page (#195)
+  * Write encrypt-based exclusions during decrypt
+
+2.3.0
+  * Support git-crypt (#168)
+  * Support specifying a command after `yadm enter`
+  * Expose GIT_WORK_TREE during `yadm enter` (#160)
+  * Support GNUPGHOME environment variable (#134)
+  * Assert private dirs, only when worktree = $HOME (#171)
+
+2.2.0
+  * Resolve hostname using `uname -n` (#182)
+  * Use /etc/os-release if lsb_release is missing (#175)
+  * Issue warning for any invalid alternates found (#183)
+  * Add support for gawk (#180)
+
+2.1.0
+  * Use relative symlinks for alternates (#100, #177)
+  * Support double-star globs in .config/yadm/encrypt (#109)
+  * Improve bash completion (#136)
+  * Update docs about using magit (#123)
+  * Note exception for WSL (#113)
+
+2.0.1
+  * Fix bug with worktree permissions (#174)
+
+2.0.0
+  * Support XDG base directory specification
+  * Redesign alternate processing
+  * Add built-in default template processor
+  * Allow storing alternates in yadm dir (#90)
+  * Add support for j2cli template processor
+  * Ignore encrypted files (#69)
+  * Support DISTRO in alternates (#72)
+  * Support `source` in templates (#163)
+  * Change yadm.cygwin-copy to yadm.alt-copy
+  * Support `-b <branch>` when cloning (#133)
+  * Support includes for j2-based templates (#114)
+  * Remove stale/invalid linked alternates (#65)
+  * Add support for Mingw/Msys (#102)
+  * Allow `-l` to pass thru to the `yadm config` command
+  * Improve processing of `yadm/encrypt`
+  * Fix bugs in legacy alternate processing
+  * Fix bug with hidden private files
+  * Improve support for older versions of Git
+  * Add upgrade command
+
+1.12.0
+  * Add basic Zsh completion (#71, #79)
+  * Support directories in `.yadm/encrypt` (#81, #82)
+  * Support exclusions in `.yadm/encrypt` (#86)
+  * Improve portability with printf (#87)
+  * Eliminate usage of `eval` and `ls`
+
+1.11.1
+  * Create private dirs prior to merge (#74)
+
+1.11.0
+  * Option for Cygwin to copy files instead of symlink (#62)
+  * Support `YADM_DISTRO` in Jinja templates (#68)
+  * Support pre/post hooks for every command (#70)
+
+1.10.0
+  * Fix `COMP_WORDS bad array subscript` bug (#64)
+  * Transition to semantic versioning
+
+1.09
+  * Add Bash completion script (#60)
+  * Support WSL detection (#61)
+  * Add introspect command (used by completion)
+
+1.08
+  * Fix bug alternates based on `CLASS` (#51)
+  * Support globs and paths with space in .yadm/encrypt (#53, #54)
+  * Add support for alternate files using Jinja templates (#56, #58)
+  * Add `enter` command, for creating a sub-shell (#57)
+  * Support local.hostname properly (#59)
+
+1.07
+  * Add `CLASS` to supported alt-link patterns (#21)
+  * Add bootstrap command (#42)
+  * Support wildcards for alt-links (#43)
+  * Stash conflicting data during clone (#44)
+  * Offer bootstrap after successful clone (#45)
+  * Display supported configs for `yadm config` (#46)
+  * Add "curl-pipe" program to clone without installation (#48)
+  * Fix bug in alt-link regular expressions (#49)
+
+1.06
+  * Improve portability of `hostname` (#23)
+  * Fix incompatibilities between Cygwin and Git for Windows (#26)
+  * Allow Git program to be configured via yadm.git-program (#30)
+  * Support alt-links for encrypted files (#34)
+  * Exit with the same return value as Git (#35)
+  * Support spaces in alt-link paths (#36)
+  * Ignore empty lines in .yadm/encrypt (#40)
+  * Fix typos (#41)
+
+1.05
+  * Improve portability of shebang line (#14)
+  * Support for symlinked directories (#17)
+  * Improve portability of tar parameters (#18)
+  * Support alternate gpg program (#19)
+  * Fallback to using `ls` if `/bin/ls` does not exist (#22)
+
+1.04
+  * Support alternate paths for yadm data (#4, #5)
+  * Support asymmetric encryption (#7, #8)
+  * Prevent the mixing of output and gpg prompts
+
+1.03
+  * Add username matching for alternate files (#1)
+
+1.02
+  * Handle permissions for `~/.gnupg/*gpg`
+
+1.01
+  * Set `status.showUntrackedFiles` to "no"
+
+1.00
+  * Initial public release

CONTRIBUTORS

@@ -0,0 +1,52 @@
+CONTRIBUTORS
+
+Tim Byrne
+Erik Flodin
+Martin Zuther
+Jan Schulz
+Ross Smith II
+Jonathan Daigle
+Luis López
+Tin Lai
+Espen Henriksen
+Cameron Eagans
+Klas Mellbourn
+James Clark
+Glenn Waters
+Nicolas signed-log FORMICHELLA
+Tomas Cernaj
+Joshua Cold
+jonasc
+Nicolas stig124 FORMICHELLA
+Chad Wade Day, Jr
+Sébastien Gross
+David Mandelberg
+Paulo Köch
+Oren Zipori
+Daniel Gray
+Paraplegic Racehorse
+japm48
+Siôn Le Roux
+Mateusz Piotrowski
+Uroš Golja
+Satoshi Ohki
+Jonas
+Franciszek Madej
+Daniel Wagenknecht
+Stig Palmquist
+Patrick Hof
+con-f-use
+Samisafool
+Bram Ceulemans
+Travis A. Everett
+Sheng Yang
+Jared Smartt
+Adam Jimerson
+dessert1
+addshore
+Tim Condit
+Thomas Luzat
+Russ Allbery
+Brayden Banks
+Alexandre GV
+Felipe S. S. Schneider

LICENSE

@@ -1,14 +1,674 @@
-yadm - Yet Another Dotfiles Manager
-Copyright (C) 2015  Tim Byrne
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
 
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation, version 3 of the License.
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
 
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
+                            Preamble
 
-You should have received a copy of the GNU General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

Makefile

@@ -1,16 +1,215 @@
-all: yadm.md
+PYTESTS = $(wildcard test/test_*.py)
+IMAGE = docker.io/yadm/testbed:2022-01-07
+OCI = docker
+
+.PHONY: all
+all:
+	@$(MAKE) usage | less
+
+# Display usage for all make targets
+.PHONY: usage
+usage:
+	@echo
+	@echo 'make TARGET [option=value, ...]'
+	@echo
+	@echo 'TESTING'
+	@echo
+	@echo '  make test [testargs=ARGS]'
+	@echo '    - Run all tests. "testargs" can specify a single string of arguments'
+	@echo '      for py.test.'
+	@echo
+	@echo '  make <testfile>.py [testargs=ARGS]'
+	@echo '    - Run tests from a specific test file. "testargs" can specify a'
+	@echo '      single string of arguments for py.test.'
+	@echo
+	@echo '  make testhost [version=VERSION]'
+	@echo '    - Create an ephemeral container for doing adhoc yadm testing. The'
+	@echo '      working copy version of yadm will be used unless "version" is'
+	@echo '      specified. "version" can be set to any commit, branch, tag, etc.'
+	@echo '      The targeted "version" will be retrieved from the repo, and'
+	@echo '      linked into the container as a local volume.'
+	@echo
+	@echo '  make scripthost [version=VERSION]'
+	@echo '    - Create an ephemeral container for demonstrating a bug. After'
+	@echo '      exiting the shell, a log of the commands used to illustrate the'
+	@echo '      problem will be written to the file "script.txt". This file can'
+	@echo '      be useful to developers to make a repeatable test for the'
+	@echo '      problem. The version parameter works as for "testhost" above.'
+	@echo
+	@echo 'LINTING'
+	@echo
+	@echo '  make testenv'
+	@echo '    - Create a python virtual environment with the same dependencies'
+	@echo "      used by yadm's testbed environment. Creating and activating"
+	@echo '      this environment might be useful if your editor does real time'
+	@echo '      linting of python files. After creating the virtual environment,'
+	@echo '      you can activate it by typing:'
+	@echo
+	@echo '          source testenv/bin/activate'
+	@echo
+	@echo 'MANPAGES'
+	@echo
+	@echo '  make man'
+	@echo '    - View yadm.1 as a standard man page.'
+	@echo
+	@echo '  make man-wide'
+	@echo '    - View yadm.1 as a man page, using all columns of your display.'
+	@echo
+	@echo '  make man-ps'
+	@echo '    - Create a postscript version of the man page.'
+	@echo
+	@echo 'FILE GENERATION'
+	@echo
+	@echo '  make yadm.md'
+	@echo '    - Generate the markdown version of the man page (for viewing on'
+	@echo '      the web).'
+	@echo
+	@echo '  make contrib'
+	@echo '    - Generate the CONTRIBUTORS file, from the repo history.'
+	@echo
+	@echo 'INSTALLATION'
+	@echo
+	@echo '  make install PREFIX=<prefix>'
+	@echo '    - Install yadm, manpage, etc. to <prefix>'
+	@echo
+	@echo 'UTILITIES'
+	@echo
+	@echo '  make sync-clock'
+	@echo '    - Reset the hardware clock for the docker hypervisor host. This'
+	@echo '      can be useful for docker engine hosts which are not'
+	@echo '      Linux-based.'
+	@echo
+
+# Make it possible to run make specifying a py.test test file
+.PHONY: $(PYTESTS)
+$(PYTESTS):
+	@$(MAKE) test testargs="$@ $(testargs)"
+%.py:
+	@$(MAKE) test testargs="-k $@ $(testargs)"
+
+# Run all tests with additional testargs
+.PHONY: test
+test:
+	@if [ -f /.yadmtestbed ]; then \
+		cd /yadm && \
+		py.test -v $(testargs); \
+	else \
+		$(MAKE) -s require-docker && \
+		$(OCI) run \
+			--rm -t$(shell test -t 0 && echo i) \
+			-v "$(CURDIR):/yadm:ro" \
+			$(IMAGE) \
+			make test testargs="$(testargs)"; \
+	fi
+
+.PHONY: .testyadm
+.testyadm: version ?= local
+.testyadm:
+	@rm -f $@
+	@if [ "$(version)" = "local" ]; then \
+		ln -sf yadm $@; \
+		echo "Using local yadm ($$(git describe --tags --dirty))"; \
+	else \
+		git show $(version):yadm > $@; \
+		echo "Using yadm version $$(git describe --tags $(version))"; \
+	fi
+	@chmod a+x $@
+
+.PHONY: testhost
+testhost: require-docker .testyadm
+	@echo "Starting testhost"
+	@$(OCI) run \
+		-w /root \
+		--hostname testhost \
+		--rm -it \
+		-v "$(CURDIR)/.testyadm:/bin/yadm:ro" \
+		$(IMAGE) \
+		bash -l
+
+.PHONY: scripthost
+scripthost: require-docker .testyadm
+	@echo "Starting scripthost \(recording script\)"
+	@printf '' > script.gz
+	@$(OCI) run \
+		-w /root \
+		--hostname scripthost \
+		--rm -it \
+		-v "$(CURDIR)/script.gz:/script.gz:rw" \
+		-v "$(CURDIR)/.testyadm:/bin/yadm:ro" \
+		$(IMAGE) \
+		bash -c "script /tmp/script -q -c 'bash -l'; gzip < /tmp/script > /script.gz"
+	@echo
+	@echo "Script saved to $(CURDIR)/script.gz"
+
+
+.PHONY: testenv
+testenv:
+	@echo 'Creating a local virtual environment in "testenv/"'
+	@echo
+	@rm -rf testenv
+	python3 -m venv --clear testenv
+	testenv/bin/pip3 install --upgrade pip setuptools
+	testenv/bin/pip3 install --upgrade -r test/requirements.txt;
+	@for v in $$(sed -En -e 's:.*/yadm-([0-9.]+)$$:\1:p' test/Dockerfile); do \
+		git show $$v:yadm > testenv/bin/yadm-$$v; \
+		chmod +x testenv/bin/yadm-$$v; \
+	done
+	@echo
+	@echo 'To activate this test environment type:'
+	@echo '  source testenv/bin/activate'
+
+.PHONY: image
+image:
+	@$(OCI) build -f test/Dockerfile . -t "$(IMAGE)"
+
+
+.PHONY: man
+man:
+	@groff -man -Tascii ./yadm.1 | less
+
+.PHONY: man-wide
+man-wide:
+	@man ./yadm.1
+
+.PHONY: man-ps
+man-ps:
+	@groff -man -Tps ./yadm.1 > yadm.ps
 
 yadm.md: yadm.1
-	@groff -man -Tascii ./yadm.1 | col -bx | sed 's/^[A-Z]/## &/g' | sed '/yadm(1)/d' > yadm.md
+	@groff -man -Tutf8 -Z ./yadm.1 | grotty -c | col -bx | sed 's/^[A-Z]/## &/g' | sed '/yadm(1)/d' > yadm.md
 
-pdf:
-	@groff -man -Tps ./yadm.1 > yadm.ps
-	@open yadm.ps
-	@sleep 1
-	@rm yadm.ps
+.PHONY: contrib
+contrib: SHELL = /bin/bash
+contrib:
+	@echo -e "CONTRIBUTORS\n" > CONTRIBUTORS
+	@IFS=$$'\n'; for author in $$(git shortlog -ns master gh-pages develop dev-pages | cut -f2); do \
+		git log master gh-pages develop dev-pages \
+			--author="$$author" --format=tformat: --numstat | \
+			awk "{sum += \$$1 + \$$2} END {print sum \"\t\" \"$$author\"}"; \
+	done | sort -nr | cut -f2 >> CONTRIBUTORS
 
-man:
-	groff -man -Tascii ./yadm.1 | less
+.PHONY: install
+install:
+	@[ -n "$(PREFIX)" ] || { echo "PREFIX is not set"; exit 1; }
+	@{\
+		set -e                                               ;\
+		bin="$(DESTDIR)$(PREFIX)/bin"                        ;\
+		doc="$(DESTDIR)$(PREFIX)/share/doc/yadm"             ;\
+		man="$(DESTDIR)$(PREFIX)/share/man/man1"             ;\
+		install -d "$$bin" "$$doc" "$$man"                   ;\
+		install -m 0755 yadm "$$bin"                         ;\
+		install -m 0644 yadm.1 "$$man"                       ;\
+		install -m 0644 CHANGES CONTRIBUTORS LICENSE "$$doc" ;\
+		cp -r contrib "$$doc"                                ;\
+	}
 
-wide:
-	man ./yadm.1
+.PHONY: sync-clock
+sync-clock:
+	$(OCI) run --rm --privileged alpine hwclock -s
+
+.PHONY: require-docker
+require-docker:
+	@if ! command -v $(OCI) > /dev/null 2>&1; then \
+		echo "Sorry, this make target requires docker to be installed, to use another docker-compatible engine, like podman, re-run the make command adding OCI=podman"; \
+		false; \
+	fi

README.md

@@ -1,107 +1,87 @@
 # yadm - Yet Another Dotfiles Manager
-_A house that does not have one warm, comfy chair in it is soulless._ --May Sarton
 
-When you live in a command line, configurations are a deeply personal thing. They are often crafted over years of experience, battles lost, lessons learned, advice followed, and ingenuity rewarded. When you are away from your own configurations, you are an orphaned refugee in unfamiliar and hostile surroundings. You feel clumsy and out of sorts. You are filled with a sense of longing to be back in a place you know. A place you built. A place where all the short-cuts have been worn bare by your own travels. A place you proudly call... `$HOME`.
+[![Latest Version][releases-badge]][releases-link]
+[![Homebrew Version][homebrew-badge]][homebrew-link]
+[![OBS Version][obs-badge]][obs-link]
+[![Arch Version][arch-badge]][arch-link]
+[![License][license-badge]][license-link]<br />
+[![Master Update][master-date]][master-commits]
+[![Develop Update][develop-date]][develop-commits]
+[![Website Update][website-date]][website-commits]<br />
+[![Master Status][master-badge]][workflow-master]
+[![Develop Status][develop-badge]][workflow-develop]
+[![GH Pages Status][gh-pages-badge]][workflow-gh-pages]
+[![Dev Pages Status][dev-pages-badge]][workflow-dev-pages]
 
-## Introduction
-_Home is an invention on which no one has yet improved._ --Ann Douglas
+[https://yadm.io/][website-link]
 
-As so many others, I started out with a repository and a few scripts to symbolically link them around my home directory. This quickly became inadequate and I looked for solutions elsewhere. I've used two excellent tools; [homeschick](https://github.com/andsens/homeshick), and [vcsh](https://github.com/RichiH/vcsh). These tools are great, and you should check them out to understand their strengths. However, I didn't find all of the features I personally wished for in a single tool. **yadm** was written with the following goals:
+**yadm** is a tool for managing [dotfiles][].
 
-  - Use a single repository
-  - Few dependencies
-  - Ability to use alternate files based on OS or host
-  - Ability to encrypt and track confidential files
-  - Stay out of the way and let Git do what it's good at
+* Based on [Git][], with full range of Git's features
+* Supports system-specific alternative files or templated files
+* Encryption of private data using [GnuPG][], [OpenSSL][], [transcrypt][], or
+  [git-crypt][]
+* Customizable initialization (bootstrapping)
+* Customizable hooks for before and after any operation
 
-## Getting Started
-_I would not change my blest estate for all the world calls good or great._ --Isaac Watts
+Complete features, usage, examples and installation instructions can be found on
+the [yadm.io][website-link] website.
 
-If you know how to use Git, then you already know how to use **yadm**.
-See the [man page](yadm.md) for a comprehensive explanation of commands and options.
-
-
-#### If you don't currently have a repository
-Start out with an empty local repository
+## A very quick tour
 
+    # Initialize a new repository
     yadm init
+
+    # Clone an existing repository
+    yadm clone <url>
+
+    # Add files/changes
     yadm add <important file>
     yadm commit
 
-Eventually you will want to push the local repo to a remote.
+    # Encrypt your ssh key
+    echo '.ssh/id_rsa' > ~/.config/yadm/encrypt
+    yadm encrypt
 
-    yadm remote add origin <url>
-    yadm push -u origin master
+    # Later, decrypt your ssh key
+    yadm decrypt
 
-#### If you have an existing remote repository
-This `clone` will attempt to merge your existing repository, but if it fails, it will do a reset instead and you'll have to decide best on how resolve the differences.
+    # Create different files for Linux vs MacOS
+    yadm add path/file.cfg##os.Linux
+    yadm add path/file.cfg##os.Darwin
 
+If you enjoy using yadm, consider adding a star to the repository on GitHub.
+The star count helps others discover yadm.
 
-    yadm clone <url>
-    yadm status
-
-## Strategies for alternate files on different systems
-_To feel at home, stay at home._ --Clifton Fadiman
-
-Where possible, you should try to use the same file on every system. Here are a few examples:
-
-### .vimrc
-
-    let OS=substitute(system('uname -s'),"\n","","")
-    if (OS == "Darwin")
-      " do something that only makes sense on a Mac
-    endif
-
-### .tmux.conf
-
-    # use reattach-to-user-namespace as the default command on OSX
-    if-shell "test -f /usr/local/bin/reattach-to-user-namespace" 'set -g default-command "reattach-to-user-namespace -l bash"'
-
-### .bash_profile
-
-    system_type=$(uname -s)
-    if [ "$system_type" = "Darwin" ]; then
-      eval $(gdircolors $HOME/.dir_colors)
-    else
-      eval $(dircolors -b $HOME/.dir_colors)
-    fi
-
-However, sometimes the type of file you are using doesn't allow for this type of logic. If a configuration can do an "include", you can include a specific alternate version using **yadm**. Consider these three files:
-
-### .gitconfig
-
-    #---- .gitconfig -----------------
-    [log]
-      decorate = short
-      abbrevCommit = true
-    [include]
-      path = .gitconfig.local
-
-    #---- .gitconfig.local##Darwin ---
-    [user]
-      name = Tim Byrne
-      email = tim@personal.email.org
-
-    #---- .gitconfig.local##Linux ----
-    [user]
-      name = Dr. Tim Byrne
-      email = dr.byrne@work.email.com
-
-Configuring Git this way includes `.gitconfig.local` in the standard `.gitconfig`. **yadm** will automatically link the correct version based on the operation system. The bulk of your configurations can go in a single file, and you just put the exceptions in OS-specific files.
-
-Of course, you can use **yadm** to manage completely separate files for different systems as well.
-
-### .signature
-
-    #---- .signature##
-    - Tim
-    #---- .signature##Darwin.host1
-    Sent from my MacBook
-    - Tim
-    #---- .signature##Linux.host2
-    Sincerely,
-    Dr. Tim Byrne
-
-**yadm** will link the appropriate version for the current host, or use the default `##` version.
-
-<!-- vim: set spell lbr : -->
+[Git]: https://git-scm.com/
+[GnuPG]: https://gnupg.org/
+[OpenSSL]: https://www.openssl.org/
+[arch-badge]: https://img.shields.io/archlinux/v/extra/any/yadm
+[arch-link]: https://archlinux.org/packages/extra/any/yadm/
+[dev-pages-badge]: https://img.shields.io/github/actions/workflow/status/TheLocehiliosan/yadm/test.yml?branch=dev-pages
+[develop-badge]: https://img.shields.io/github/actions/workflow/status/TheLocehiliosan/yadm/test.yml?branch=develop
+[develop-commits]: https://github.com/TheLocehiliosan/yadm/commits/develop
+[develop-date]: https://img.shields.io/github/last-commit/TheLocehiliosan/yadm/develop.svg?label=develop
+[dotfiles]: https://en.wikipedia.org/wiki/Hidden_file_and_hidden_directory
+[gh-pages-badge]: https://img.shields.io/github/actions/workflow/status/TheLocehiliosan/yadm/test.yml?branch=gh-pages
+[git-crypt]: https://github.com/AGWA/git-crypt
+[homebrew-badge]: https://img.shields.io/homebrew/v/yadm.svg
+[homebrew-link]: https://formulae.brew.sh/formula/yadm
+[license-badge]: https://img.shields.io/github/license/TheLocehiliosan/yadm.svg
+[license-link]: https://github.com/TheLocehiliosan/yadm/blob/master/LICENSE
+[master-badge]: https://img.shields.io/github/actions/workflow/status/TheLocehiliosan/yadm/test.yml?branch=master
+[master-commits]: https://github.com/TheLocehiliosan/yadm/commits/master
+[master-date]: https://img.shields.io/github/last-commit/TheLocehiliosan/yadm/master.svg?label=master
+[obs-badge]: https://img.shields.io/badge/OBS-v3.2.2-blue
+[obs-link]: https://software.opensuse.org//download.html?project=home%3ATheLocehiliosan%3Ayadm&package=yadm
+[releases-badge]: https://img.shields.io/github/tag/TheLocehiliosan/yadm.svg?label=latest+release
+[releases-link]: https://github.com/TheLocehiliosan/yadm/releases
+[transcrypt]: https://github.com/elasticdog/transcrypt
+[travis-ci]: https://travis-ci.com/TheLocehiliosan/yadm/branches
+[website-commits]: https://github.com/TheLocehiliosan/yadm/commits/gh-pages
+[website-date]: https://img.shields.io/github/last-commit/TheLocehiliosan/yadm/gh-pages.svg?label=website
+[website-link]: https://yadm.io/
+[workflow-dev-pages]: https://github.com/thelocehiliosan/yadm/actions?query=workflow%3a%22test+site%22+branch%3adev-pages
+[workflow-develop]: https://github.com/TheLocehiliosan/yadm/actions?query=workflow%3ATests+branch%3Adevelop
+[workflow-gh-pages]: https://github.com/thelocehiliosan/yadm/actions?query=workflow%3a%22test+site%22+branch%3agh-pages
+[workflow-master]: https://github.com/TheLocehiliosan/yadm/actions?query=workflow%3ATests+branch%3Amaster

bootstrap

@@ -0,0 +1,133 @@
+#!/bin/bash
+
+#
+# This script can be "curl-piped" into bash to bootstrap a dotfiles repo when
+# yadm is not locally installed. Read below for instructions.
+#
+# This script is hosted at bootstrap.yadm.io to make it easy to remember/type.
+#
+# DISCLAIMER: In general, I would advise against piping someone's code directly
+#             from the Internet into an interpreter (like Bash). You should
+#             probably review any code like this prior to executing it. I leave
+#             it to you to decide if this is risky behavior or not. The main
+#             reason this script exists is because I find it to be a pragmatic
+#             way to bootstrap my dotfiles, and install yadm in one step
+#             (allowing the yadm project to be a submodule of my dotfiles
+#             repo).
+#
+# Invoke bootstrap with:
+#
+#   curl -L bootstrap.yadm.io | bash
+#
+#     OR
+#
+#   curl -L bootstrap.yadm.io | bash [-s -- REPO_URL [YADM_RELEASE]]
+#
+# Alternatively, source in this file to export a yadm() function which uses
+# yadm remotely until it is locally installed.
+#
+#   source <(curl -L bootstrap.yadm.io)
+#
+
+YADM_REPO="https://github.com/TheLocehiliosan/yadm"
+YADM_RELEASE=${release:-master}
+REPO_URL=""
+
+function _private_yadm() {
+  unset -f yadm
+  if command -v yadm &> /dev/null; then
+    echo "Found yadm installed locally, removing remote yadm() function"
+    unset -f _private_yadm
+    command yadm "$@"
+  else
+    function yadm() { _private_yadm "$@"; }; export -f yadm
+    echo WARNING: Using yadm remotely. You should install yadm locally.
+    curl -fsSL "$YADM_REPO/raw/$YADM_RELEASE/yadm" | bash -s -- "$@"
+  fi
+}
+export -f _private_yadm
+function yadm() { _private_yadm "$@"; }; export -f yadm
+
+# if being sourced, return here, otherwise continue processing
+return 2>/dev/null
+unset -f yadm
+
+function remote_yadm() {
+  curl -fsSL "$YADM_REPO/raw/$YADM_RELEASE/yadm" | bash -s -- "$@"
+}
+
+function ask_about_source() {
+  if ! command -v yadm &> /dev/null; then
+    echo
+    echo "***************************************************"
+    echo "yadm is NOT currently installed."
+    echo "You should install it locally, this link may help:"
+    echo "https://yadm.io/docs/install"
+    echo "***************************************************"
+    echo
+    echo "If installation is not possible right now, you can temporarily \"source\""
+    echo "in a yadm() function which fetches yadm remotely each time it is called."
+    echo
+    echo "    source <(curl -L bootstrap.yadm.io)"
+    echo
+  fi
+}
+
+function build_url() {
+  echo "No repo URL provided."
+  echo
+  echo "Where is your repo?"
+  echo
+  echo "  1. GitHub"
+  echo "  2. Bitbucket"
+  echo "  3. GitLab"
+  echo "  4. Other"
+  echo
+  read -r -p "Where is your repo? (1/2/3/4) ->" choice < /dev/tty
+  case $choice in
+    1)
+      REPO_URL="https://github.com/"
+      ;;
+    2)
+      REPO_URL="https://bitbucket.org/"
+      ;;
+    3)
+      REPO_URL="https://gitlab.com/"
+      ;;
+    *)
+      echo
+      echo Please specify the full URL of your dotfiles repo
+      read -r -p "URL ->" choice < /dev/tty
+      REPO_URL="$choice"
+      return
+      ;;
+  esac
+
+  echo
+  echo "Provide your user and repo separated by '/'"
+  echo "For example: UserName/dotfiles"
+  echo
+  read -r -p "User/Repo ->" choice < /dev/tty
+  [[ "$choice" =~ ^[^[:space:]]+/[^[:space:]]+$ ]] || {
+    echo "Not formatted as USER/REPO"
+    REPO_URL=
+    return
+  }
+  REPO_URL="${REPO_URL}${choice}.git"
+}
+
+function main() {
+
+  [ -n "$1" ] && REPO_URL="$1"
+  [ -n "$2" ] && YADM_RELEASE="$2"
+  [ -z "$REPO_URL" ] && build_url
+  [ -z "$REPO_URL" ] && echo "Unable to determine the repo URL" && exit 1
+
+  echo "Using URL: $REPO_URL"
+  remote_yadm clone "$REPO_URL"
+
+  ask_about_source
+
+}
+
+main "$@"

completion/README.md

@@ -0,0 +1,47 @@
+# Installation
+
+### Prerequisites
+
+Bash and Zsh completion only works if Git completions are also enabled.
+
+## Homebrew
+
+If using `homebrew` to install yadm, Bash, Zsh, and Fish completions should
+automatically be installed. For Bash and Zsh, you also must install
+`bash-completion` or `zsh-completions`. This might require you to include the
+main completion script in your own shell configuration like this:
+
+```bash
+[ -f /usr/local/etc/bash_completion ] && source /usr/local/etc/bash_completion
+```
+
+## Bash (manual installation)
+
+Copy the completion script locally, and add this to you bashrc:
+
+```bash
+[ -f /path/to/yadm/completion/bash/yadm ] && source /path/to/yadm/completion/bash/yadm
+```
+
+## Zsh (manual installation)
+
+Add the `completion/zsh` folder to `$fpath` in `.zshrc`:
+
+```zsh
+fpath=(/path/to/yadm/completion/zsh $fpath)
+autoload -U compinit
+compinit
+```
+
+## Zsh (using [zplug](https://github.com/b4b4r07/zplug))
+
+Load `_yadm` as a plugin in your `.zshrc`:
+
+```zsh
+fpath=("$ZPLUG_HOME/bin" $fpath)
+zplug "TheLocehiliosan/yadm", use:"completion/zsh/_yadm", as:command, defer:2
+```
+
+## Fish (manual installation)
+
+Copy the completion script `yadm.fish` to any folder within `$fish_complete_path`. For example, for local installation, you can copy it to `$HOME/.config/fish/completions/` and it will be loaded when `yadm` is invoked.

completion/bash/yadm

@@ -0,0 +1,111 @@
+# test if git completion is missing, but loader exists, attempt to load
+if ! declare -F _git > /dev/null && ! declare -F __git_wrap__git_main > /dev/null; then
+  if declare -F _completion_loader > /dev/null; then
+    _completion_loader git
+  fi
+fi
+
+# only operate if git completion is present
+if declare -F _git > /dev/null || declare -F __git_wrap__git_main > /dev/null; then
+
+  _yadm() {
+
+    local current=${COMP_WORDS[COMP_CWORD]}
+    local penultimate
+    if [ "$((COMP_CWORD-1))" -ge "0" ]; then
+      penultimate=${COMP_WORDS[COMP_CWORD-1]}
+    fi
+    local antepenultimate
+    if [ "$((COMP_CWORD-2))" -ge "0" ]; then
+      antepenultimate=${COMP_WORDS[COMP_CWORD-2]}
+    fi
+
+    local -x GIT_DIR
+    # shellcheck disable=SC2034
+    GIT_DIR="$(yadm introspect repo 2>/dev/null)"
+
+    case "$penultimate" in
+      bootstrap)
+        COMPREPLY=()
+        return 0
+      ;;
+      config)
+        COMPREPLY=( $(compgen -W "$(yadm introspect configs 2>/dev/null)") )
+        return 0
+		  ;;
+      decrypt)
+        COMPREPLY=( $(compgen -W "-l" -- "$current") )
+        return 0
+		  ;;
+      init)
+        COMPREPLY=( $(compgen -W "-f -w" -- "$current") )
+        return 0
+		  ;;
+      introspect)
+        COMPREPLY=( $(compgen -W "commands configs repo switches" -- "$current") )
+        return 0
+		  ;;
+      help)
+        COMPREPLY=() # no specific help yet
+        return 0
+      ;;
+      list)
+        COMPREPLY=( $(compgen -W "-a" -- "$current") )
+        return 0
+		  ;;
+    esac
+
+    case "$antepenultimate" in
+      clone)
+        COMPREPLY=( $(compgen -W "-f -w -b --bootstrap --no-bootstrap" -- "$current") )
+        return 0
+		  ;;
+    esac
+
+    local yadm_switches=( $(yadm introspect switches 2>/dev/null) )
+
+    # this condition is so files are completed properly for --yadm-xxx options
+    if [[ " ${yadm_switches[*]} " != *" $penultimate "* ]]; then
+      # TODO: somehow solve the problem with [--yadm-xxx option] being
+      #       incompatible with what git expects, namely [--arg=option]
+      if declare -F _git > /dev/null; then
+        _git
+      else
+        __git_wrap__git_main
+      fi
+    fi
+    if [[ "$current" =~ ^- ]]; then
+      local matching
+      matching=$(compgen -W "${yadm_switches[*]}" -- "$current")
+      __gitcompappend "$matching"
+    fi
+
+    # Find the index of where the sub-command argument should go.
+    local command_idx
+    for (( command_idx=1 ; command_idx < ${#COMP_WORDS[@]} ; command_idx++ )); do
+      local command_idx_arg="${COMP_WORDS[$command_idx]}"
+      if [[ " ${yadm_switches[*]} " = *" $command_idx_arg "* ]]; then
+        let command_idx++
+      elif [[ "$command_idx_arg" = -* ]]; then
+        :
+      else
+        break
+      fi
+    done
+    if [[ "$COMP_CWORD" = "$command_idx" ]]; then
+      local matching
+      matching=$(compgen -W "$(yadm introspect commands 2>/dev/null)" -- "$current")
+      __gitcompappend "$matching"
+    fi
+
+    # remove duplicates found in COMPREPLY (a native bash way could be better)
+    if [ -n "${COMPREPLY[*]}" ]; then
+      COMPREPLY=($(echo "${COMPREPLY[@]}" | sort -u))
+    fi
+
+  }
+
+	complete -o bashdefault -o default -F _yadm yadm 2>/dev/null \
+		|| complete -o default -F _yadm yadm
+
+fi

completion/fish/yadm.fish

@@ -0,0 +1,77 @@
+#!/usr/bin/fish
+
+function __fish_yadm_universial_optspecs
+    string join \n 'a-yadm-dir=' 'b-yadm-repo=' 'c-yadm-config=' \
+                    'd-yadm-encrypt=' 'e-yadm-archive=' 'f-yadm-bootstrap='
+end
+
+function __fish_yadm_needs_command
+    # Figure out if the current invocation already has a command.
+    set -l cmd (commandline -opc)
+    set -e cmd[1]
+    argparse -s (__fish_yadm_universial_optspecs) -- $cmd 2>/dev/null
+    or return 0
+    if set -q argv[1]
+        echo $argv[1]
+        return 1
+    end
+    return 0
+end
+
+function __fish_yadm_using_command
+    set -l cmd (__fish_yadm_needs_command)
+    test -z "$cmd"
+    and return 1
+    contains -- $cmd $argv
+    and return 0
+end
+
+# yadm's specific autocomplete
+complete -x -c yadm -n '__fish_yadm_needs_command'       -a 'clone'      -d 'Clone an existing repository'
+complete -F -c yadm -n '__fish_yadm_using_command clone' -s w            -d 'work-tree to use (default: $HOME)'
+complete -f -c yadm -n '__fish_yadm_using_command clone' -s b            -d 'branch to clone'
+complete -x -c yadm -n '__fish_yadm_using_command clone' -s f            -d 'force to overwrite'
+complete -x -c yadm -n '__fish_yadm_using_command clone' -l bootstrap    -d 'force bootstrap to run'
+complete -x -c yadm -n '__fish_yadm_using_command clone' -l no-bootstrap -d 'prevent bootstrap from beingrun'
+
+complete -x -c yadm -n '__fish_yadm_needs_command' -a 'alt'       -d 'Create links for alternates'
+complete -x -c yadm -n '__fish_yadm_needs_command' -a 'bootstrap' -d 'Execute $HOME/.config/yadm/bootstrap'
+complete -x -c yadm -n '__fish_yadm_needs_command' -a 'perms'     -d 'Fix perms for private files'
+complete -x -c yadm -n '__fish_yadm_needs_command' -a 'enter'     -d 'Run sub-shell with GIT variables set'
+complete    -c yadm -n '__fish_yadm_needs_command' -a 'git-crypt' -d 'Run git-crypt commands for the yadm repo'
+complete -x -c yadm -n '__fish_yadm_needs_command' -a 'help'      -d 'Print a summary of yadm commands'
+complete -x -c yadm -n '__fish_yadm_needs_command' -a 'upgrade'   -d 'Upgrade to version 2 of yadm directory structure'
+complete -x -c yadm -n '__fish_yadm_needs_command' -a 'version'   -d 'Print the version of yadm'
+
+complete -x -c yadm -n '__fish_yadm_needs_command' -a 'init' -d 'Initialize an empty repository'
+complete -x -c yadm -n '__fish_yadm_using_command init' -s f -d 'force to overwrite'
+complete -F -c yadm -n '__fish_yadm_using_command init' -s w -d 'set work-tree (default: $HOME)'
+
+complete -x -c yadm -n '__fish_yadm_needs_command' -a 'list' -d 'List tracked files at current directory'
+complete -x -c yadm -n '__fish_yadm_using_command list' -s a -d 'list all managed files instead'
+
+complete -x -c yadm -n '__fish_yadm_needs_command' -a 'encrypt' -d 'Encrypt files'
+complete -x -c yadm -n '__fish_yadm_needs_command' -a 'decrypt' -d 'Decrypt files'
+complete -x -c yadm -n '__fish_yadm_using_command decrypt' -s l -d 'list the files stored without extracting'
+
+complete -x -c yadm -n '__fish_yadm_needs_command' -a 'introspect' -d 'Report internal yadm data'
+complete -x -c yadm -n '__fish_yadm_using_command introspect' -a (printf -- '%s\n' 'commands configs repo switches') -d 'category'
+
+complete -x -c yadm -n '__fish_yadm_needs_command' -a 'gitconfig' -d 'Pass options to the git config command'
+complete -x -c yadm -n '__fish_yadm_needs_command' -a 'config'    -d 'Configure a setting'
+for name in (yadm introspect configs)
+    complete -x -c yadm -n '__fish_yadm_using_command config' -a '$name' -d 'yadm config'
+end
+
+# yadm universial options
+complete --force-files -c yadm -s Y -l yadm-dir       -d 'Override location of yadm directory'
+complete --force-files -c yadm      -l yadm-repo      -d 'Override location of yadm repository'
+complete --force-files -c yadm      -l yadm-config    -d 'Override location of yadm configuration file'
+complete --force-files -c yadm      -l yadm-encrypt   -d 'Override location of yadm encryption configuration'
+complete --force-files -c yadm      -l yadm-archive   -d 'Override location of yadm encrypted files archive'
+complete --force-files -c yadm      -l yadm-bootstrap -d 'Override location of yadm bootstrap program'
+
+# wraps git's autocomplete
+set -l GIT_DIR (yadm introspect repo)
+# setup the correct git-dir by appending it to git's argunment
+complete -c yadm -w "git --git-dir=$GIT_DIR"

completion/zsh/_yadm

@@ -0,0 +1,180 @@
+#compdef yadm
+
+# This completion tries to fallback to git's completion for git commands.
+
+zstyle -T ':completion:*:yadm:argument-1:descriptions:' format && \
+    zstyle ':completion:*:yadm:argument-1:descriptions' format '%d:'
+zstyle -T ':completion:*:yadm:*:yadm' group-name && \
+    zstyle ':completion:*:yadm:*:yadm' group-name ''
+
+function _yadm-add(){
+  local -a yadm_options yadm_path
+  yadm_path="$(yadm rev-parse --show-toplevel)"
+  yadm_options=($(yadm status --porcelain=v1 |
+    awk -v yadm_path=${yadm_path} '{printf "%s/%s:%s\n",  yadm_path, $2, $1}' ))
+
+  _describe 'command' yadm_options
+  _files
+}
+
+function _yadm-checkout(){
+    _yadm-add
+}
+
+_yadm-alt() {
+    return 0
+}
+
+_yadm-bootstrap() {
+    return 0
+}
+
+_yadm-clone() {
+    _arguments \
+        '(--bootstrap --no-bootstrap)--bootstrap[force bootstrap, without prompt]' \
+        '(--bootstrap --no-bootstrap)--no-bootstrap[prevent bootstrap, without prompt]' \
+        '-f[force overwrite of existing repository]' \
+        '-w[yadm work tree path]: :_files -/'
+
+    local curcontext="${curcontext%:*:*}:git:"
+
+    words=("git" "${words[@]}") CURRENT=$((CURRENT + 1)) service=git _git
+}
+
+_yadm-config() {
+    # TODO: complete config names
+}
+
+_yadm-decrypt() {
+    _arguments \
+        '-l[list files]'
+}
+
+_yadm-encrypt() {
+    return 0
+}
+
+_yadm-enter() {
+    _arguments \
+        ':command: _command_names -e' \
+        '*::arguments: _normal'
+}
+
+_yadm-git-crypt() {
+    # TODO: complete git-crypt options
+}
+
+_yadm-help() {
+    return 0
+}
+
+_yadm-init() {
+    _arguments \
+        '-f[force overwrite of existing repository]' \
+        '-w[work tree path]: :_files -/'
+}
+
+_yadm-list() {
+    _arguments \
+        '-a[list all tracked files]'
+}
+
+_yadm-perms() {
+    return 0
+}
+
+_yadm-transcrypt() {
+    integer _ret=1
+    _call_function _ret _transcrypt
+    return _ret
+}
+
+_yadm-upgrade() {
+    _arguments \
+        '-f[force deinit of submodules]' \
+        ': '
+}
+
+_yadm-version() {
+    return 0
+}
+
+_yadm_commands() {
+    local -a commands=(
+        alt:'create links for alternates'
+        bootstrap:'execute bootstrap'
+        clone:'clone an existing yadm repository'
+        config:'configure an yadm setting'
+        decrypt:'decrypt files'
+        encrypt:'encrypt files'
+        enter:'run sub-shell with GIT variables set'
+        git-crypt:'run git-crypt commands for the yadm repository'
+        gitconfig:'run the git config command'
+        help:'display yadm help information'
+        init:'initialize an empty yadm repository'
+        list:'list files tracked by yadm'
+        perms:'fix perms for private files'
+        transcrypt:'run transcrypt commands for the yadm repository'
+        upgrade:'upgrade legacy yadm paths'
+        version:'show yadm version'
+    )
+
+    local oldcontext="$curcontext"
+    local curcontext="${curcontext%:*:*}:git:"
+
+    words=("git" "${words[-1]}") CURRENT=2 service=git _git
+
+    curcontext="$oldcontext"
+    _describe -t yadm "yadm commands" commands
+
+    return 0
+}
+
+_yadm() {
+    local curcontext=$curcontext state state_descr line
+    declare -A opt_args
+
+    _arguments -C \
+      '(-Y --yadm-dir)'{-Y,--yadm-dir}'[override the standard yadm directory]: :_files -/' \
+      '--yadm-data[override the standard yadm data directory]: :_files -/' \
+      '--yadm-repo[override the standard repo path]: :_files -/' \
+      '--yadm-config[override the standard config path]: :_files -/' \
+      '--yadm-encrypt[override the standard encrypt path]: :_files -/' \
+      '--yadm-archive[override the standard archive path]: :_files -/' \
+      '--yadm-bootstrap[override the standard bootstrap path]: :_files' \
+      '--help[display yadm help information]' \
+      '--version[show yadm version]' \
+      '(-): :->command' \
+      '(-)*:: :->option-or-argument' && return
+
+    local -a repo_args
+    (( $+opt_args[--yadm-repo] )) && repo_args+=(--yadm-repo "$opt_args[--yadm-repo]")
+    (( $+opt_args[--yadm-data] )) && repo_args+=(--yadm-data "$opt_args[--yadm-data]")
+    local -x GIT_DIR="$(_call_program gitdir yadm "${repo_args[@]}" introspect repo)"
+    [[ -z "$GIT_DIR" ]] && return 1
+
+    integer _ret=1
+    case $state in
+        (command)
+            _yadm_commands && _ret=0
+            ;;
+        (option-or-argument)
+            curcontext=${curcontext%:*:*}:yadm-${words[1]}:
+            if ! _call_function _ret _yadm-${words[1]}; then
+
+                # Translate gitconfig to use the regular completion for config
+                [[ ${words[1]} = "gitconfig" ]] && words[1]=config
+
+                words=("git" "${(@)words}")
+                CURRENT=$(( CURRENT + 1 ))
+
+                curcontext=${curcontext%:*:*}:git:
+                service=git _git && _ret=0
+            fi
+            ;;
+    esac
+
+    return _ret
+}
+
+(( $+functions[_git] )) && _yadm

contrib/bootstrap/bootstrap-in-dir

@@ -0,0 +1,24 @@
+#!/bin/bash
+
+# Save this file as ~/.config/yadm/bootstrap and make it executable. It will
+# execute all executable files (excluding templates and editor backups) in the
+# ~/.config/yadm/bootstrap.d directory when run.
+
+set -eu
+
+# Directory to look for bootstrap executables in
+BOOTSTRAP_D="${BASH_SOURCE[0]}.d"
+
+if [[ ! -d "$BOOTSTRAP_D" ]]; then
+    echo "Error: bootstrap directory '$BOOTSTRAP_D' not found" >&2
+    exit 1
+fi
+
+find -L "$BOOTSTRAP_D" -type f | sort | while IFS= read -r bootstrap; do
+    if [[ -x "$bootstrap" && ! "$bootstrap" =~ "##" && ! "$bootstrap" =~ "~$" ]]; then
+        if ! "$bootstrap"; then
+            echo "Error: bootstrap '$bootstrap' failed" >&2
+            exit 1
+        fi
+    fi
+done

contrib/commands/README.md

@@ -0,0 +1,9 @@
+## Contributed Commands
+
+Although these commands are available as part of the official
+**yadm** source tree, they have a somewhat different status. The intention is to
+keep interesting and potentially useful commands here, building a library of
+examples that might help others.
+
+I recommend *careful review* of any code from here before using it. No
+guarantees of code quality is assumed.

contrib/commands/yadm-untracked

@@ -0,0 +1,71 @@
+#!/usr/bin/env bash
+
+# To run: `yadm-untracked <config-file>`
+#
+# If you wish to create a YADM alias to run this as, for example `yadm untracked`
+# then the following command will add the alias:
+#     `yadm gitconfig alias.untracked '!<PATH>/yadm-untracked'`
+
+# Possible script improvements:
+# - Reduce the amount of configuration; I have not figured out a way to
+#   get rid of the non-recursive and ignore. The recursive list could be
+#   built from the directories that are present in `yadm list`
+
+# Configuration... The script looks at the following 3 arrays:
+#
+# yadm_tracked_recursively
+#     The directories and files in this list are searched recursively to build
+#     a list of files that you expect are tracked with `yadm`. Items in this
+#     list are relative to the root of your YADM repo (which is $HOME for most).
+
+# yadm_tracked_nonrecursively
+#     Same as above but don't search recursively
+#
+# ignore_files_and_dirs
+#     A list of directories and files that will not be reported as untracked if
+#     found in the above two searches.
+#
+# Example configuration file (uncomment it to use):
+# yadm_tracked_recursively=(
+#     bin .config .vim
+# )
+#
+# yadm_tracked_nonrecursively=(
+#     ~
+# )
+#
+# ignore_files_and_dirs=(
+#     .CFUserTextEncoding .DS_Store .config/gh
+#     .vim/autoload/plug.vim
+# )
+
+if [[ $# -ne 1 ]]; then
+    echo 'Usage: yadm-untracked <config-file>'
+    exit 1
+fi
+
+yadm_tracked_recursively=()
+yadm_tracked_nonrecursively=()
+ignore_files_and_dirs=()
+
+source $1
+
+root=`yadm enter echo '$GIT_WORK_TREE'`
+
+cd $root
+
+find_list=$(mktemp -t find_list)
+find ${yadm_tracked_recursively[*]} -type f >$find_list
+find ${yadm_tracked_nonrecursively[*]} -maxdepth 1 -type f |
+  awk "{sub(\"^\./\", \"\"); sub(\"^$root/\", \"\"); print }" >>$find_list
+sort -o $find_list $find_list
+
+yadm_list=$(mktemp -t yadm_list)
+yadm list >$yadm_list
+find ${ignore_files_and_dirs[*]} -type f >>$yadm_list
+sort -o $yadm_list $yadm_list
+
+# Show the files not in `yadm list`
+comm -23 $find_list $yadm_list
+
+rm -f $find_list $yadm_list

contrib/hooks/README.md

@@ -0,0 +1,14 @@
+## Contributed Hooks
+
+Although these [hooks][hooks-help] are available as part of the official
+**yadm** source tree, they have a somewhat different status. The intention is to
+keep interesting and potentially useful hooks here, building a library of
+examples that might help others.
+
+In some cases, an experimental new feature can be build entirely with hooks, and
+this is a place to share it.
+
+I recommend *careful review* of any code from here before using it. No
+guarantees of code quality is assumed.
+
+[hooks-help]: https://github.com/TheLocehiliosan/yadm/blob/master/yadm.md#hooks

contrib/hooks/encrypt_with_checksums/README.md

@@ -0,0 +1,9 @@
+## Track checksums of encrypted files
+
+Contributed by Martin Zuther
+
+Hook         | Description
+----         | -----------
+post_encrypt | Collects the checksums of encrypted files, and stores them in .config/yadm/files.checksums
+post_list    | Prints the names of encrypted files
+post_status  | Reports untracked changes within encrypted files

contrib/hooks/encrypt_with_checksums/post_encrypt

@@ -0,0 +1,96 @@
+#!/usr/bin/env bash
+
+# yadm - Yet Another Dotfiles Manager
+# Copyright (C) 2015-2021 Tim Byrne and Martin Zuther
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+
+YADM_CHECKSUMS="$YADM_HOOK_DIR/files.checksums"
+WARNING_MESSAGE="No checksums were created"
+
+# unpack exported array; filenames including a newline character (\n)
+# are NOT supported
+OLD_IFS="$IFS"
+IFS=$'\n'
+YADM_ENCRYPT_INCLUDE_FILES=( $YADM_ENCRYPT_INCLUDE_FILES )
+IFS="$OLD_IFS"
+
+
+function get_checksum_command {
+    # check if "shasum" exists and supports the algorithm (which is
+    # tested by sending an empty string to "shasum")
+    if command -v "shasum" > /dev/null && printf "" | shasum --algorithm "256" &> /dev/null; then
+        printf "shasum --algorithm 256"
+    # check if "sha256sum" exists
+    elif command -v "sha256sum" > /dev/null; then
+        printf "sha256sum"
+    # check if "gsha256sum" exists
+    elif command -v "gsha256sum" > /dev/null; then
+        printf "gsha256sum"
+    else
+        # display warning in bright yellow
+        printf "\033[1;33m" >&2
+        printf "\nWARNING: \"shasum\", \"sha256sum\" and \"gsha256sum\" not found.   %s\n" "$WARNING_MESSAGE." >&2
+
+        # reset output color
+        printf "\033[0m" >&2
+
+        # signal error
+        return 1
+    fi
+}
+
+
+# get checksum command
+CHECKSUM_COMMAND=$(get_checksum_command)
+
+# no command found
+if (($?)); then
+    # return original exit status of yadm command
+    exit "$YADM_HOOK_EXIT"
+fi
+
+# empty (or create) checksum file
+true > "$YADM_CHECKSUMS"
+
+# calculate checksums for encrypted files
+for included in "${YADM_ENCRYPT_INCLUDE_FILES[@]}"; do
+    # highlight any errors in red
+    printf "\033[0;31m"
+
+    # calculate checksums
+    $CHECKSUM_COMMAND "$included" >> "$YADM_CHECKSUMS"
+    ERROR_CODE=$?
+
+    # reset output color
+    printf "\033[0m"
+
+    # handle errors
+    if (($ERROR_CODE)); then
+        # display warning in bright yellow
+        printf "\033[1;33m" >&2
+        printf "\nWARNING: an error occurred.  Please inspect the checksum file.\n" >&2
+
+        # reset output color
+        printf "\033[0m" >&2
+
+        # exit and signal error
+        exit $ERROR_CODE
+    fi
+done
+
+# announce success and return original exit status of yadm command
+printf "Wrote SHA-256 checksums: %s\n" "$YADM_CHECKSUMS"
+exit "$YADM_HOOK_EXIT"

contrib/hooks/encrypt_with_checksums/post_list

@@ -0,0 +1,69 @@
+#!/usr/bin/env bash
+
+# yadm - Yet Another Dotfiles Manager
+# Copyright (C) 2015-2021 Tim Byrne and Martin Zuther
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+YADM_CHECKSUMS="$YADM_HOOK_DIR/files.checksums"
+
+
+# is current directory on yadm's work path?
+# (adapted from https://unix.stackexchange.com/a/6438/122163)
+if [ "${PWD##$YADM_HOOK_WORK}" != "$PWD" ]; then
+    ON_WORK_PATH=1
+else
+    ON_WORK_PATH=0
+fi
+
+
+# list all files or only those in the subdirectories below?
+OPTION_LIST_ALL=0
+for argument in "${YADM_HOOK_FULL_COMMAND[@]}"; do
+    # mimick git ls-files by displaying all files when not on work
+    # path
+    if [ "$argument" = "-a" ] || [ $ON_WORK_PATH -eq 0 ]; then
+        OPTION_LIST_ALL=1
+        break
+    fi
+done
+
+
+# if there is no checksum file, exit with original status of yadm
+# command
+if [ ! -f "$YADM_CHECKSUMS" ]; then
+    exit "$YADM_HOOK_EXIT"
+fi
+
+# list encrypted files
+while IFS= read -r filename; do
+    # remove checksums from file names
+    filename="${filename##[a-zA-Z0-9]* }"
+
+    # list only files in the subdirectories below (i.e. files
+    # whose relative path doesn't begin with "../")
+    if [ $OPTION_LIST_ALL -eq 0 ]; then
+        REL_PATH=$(relative_path "$PWD" "$YADM_HOOK_WORK/$filename")
+
+        if [ "$REL_PATH" = "${REL_PATH##../}" ]; then
+            printf "%s\n" "$REL_PATH"
+        fi
+    # list all files
+    else
+        printf "%s\n" "$filename"
+    fi
+done < "$YADM_CHECKSUMS"
+
+# return original exit status of yadm command
+exit "$YADM_HOOK_EXIT"

contrib/hooks/encrypt_with_checksums/post_status

@@ -0,0 +1,100 @@
+#!/usr/bin/env bash
+
+# yadm - Yet Another Dotfiles Manager
+# Copyright (C) 2015-2021 Tim Byrne and Martin Zuther
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+
+YADM_CHECKSUMS="$YADM_HOOK_DIR/files.checksums"
+WARNING_MESSAGE="Checksums were not verified"
+
+# unpack exported array; filenames including a newline character (\n)
+# are NOT supported
+OLD_IFS="$IFS"
+IFS=$'\n'
+YADM_ENCRYPT_INCLUDE_FILES=( $YADM_ENCRYPT_INCLUDE_FILES )
+IFS="$OLD_IFS"
+
+
+function get_checksum_command {
+    # check if "shasum" exists and supports the algorithm (which is
+    # tested by sending an empty string to "shasum")
+    if command -v "shasum" > /dev/null && printf "" | shasum --algorithm "256" &> /dev/null; then
+        printf "shasum --algorithm 256"
+    # check if "sha256sum" exists
+    elif command -v "sha256sum" > /dev/null; then
+        printf "sha256sum"
+    # check if "gsha256sum" exists
+    elif command -v "gsha256sum" > /dev/null; then
+        printf "gsha256sum"
+    else
+        # display warning in bright yellow
+        printf "\033[1;33m" >&2
+        printf "\nWARNING: \"shasum\", \"sha256sum\" and \"gsha256sum\" not found.   %s\n" "$WARNING_MESSAGE." >&2
+
+        # reset output color
+        printf "\033[0m" >&2
+
+        # signal error
+        return 1
+    fi
+}
+
+
+# if there is no checksum file, exit with original status of yadm
+# command
+if [ ! -f "$YADM_CHECKSUMS" ]; then
+    exit "$YADM_HOOK_EXIT"
+fi
+
+# get checksum command
+CHECKSUM_COMMAND=$(get_checksum_command)
+
+# no command found
+if (($?)); then
+    # return original exit status of yadm command
+    exit "$YADM_HOOK_EXIT"
+fi
+
+# check encrypted files for differences and capture output and error
+# messages
+YADM_CHECKSUM_OUTPUT=$($CHECKSUM_COMMAND --check "$YADM_CHECKSUMS" 2>&1)
+ERROR_CODE=$?
+
+# handle mismatched checksums and errors
+if (($ERROR_CODE)); then
+    printf "\nSome SHA-256 sums do not match (or an error occurred):\n\n"
+
+    # display differing files and errors (highlighted in red)
+    printf "\033[0;31m"
+
+    while IFS= read -r line; do
+        # beautify output and get rid of unnecessary lines
+        line="${line%%*: [Oo][Kk]}"
+        line="${line%%: [Ff][Aa][Ii][Ll][Ee][Dd]}"
+        line="${line##*WARNING:*did NOT match}"
+
+        if [ -n "$line" ]; then
+            printf "%s\n" "$line"
+        fi
+    done <<< "$YADM_CHECKSUM_OUTPUT"
+
+    # reset output color
+    printf "\033[0m"
+
+    # display advice for differing files and signal error
+    printf "\nConsider running either \"yadm encrypt\" or \"yadm decrypt\".\n"
+    exit $ERROR_CODE
+fi

contrib/hooks/parsing_full_command_example/README.md

@@ -0,0 +1,7 @@
+## Example of parsing `$YADM_HOOK_FULL_COMMAND`
+
+Contributed by Tim Byrne
+
+Hook    | Description
+----    | -----------
+pre_log | Provides an example of parsing `$YADM_HOOK_FULL_COMMAND` in Bash

contrib/hooks/parsing_full_command_example/pre_log

@@ -0,0 +1,26 @@
+#!/bin/bash
+
+# yadm exposes all parameters of the command which triggers a hook. Those
+# parameters are exported as the environment variable YADM_HOOK_FULL_COMMAND.
+# Any spaces, tabs, or backslashes in those parameters are escaped with a
+# backslash. The function `parse_full_command()` is a demonstration of parsing
+# those values which may be escaped.
+
+function parse_full_command() {
+  local delim=$'\x1e' # ASCII Record Separator
+  local space=$'\x1f' # ASCII Unit Separator
+  local tab=$'\t'     # ASCII TAB
+  local cmd
+  cmd="$YADM_HOOK_FULL_COMMAND"
+  cmd="${cmd//\\ /$space}"      # swap escaped spaces for `1f`
+  cmd="${cmd//\\\\/\\}"         # fix escaped backslashes
+  cmd="${cmd//\\$tab/$tab}"     # fix escaped tabs
+  cmd="${cmd// /$delim}"        # convert space delimiters to `1c`
+  cmd="${cmd//$space/ }"        # convert `1f` back to spaces
+  # parse data into an array
+  IFS=$delim read -r -a full_cmd <<< "$cmd"
+}
+parse_full_command
+for param in "${full_cmd[@]}"; do
+  echo "Parameter: '$param'"
+done

pylintrc

@@ -0,0 +1,17 @@
+[BASIC]
+good-names=pytestmark
+
+[DESIGN]
+max-args=14
+max-locals=28
+max-attributes=8
+max-statements=65
+
+[SIMILARITIES]
+min-similarity-lines=8
+
+[MESSAGES CONTROL]
+disable=redefined-outer-name
+
+[TYPECHECK]
+ignored-modules=py

pytest.ini

@@ -0,0 +1,5 @@
+[pytest]
+cache_dir = /tmp
+addopts = -ra
+markers =
+  deprecated: marks tests for deprecated features (deselect with '-m "not deprecated"')

test/Dockerfile

@@ -0,0 +1,73 @@
+FROM ubuntu:18.04
+MAINTAINER Tim Byrne <sultan@locehilios.com>
+
+# Shellcheck and esh versions
+ARG SC_VER=0.8.0
+ARG ESH_VER=0.3.1
+
+# Install prerequisites and configure UTF-8 locale
+RUN \
+  echo "en_US.UTF-8 UTF-8" > /etc/locale.gen \
+  && apt-get update \
+  && DEBIAN_FRONTEND=noninteractive \
+    apt-get install -y --no-install-recommends \
+    expect \
+    git \
+    gnupg \
+    locales \
+    lsb-release \
+    make \
+    man \
+    python3-pip \
+    vim-tiny \
+    xz-utils \
+  && rm -rf /var/lib/apt/lists/* \
+  && update-locale LANG='en_US.UTF-8' LANGUAGE='en_US:en' LC_ALL='en_US.UTF-8'
+
+ENV LANG='en_US.UTF-8' LANGUAGE='en_US:en' LC_ALL='en_US.UTF-8'
+
+# Convenience settings for the testbed's root account
+RUN echo 'set -o vi' >> /root/.bashrc
+
+# Create a flag to identify when running inside the yadm testbed
+RUN touch /.yadmtestbed
+
+# Install shellcheck
+ADD https://github.com/koalaman/shellcheck/releases/download/v$SC_VER/shellcheck-v$SC_VER.linux.x86_64.tar.xz /opt
+RUN cd /opt \
+  && tar xf shellcheck-v$SC_VER.linux.x86_64.tar.xz \
+  && rm -f shellcheck-v$SC_VER.linux.x86_64.tar.xz \
+  && ln -s /opt/shellcheck-v$SC_VER/shellcheck /usr/local/bin
+
+# Upgrade pip3 and install requirements
+COPY test/requirements.txt /tmp/requirements.txt
+RUN python3 -m pip install --upgrade pip setuptools \
+  && python3 -m pip install --upgrade -r /tmp/requirements.txt \
+  && rm -f /tmp/requirements
+
+# Install esh
+ADD https://raw.githubusercontent.com/jirutka/esh/v$ESH_VER/esh /usr/local/bin
+RUN chmod +x /usr/local/bin/esh
+
+# Create workdir and dummy Makefile to be used if no /yadm volume is mounted
+RUN mkdir /yadm \
+  && echo "test:" > /yadm/Makefile \
+  && echo "\t@echo 'The yadm project must be mounted at /yadm'" >> /yadm/Makefile \
+  && echo "\t@echo 'Try using a docker parameter like -v \"\$\$PWD:/yadm:ro\"'" >> /yadm/Makefile \
+  && echo "\t@false" >> /yadm/Makefile
+
+# Include released versions of yadm to test upgrades
+ADD https://raw.githubusercontent.com/TheLocehiliosan/yadm/1.12.0/yadm /usr/local/bin/yadm-1.12.0
+ADD https://raw.githubusercontent.com/TheLocehiliosan/yadm/2.5.0/yadm /usr/local/bin/yadm-2.5.0
+RUN chmod +x /usr/local/bin/yadm-*
+
+# Configure git to make it easier to test yadm manually
+RUN git config --system user.email "test@yadm.io" \
+  && git config --system user.name "Yadm Test"
+
+# /yadm will be the work directory for all tests
+# docker commands should mount the local yadm project as /yadm
+WORKDIR /yadm
+
+# By default, run all tests defined
+CMD make test

test/conftest.py

@@ -0,0 +1,627 @@
+"""Global tests configuration and fixtures"""
+
+import collections
+import contextlib
+import copy
+import distutils.dir_util  # pylint: disable=no-name-in-module,import-error
+import os
+import platform
+import pwd
+from subprocess import Popen, PIPE
+import py
+import pytest
+
+
+def pytest_addoption(parser):
+    """Add options to pytest"""
+    parser.addoption(
+        "--force-linters",
+        action="store_true",
+        default=False,
+        help="Run linters regardless of installed versions",
+    )
+
+
+@pytest.fixture(scope='session')
+def shellcheck_version():
+    """Version of shellcheck supported"""
+    return '0.8.0'
+
+
+@pytest.fixture(scope='session')
+def pylint_version():
+    """Version of pylint supported"""
+    return '2.6.0'
+
+
+@pytest.fixture(scope='session')
+def flake8_version():
+    """Version of flake8 supported"""
+    return '3.8.4'
+
+
+@pytest.fixture(scope='session')
+def yamllint_version():
+    """Version of yamllint supported"""
+    return '1.25.0'
+
+
+@pytest.fixture(scope='session')
+def tst_user():
+    """Test session's user id"""
+    return pwd.getpwuid(os.getuid()).pw_name
+
+
+@pytest.fixture(scope='session')
+def tst_host():
+    """Test session's short hostname value"""
+    return platform.node().split('.')[0]
+
+
+@pytest.fixture(scope='session')
+def tst_distro(runner):
+    """Test session's distro"""
+    distro = ''
+    with contextlib.suppress(Exception):
+        run = runner(command=['lsb_release', '-si'], report=False)
+        distro = run.out.strip()
+    return distro
+
+
+@pytest.fixture(scope='session')
+def tst_distro_family(runner):
+    """Test session's distro_family"""
+    family = ''
+    with contextlib.suppress(Exception):
+        run = runner(command=[
+            'grep', '-oP', r'ID_LIKE=\K.+', '/etc/os-release'], report=False)
+        family = run.out.strip()
+    return family
+
+
+@pytest.fixture(scope='session')
+def tst_sys():
+    """Test session's uname value"""
+    return platform.system()
+
+
+@pytest.fixture(scope='session')
+def tst_arch():
+    """Test session's uname value"""
+    return platform.machine()
+
+
+@pytest.fixture(scope='session')
+def supported_commands():
+    """List of supported commands
+
+    This list should be updated every time yadm learns a new command.
+    """
+    return [
+        'alt',
+        'bootstrap',
+        'clean',
+        'clone',
+        'config',
+        'decrypt',
+        'encrypt',
+        'enter',
+        'git-crypt',
+        'gitconfig',
+        'help',
+        'init',
+        'introspect',
+        'list',
+        'perms',
+        'transcrypt',
+        'upgrade',
+        'version',
+        ]
+
+
+@pytest.fixture(scope='session')
+def supported_configs():
+    """List of supported config options
+
+    This list should be updated every time yadm learns a new config.
+    """
+    return [
+        'local.arch',
+        'local.class',
+        'local.hostname',
+        'local.os',
+        'local.user',
+        'yadm.alt-copy',
+        'yadm.auto-alt',
+        'yadm.auto-exclude',
+        'yadm.auto-perms',
+        'yadm.auto-private-dirs',
+        'yadm.cipher',
+        'yadm.git-program',
+        'yadm.gpg-perms',
+        'yadm.gpg-program',
+        'yadm.gpg-recipient',
+        'yadm.openssl-ciphername',
+        'yadm.openssl-old',
+        'yadm.openssl-program',
+        'yadm.ssh-perms',
+        ]
+
+
+@pytest.fixture(scope='session')
+def supported_switches():
+    """List of supported switches
+
+    This list should be updated every time yadm learns a new switch.
+    """
+    return [
+        '--yadm-archive',
+        '--yadm-bootstrap',
+        '--yadm-config',
+        '--yadm-data',
+        '--yadm-dir',
+        '--yadm-encrypt',
+        '--yadm-repo',
+        '-Y',
+        ]
+
+
+@pytest.fixture(scope='session')
+def supported_local_configs(supported_configs):
+    """List of supported local config options"""
+    return [c for c in supported_configs if c.startswith('local.')]
+
+
+class Runner():
+    """Class for running commands
+
+    Within yadm tests, this object should be used when running commands that
+    require:
+
+      * Acting on the status code
+      * Parsing the output of the command
+      * Passing input to the command
+
+    Other instances of simply running commands should use os.system().
+    """
+
+    def __init__(
+            self,
+            command,
+            inp=None,
+            shell=False,
+            cwd=None,
+            env=None,
+            expect=None,
+            report=True):
+        if shell:
+            self.command = ' '.join([str(cmd) for cmd in command])
+        else:
+            self.command = command
+        if env is None:
+            env = {}
+        merged_env = os.environ.copy()
+        merged_env.update(env)
+        self.inp = inp
+        self.wrap(expect)
+        process = Popen(
+            self.command,
+            stdin=PIPE,
+            stdout=PIPE,
+            stderr=PIPE,
+            shell=shell,
+            cwd=cwd,
+            env=merged_env,
+        )
+        input_bytes = self.inp
+        if self.inp:
+            input_bytes = self.inp.encode()
+        (out_bstream, err_bstream) = process.communicate(input=input_bytes)
+        self.out = out_bstream.decode()
+        self.err = err_bstream.decode()
+        self.code = process.wait()
+        self.success = self.code == 0
+        self.failure = self.code != 0
+        if report:
+            self.report()
+
+    def __repr__(self):
+        return f'Runner({self.command})'
+
+    def report(self):
+        """Print code/stdout/stderr"""
+        print(f'{self}')
+        print(f'  RUN: code:{self.code}')
+        if self.inp:
+            print(f'  RUN: input:\n{self.inp}')
+        print(f'  RUN: stdout:\n{self.out}')
+        print(f'  RUN: stderr:\n{self.err}')
+
+    def wrap(self, expect):
+        """Wrap command with expect"""
+        if not expect:
+            return
+        cmdline = ' '.join([f'"{w}"' for w in self.command])
+        expect_script = f'set timeout 2\nspawn {cmdline}\n'
+        for question, answer in expect:
+            expect_script += (
+                'expect {\n'
+                f'"{question}" {{send "{answer}\\r"}}\n'
+                'timeout {close;exit 128}\n'
+                '}\n')
+        expect_script += (
+            'expect eof\n'
+            'foreach {pid spawnid os_error_flag value} [wait] break\n'
+            'exit $value')
+        self.inp = expect_script
+        print(f'EXPECT:{expect_script}')
+        self.command = ['expect']
+
+
+@pytest.fixture(scope='session')
+def runner():
+    """Class for running commands"""
+    return Runner
+
+
+@pytest.fixture(scope='session')
+def config_git():
+    """Configure global git configuration, if missing"""
+    os.system(
+        'git config user.name || '
+        'git config --global user.name "test"')
+    os.system(
+        'git config user.email || '
+        'git config --global user.email "test@test.test"')
+
+
+@pytest.fixture()
+def repo_config(runner, paths):
+    """Function to query a yadm repo configuration value"""
+
+    def query_func(key):
+        """Query a yadm repo configuration value"""
+        run = runner(
+            command=('git', 'config', '--local', key),
+            env={'GIT_DIR': paths.repo},
+            report=False,
+            )
+        return run.out.rstrip()
+
+    return query_func
+
+
+@pytest.fixture(scope='session')
+def yadm():
+    """Path to yadm program to be tested"""
+    full_path = os.path.realpath('yadm')
+    assert os.path.isfile(full_path), "yadm program file isn't present"
+    return full_path
+
+
+@pytest.fixture()
+def paths(tmpdir, yadm):
+    """Function scoped test paths"""
+
+    dir_root = tmpdir.mkdir('root')
+    dir_remote = dir_root.mkdir('remote')
+    dir_work = dir_root.mkdir('work')
+    dir_xdg_data = dir_root.mkdir('xdg_data')
+    dir_xdg_home = dir_root.mkdir('xdg_home')
+    dir_data = dir_xdg_data.mkdir('yadm')
+    dir_yadm = dir_xdg_home.mkdir('yadm')
+    dir_hooks = dir_yadm.mkdir('hooks')
+    dir_repo = dir_data.mkdir('repo.git')
+    file_archive = dir_data.join('archive')
+    file_bootstrap = dir_yadm.join('bootstrap')
+    file_config = dir_yadm.join('config')
+    file_encrypt = dir_yadm.join('encrypt')
+    paths = collections.namedtuple(
+        'Paths', [
+            'pgm',
+            'root',
+            'remote',
+            'work',
+            'xdg_data',
+            'xdg_home',
+            'data',
+            'yadm',
+            'hooks',
+            'repo',
+            'archive',
+            'bootstrap',
+            'config',
+            'encrypt',
+            ])
+    os.environ['XDG_CONFIG_HOME'] = str(dir_xdg_home)
+    os.environ['XDG_DATA_HOME'] = str(dir_xdg_data)
+    return paths(
+        yadm,
+        dir_root,
+        dir_remote,
+        dir_work,
+        dir_xdg_data,
+        dir_xdg_home,
+        dir_data,
+        dir_yadm,
+        dir_hooks,
+        dir_repo,
+        file_archive,
+        file_bootstrap,
+        file_config,
+        file_encrypt,
+        )
+
+
+@pytest.fixture()
+def yadm_cmd(paths):
+    """Generate custom command_list function"""
+    def command_list(*args):
+        """Produce params for running yadm with -Y"""
+        return [paths.pgm] + list(args)
+    return command_list
+
+
+class DataFile():
+    """Datafile object"""
+
+    def __init__(self, path, tracked=True, private=False):
+        self.__path = path
+        self.__parent = None
+        self.__tracked = tracked
+        self.__private = private
+
+    @property
+    def path(self):
+        """Path property"""
+        return self.__path
+
+    @property
+    def relative(self):
+        """Relative path property"""
+        if self.__parent:
+            return self.__parent.join(self.path)
+        raise BaseException('Unable to provide relative path, no parent')
+
+    @property
+    def tracked(self):
+        """Tracked property"""
+        return self.__tracked
+
+    @property
+    def private(self):
+        """Private property"""
+        return self.__private
+
+    def relative_to(self, parent):
+        """Update all relative paths to this py.path"""
+        self.__parent = parent
+
+
+class DataSet():
+    """Dataset object"""
+
+    def __init__(self):
+        self.__files = list()
+        self.__dirs = list()
+        self.__tracked_dirs = list()
+        self.__private_dirs = list()
+        self.__relpath = None
+
+    def __repr__(self):
+        return (
+            f'[DS with {len(self)} files; '
+            f'{len(self.tracked)} tracked, '
+            f'{len(self.private)} private]'
+            )
+
+    def __iter__(self):
+        return iter(self.__files)
+
+    def __len__(self):
+        return len(self.__files)
+
+    def __contains__(self, datafile):
+        if [f for f in self.__files if f.path == datafile]:
+            return True
+        if datafile in self.__files:
+            return True
+        return False
+
+    @property
+    def files(self):
+        """List of DataFiles in DataSet"""
+        return list(self.__files)
+
+    @property
+    def tracked(self):
+        """List of tracked DataFiles in DataSet"""
+        return [f for f in self.__files if f.tracked]
+
+    @property
+    def private(self):
+        """List of private DataFiles in DataSet"""
+        return [f for f in self.__files if f.private]
+
+    @property
+    def dirs(self):
+        """List of directories in DataSet"""
+        return list(self.__dirs)
+
+    @property
+    def plain_dirs(self):
+        """List of directories in DataSet not starting with '.'"""
+        return [d for d in self.dirs if not d.startswith('.')]
+
+    @property
+    def hidden_dirs(self):
+        """List of directories in DataSet starting with '.'"""
+        return [d for d in self.dirs if d.startswith('.')]
+
+    @property
+    def tracked_dirs(self):
+        """List of directories in DataSet not starting with '.'"""
+        return [d for d in self.__tracked_dirs if not d.startswith('.')]
+
+    @property
+    def private_dirs(self):
+        """List of directories in DataSet considered 'private'"""
+        return list(self.__private_dirs)
+
+    def add_file(self, path, tracked=True, private=False):
+        """Add file to data set"""
+        if path not in self:
+            datafile = DataFile(path, tracked, private)
+            if self.__relpath:
+                datafile.relative_to(self.__relpath)
+            self.__files.append(datafile)
+
+        dname = os.path.dirname(path)
+        if dname and dname not in self.__dirs:
+            self.__dirs.append(dname)
+            if tracked:
+                self.__tracked_dirs.append(dname)
+            if private:
+                self.__private_dirs.append(dname)
+
+    def relative_to(self, relpath):
+        """Update all relative paths to this py.path"""
+        self.__relpath = relpath
+        for datafile in self.files:
+            datafile.relative_to(self.__relpath)
+
+
+@pytest.fixture(scope='session')
+def ds1_dset(tst_sys):
+    """Meta-data for dataset one files"""
+    dset = DataSet()
+    dset.add_file('t1')
+    dset.add_file('d1/t2')
+    dset.add_file(f'test_alt_copy##os.{tst_sys}')
+    dset.add_file('u1', tracked=False)
+    dset.add_file('d2/u2', tracked=False)
+    dset.add_file('.ssh/p1', tracked=False, private=True)
+    dset.add_file('.ssh/.p2', tracked=False, private=True)
+    dset.add_file('.gnupg/p3', tracked=False, private=True)
+    dset.add_file('.gnupg/.p4', tracked=False, private=True)
+    return dset
+
+
+@pytest.fixture(scope='session')
+def ds1_data(tmpdir_factory, config_git, ds1_dset, runner):
+    """A set of test data, worktree & repo"""
+    # pylint: disable=unused-argument
+    # This is ignored because
+    # @pytest.mark.usefixtures('config_git')
+    # cannot be applied to another fixture.
+
+    data = tmpdir_factory.mktemp('ds1')
+
+    work = data.mkdir('work')
+    for datafile in ds1_dset:
+        work.join(datafile.path).write(datafile.path, ensure=True)
+
+    repo = data.mkdir('repo.git')
+    env = os.environ.copy()
+    env['GIT_DIR'] = str(repo)
+    runner(
+        command=['git', 'init', '--shared=0600', '--bare', str(repo)],
+        report=False)
+    runner(
+        command=['git', 'config', 'core.bare', 'false'],
+        env=env,
+        report=False)
+    runner(
+        command=['git', 'config', 'status.showUntrackedFiles', 'no'],
+        env=env,
+        report=False)
+    runner(
+        command=['git', 'config', 'yadm.managed', 'true'],
+        env=env,
+        report=False)
+    runner(
+        command=['git', 'config', 'core.worktree', str(work)],
+        env=env,
+        report=False)
+    runner(
+        command=['git', 'add'] +
+        [str(work.join(f.path)) for f in ds1_dset if f.tracked],
+        env=env)
+    runner(
+        command=['git', 'commit', '--allow-empty', '-m', 'Initial commit'],
+        env=env,
+        report=False)
+
+    data = collections.namedtuple('Data', ['work', 'repo'])
+    return data(work, repo)
+
+
+@pytest.fixture()
+def ds1_work_copy(ds1_data, paths):
+    """Function scoped copy of ds1_data.work"""
+    distutils.dir_util.copy_tree(  # pylint: disable=no-member
+        str(ds1_data.work), str(paths.work))
+
+
+@pytest.fixture()
+def ds1_repo_copy(runner, ds1_data, paths):
+    """Function scoped copy of ds1_data.repo"""
+    distutils.dir_util.copy_tree(  # pylint: disable=no-member
+        str(ds1_data.repo), str(paths.repo))
+    env = os.environ.copy()
+    env['GIT_DIR'] = str(paths.repo)
+    runner(
+        command=['git', 'config', 'core.worktree', str(paths.work)],
+        env=env,
+        report=False)
+
+
+@pytest.fixture()
+def ds1_copy(ds1_work_copy, ds1_repo_copy):
+    """Function scoped copy of ds1_data"""
+    # pylint: disable=unused-argument
+    # This is ignored because
+    # @pytest.mark.usefixtures('ds1_work_copy', 'ds1_repo_copy')
+    # cannot be applied to another fixture.
+    return None
+
+
+@pytest.fixture()
+def ds1(ds1_work_copy, paths, ds1_dset):
+    """Function scoped ds1_dset w/paths"""
+    # pylint: disable=unused-argument
+    # This is ignored because
+    # @pytest.mark.usefixtures('ds1_copy')
+    # cannot be applied to another fixture.
+    dscopy = copy.deepcopy(ds1_dset)
+    dscopy.relative_to(copy.deepcopy(paths.work))
+    return dscopy
+
+
+@pytest.fixture(scope='session')
+def gnupg(tmpdir_factory, runner):
+    """Location of GNUPGHOME"""
+
+    def register_gpg_password(password):
+        """Publish a new GPG mock password"""
+        py.path.local('/tmp/mock-password').write(password)
+
+    home = tmpdir_factory.mktemp('gnupghome')
+    home.chmod(0o700)
+    conf = home.join('gpg.conf')
+    conf.write('no-secmem-warning\n')
+    conf.chmod(0o600)
+    agentconf = home.join('gpg-agent.conf')
+    agentconf.write(
+        f'pinentry-program {os.path.abspath("test/pinentry-mock")}\n'
+        'max-cache-ttl 0\n'
+    )
+    agentconf.chmod(0o600)
+    data = collections.namedtuple('GNUPG', ['home', 'pw'])
+    env = os.environ.copy()
+    env['GNUPGHOME'] = home
+
+    # this pre-populates std files in the GNUPGHOME
+    runner(['gpg', '-k'], env=env)
+
+    return data(home, register_gpg_password)

test/ownertrust.txt

@@ -0,0 +1 @@
+F8BBFC746C58945442349BCEBA54FFD04C599B1A:6:

test/pinentry-mock

@@ -0,0 +1,12 @@
+#!/bin/bash
+# This program is a custom mock pinentry program
+# It always uses whatever password is found in the /tmp directory
+password="$(cat /tmp/mock-password 2>/dev/null)"
+echo "OK Pleased to meet you"
+while read -r line; do
+  if [[ $line =~ GETPIN ]]; then
+    echo -n "D "
+    echo "$password"
+  fi
+  echo "OK";
+done

test/pylintrc

@@ -0,0 +1 @@
+../pylintrc

test/requirements.txt

@@ -0,0 +1,6 @@
+envtpl
+flake8==3.8.4
+j2cli
+pylint==2.6.0
+pytest==6.2.1
+yamllint==1.25.0

test/test_alt.py

@@ -0,0 +1,295 @@
+"""Test alt"""
+import os
+import string
+import py
+import pytest
+import utils
+
+TEST_PATHS = [utils.ALT_FILE1, utils.ALT_FILE2, utils.ALT_DIR]
+
+
+@pytest.mark.usefixtures('ds1_copy')
+@pytest.mark.parametrize('yadm_alt', [True, False], ids=['alt', 'worktree'])
+@pytest.mark.parametrize(
+    'tracked,encrypt,exclude', [
+        (False, False, False),
+        (True, False, False),
+        (False, True, False),
+        (False, True, True),
+    ], ids=['untracked', 'tracked', 'encrypted', 'excluded'])
+def test_alt_source(
+        runner, paths,
+        tracked, encrypt, exclude,
+        yadm_alt):
+    """Test yadm alt operates on all expected sources of alternates"""
+    yadm_dir, yadm_data = setup_standard_yadm_dir(paths)
+
+    utils.create_alt_files(
+        paths, '##default', tracked=tracked, encrypt=encrypt, exclude=exclude,
+        yadm_alt=yadm_alt, yadm_dir=yadm_dir)
+    run = runner([paths.pgm, '-Y', yadm_dir, '--yadm-data', yadm_data, 'alt'])
+    assert run.success
+    assert run.err == ''
+    linked = utils.parse_alt_output(run.out)
+
+    basepath = yadm_dir.join('alt') if yadm_alt else paths.work
+
+    for link_path in TEST_PATHS:
+        source_file_content = link_path + '##default'
+        source_file = basepath.join(source_file_content)
+        link_file = paths.work.join(link_path)
+        if tracked or (encrypt and not exclude):
+            assert link_file.islink()
+            target = py.path.local(os.path.realpath(link_file))
+            if target.isfile():
+                assert link_file.read() == source_file_content
+                assert str(source_file) in linked
+            else:
+                assert link_file.join(
+                    utils.CONTAINED).read() == source_file_content
+                assert str(source_file) in linked
+        else:
+            assert not link_file.exists()
+            assert str(source_file) not in linked
+
+
+@pytest.mark.usefixtures('ds1_copy')
+@pytest.mark.parametrize('yadm_alt', [True, False], ids=['alt', 'worktree'])
+def test_relative_link(runner, paths, yadm_alt):
+    """Confirm links created are relative"""
+    yadm_dir, yadm_data = setup_standard_yadm_dir(paths)
+
+    utils.create_alt_files(
+        paths, '##default', tracked=True, encrypt=False, exclude=False,
+        yadm_alt=yadm_alt, yadm_dir=yadm_dir)
+    run = runner([paths.pgm, '-Y', yadm_dir, '--yadm-data', yadm_data, 'alt'])
+    assert run.success
+    assert run.err == ''
+
+    basepath = yadm_dir.join('alt') if yadm_alt else paths.work
+
+    for link_path in TEST_PATHS:
+        source_file_content = link_path + '##default'
+        source_file = basepath.join(source_file_content)
+        link_file = paths.work.join(link_path)
+        link = link_file.readlink()
+        relpath = os.path.relpath(
+            source_file, start=os.path.dirname(link_file))
+        assert link == relpath
+
+
+@pytest.mark.usefixtures('ds1_copy')
+@pytest.mark.parametrize('suffix', [
+    '##default',
+    '##default,e.txt', '##default,extension.txt',
+    '##a.$tst_arch', '##arch.$tst_arch',
+    '##o.$tst_sys', '##os.$tst_sys',
+    '##d.$tst_distro', '##distro.$tst_distro',
+    '##f.$tst_distro_family', '##distro_family.$tst_distro_family',
+    '##c.$tst_class', '##class.$tst_class',
+    '##h.$tst_host', '##hostname.$tst_host',
+    '##u.$tst_user', '##user.$tst_user',
+    ])
+def test_alt_conditions(
+        runner, paths,
+        tst_arch, tst_sys, tst_distro, tst_distro_family, tst_host, tst_user,
+        suffix):
+    """Test conditions supported by yadm alt"""
+    yadm_dir, yadm_data = setup_standard_yadm_dir(paths)
+
+    # set the class
+    tst_class = 'testclass'
+    utils.set_local(paths, 'class', tst_class + ".before")
+    utils.set_local(paths, 'class', tst_class, add=True)
+    utils.set_local(paths, 'class', tst_class + ".after", add=True)
+
+    suffix = string.Template(suffix).substitute(
+        tst_arch=tst_arch,
+        tst_sys=tst_sys,
+        tst_distro=tst_distro,
+        tst_distro_family=tst_distro_family,
+        tst_class=tst_class,
+        tst_host=tst_host,
+        tst_user=tst_user,
+    )
+
+    utils.create_alt_files(paths, suffix)
+    run = runner([paths.pgm, '-Y', yadm_dir, '--yadm-data', yadm_data, 'alt'])
+    assert run.success
+    assert run.err == ''
+    linked = utils.parse_alt_output(run.out)
+
+    for link_path in TEST_PATHS:
+        source_file = link_path + suffix
+        assert paths.work.join(link_path).islink()
+        target = py.path.local(os.path.realpath(paths.work.join(link_path)))
+        if target.isfile():
+            assert paths.work.join(link_path).read() == source_file
+            assert str(paths.work.join(source_file)) in linked
+        else:
+            assert paths.work.join(link_path).join(
+                utils.CONTAINED).read() == source_file
+            assert str(paths.work.join(source_file)) in linked
+
+
+@pytest.mark.usefixtures('ds1_copy')
+@pytest.mark.parametrize(
+    'kind', ['default', '', None, 'envtpl', 'j2cli', 'j2', 'esh'])
+@pytest.mark.parametrize('label', ['t', 'template', 'yadm', ])
+def test_alt_templates(
+        runner, paths, kind, label):
+    """Test templates supported by yadm alt"""
+    yadm_dir, yadm_data = setup_standard_yadm_dir(paths)
+
+    suffix = f'##{label}.{kind}'
+    if kind is None:
+        suffix = f'##{label}'
+    utils.create_alt_files(paths, suffix)
+    run = runner([paths.pgm, '-Y', yadm_dir, '--yadm-data', yadm_data, 'alt'])
+    assert run.success
+    assert run.err == ''
+    created = utils.parse_alt_output(run.out, linked=False)
+
+    for created_path in TEST_PATHS:
+        if created_path != utils.ALT_DIR:
+            source_file = created_path + suffix
+            assert paths.work.join(created_path).isfile()
+            assert paths.work.join(created_path).read().strip() == source_file
+            assert str(paths.work.join(source_file)) in created
+
+
+@pytest.mark.usefixtures('ds1_copy')
+@pytest.mark.parametrize('autoalt', [None, 'true', 'false'])
+def test_auto_alt(runner, yadm_cmd, paths, autoalt):
+    """Test auto alt"""
+
+    # set the value of auto-alt
+    if autoalt:
+        os.system(' '.join(yadm_cmd('config', 'yadm.auto-alt', autoalt)))
+
+    utils.create_alt_files(paths, '##default')
+    run = runner(yadm_cmd('status'))
+    assert run.success
+    assert run.err == ''
+    linked = utils.parse_alt_output(run.out)
+
+    for link_path in TEST_PATHS:
+        source_file = link_path + '##default'
+        if autoalt == 'false':
+            assert not paths.work.join(link_path).exists()
+        else:
+            assert paths.work.join(link_path).islink()
+            target = py.path.local(
+                os.path.realpath(paths.work.join(link_path)))
+            if target.isfile():
+                assert paths.work.join(link_path).read() == source_file
+                # no linking output when run via auto-alt
+                assert str(paths.work.join(source_file)) not in linked
+            else:
+                assert paths.work.join(link_path).join(
+                    utils.CONTAINED).read() == source_file
+                # no linking output when run via auto-alt
+                assert str(paths.work.join(source_file)) not in linked
+
+
+@pytest.mark.usefixtures('ds1_copy')
+def test_stale_link_removal(runner, yadm_cmd, paths):
+    """Stale links to alternative files are removed
+
+    This test ensures that when an already linked alternative becomes invalid
+    due to a change in class, the alternate link is removed.
+    """
+
+    # set the class
+    tst_class = 'testclass'
+    utils.set_local(paths, 'class', tst_class)
+
+    # create files which match the test class
+    utils.create_alt_files(paths, f'##class.{tst_class}')
+
+    # run alt to trigger linking
+    run = runner(yadm_cmd('alt'))
+    assert run.success
+    assert run.err == ''
+    linked = utils.parse_alt_output(run.out)
+
+    # assert the proper linking has occurred
+    for stale_path in TEST_PATHS:
+        source_file = stale_path + '##class.' + tst_class
+        assert paths.work.join(stale_path).islink()
+        target = py.path.local(os.path.realpath(paths.work.join(stale_path)))
+        if target.isfile():
+            assert paths.work.join(stale_path).read() == source_file
+            assert str(paths.work.join(source_file)) in linked
+        else:
+            assert paths.work.join(stale_path).join(
+                utils.CONTAINED).read() == source_file
+            assert str(paths.work.join(source_file)) in linked
+
+    # change the class so there are no valid alternates
+    utils.set_local(paths, 'class', 'changedclass')
+
+    # run alt to trigger linking
+    run = runner(yadm_cmd('alt'))
+    assert run.success
+    assert run.err == ''
+    linked = utils.parse_alt_output(run.out)
+
+    # assert the linking is removed
+    for stale_path in TEST_PATHS:
+        source_file = stale_path + '##class.' + tst_class
+        assert not paths.work.join(stale_path).exists()
+        assert str(paths.work.join(source_file)) not in linked
+
+
+@pytest.mark.usefixtures('ds1_repo_copy')
+def test_template_overwrite_symlink(runner, yadm_cmd, paths, tst_sys):
+    """Remove symlinks before processing a template
+
+    If a symlink is in the way of the output of a template, the target of the
+    symlink will get the template content. To prevent this, the symlink should
+    be removed just before processing a template.
+    """
+
+    target = paths.work.join(f'test_link##os.{tst_sys}')
+    target.write('target')
+
+    link = paths.work.join('test_link')
+    link.mksymlinkto(target, absolute=1)
+
+    template = paths.work.join('test_link##template.default')
+    template.write('test-data')
+
+    run = runner(yadm_cmd('add', target, template))
+    assert run.success
+    assert run.err == ''
+    assert run.out == ''
+    assert not link.islink()
+    assert target.read().strip() == 'target'
+    assert link.read().strip() == 'test-data'
+
+
+@pytest.mark.usefixtures('ds1_copy')
+@pytest.mark.parametrize('style', ['symlink', 'template'])
+def test_ensure_alt_path(runner, paths, style):
+    """Test that directories are created before making alternates"""
+    yadm_dir, yadm_data = setup_standard_yadm_dir(paths)
+    suffix = 'default' if style == 'symlink' else 'template'
+    filename = 'a/b/c/file'
+    source = yadm_dir.join(f'alt/{filename}##{suffix}')
+    source.write('test-data', ensure=True)
+    run = runner([
+        paths.pgm, '-Y', yadm_dir, '--yadm-data', yadm_data, 'add', source])
+    assert run.success
+    assert run.err == ''
+    assert run.out == ''
+    assert paths.work.join(filename).read().strip() == 'test-data'
+
+
+def setup_standard_yadm_dir(paths):
+    """Configure a yadm home within the work tree"""
+    std_yadm_dir = paths.work.mkdir('.config').mkdir('yadm')
+    std_yadm_data = paths.work.mkdir('.local').mkdir('share').mkdir('yadm')
+    std_yadm_data.join('repo.git').mksymlinkto(paths.repo, absolute=1)
+    std_yadm_dir.join('encrypt').mksymlinkto(paths.encrypt, absolute=1)
+    return std_yadm_dir, std_yadm_data

test/test_alt_copy.py

@@ -0,0 +1,45 @@
+"""Test yadm.alt-copy"""
+
+import os
+import pytest
+
+
+@pytest.mark.parametrize(
+    'setting, expect_link, pre_existing', [
+        (None, True, None),
+        (True, False, None),
+        (False, True, None),
+        (True, False, 'link'),
+        (True, False, 'file'),
+    ],
+    ids=[
+        'unset',
+        'true',
+        'false',
+        'pre-existing symlink',
+        'pre-existing file',
+    ])
+@pytest.mark.usefixtures('ds1_copy')
+def test_alt_copy(
+        runner, yadm_cmd, paths, tst_sys,
+        setting, expect_link, pre_existing):
+    """Test yadm.alt-copy"""
+
+    if setting is not None:
+        os.system(' '.join(yadm_cmd('config', 'yadm.alt-copy', str(setting))))
+
+    expected_content = f'test_alt_copy##os.{tst_sys}'
+
+    alt_path = paths.work.join('test_alt_copy')
+    if pre_existing == 'symlink':
+        alt_path.mklinkto(expected_content)
+    elif pre_existing == 'file':
+        alt_path.write('wrong content')
+
+    run = runner(yadm_cmd('alt'))
+    assert run.success
+    assert run.err == ''
+    assert 'Linking' in run.out
+
+    assert alt_path.read() == expected_content
+    assert alt_path.islink() == expect_link

test/test_assert_private_dirs.py

@@ -0,0 +1,117 @@
+"""Test asserting private directories"""
+
+import os
+import re
+import pytest
+
+pytestmark = pytest.mark.usefixtures('ds1_copy')
+PRIVATE_DIRS = ['.gnupg', '.ssh']
+
+
+@pytest.mark.parametrize('home', [True, False], ids=['home', 'not-home'])
+def test_pdirs_missing(runner, yadm_cmd, paths, home):
+    """Private dirs (private dirs missing)
+
+    When a git command is run
+    And private directories are missing
+    Create private directories prior to command
+    """
+
+    # confirm directories are missing at start
+    for pdir in PRIVATE_DIRS:
+        path = paths.work.join(pdir)
+        if path.exists():
+            path.remove()
+        assert not path.exists()
+
+    env = {'DEBUG': 'yes'}
+    if home:
+        env['HOME'] = paths.work
+
+    # run status
+    run = runner(command=yadm_cmd('status'), env=env)
+    assert run.success
+    assert run.err == ''
+    assert 'On branch master' in run.out
+
+    # confirm directories are created
+    # and are protected
+    for pdir in PRIVATE_DIRS:
+        path = paths.work.join(pdir)
+        if home:
+            assert path.exists()
+            assert oct(path.stat().mode).endswith('00'), ('Directory is '
+                                                          'not secured')
+        else:
+            assert not path.exists()
+
+    # confirm directories are created before command is run:
+    if home:
+        assert re.search(
+            (r'Creating.+\.(gnupg|ssh).+Creating.+\.(gnupg|ssh).+'
+             r'Running git command git status'),
+            run.out, re.DOTALL), 'directories created before command is run'
+
+
+def test_pdirs_missing_apd_false(runner, yadm_cmd, paths):
+    """Private dirs (private dirs missing / yadm.auto-private-dirs=false)
+
+    When a git command is run
+    And private directories are missing
+    But auto-private-dirs is false
+    Do not create private dirs
+    """
+
+    # confirm directories are missing at start
+    for pdir in PRIVATE_DIRS:
+        path = paths.work.join(pdir)
+        if path.exists():
+            path.remove()
+        assert not path.exists()
+
+    # set configuration
+    os.system(' '.join(yadm_cmd(
+        'config', '--bool', 'yadm.auto-private-dirs', 'false')))
+
+    # run status
+    run = runner(command=yadm_cmd('status'))
+    assert run.success
+    assert run.err == ''
+    assert 'On branch master' in run.out
+
+    # confirm directories are STILL missing
+    for pdir in PRIVATE_DIRS:
+        assert not paths.work.join(pdir).exists()
+
+
+def test_pdirs_exist_apd_false(runner, yadm_cmd, paths):
+    """Private dirs (private dirs exist / yadm.auto-perms=false)
+
+    When a git command is run
+    And private directories exist
+    And yadm is configured not to auto update perms
+    Do not alter directories
+    """
+
+    # create permissive directories
+    for pdir in PRIVATE_DIRS:
+        path = paths.work.join(pdir)
+        if not path.isdir():
+            path.mkdir()
+        path.chmod(0o777)
+        assert oct(path.stat().mode).endswith('77'), 'Directory is secure.'
+
+    # set configuration
+    os.system(' '.join(yadm_cmd(
+        'config', '--bool', 'yadm.auto-perms', 'false')))
+
+    # run status
+    run = runner(command=yadm_cmd('status'))
+    assert run.success
+    assert run.err == ''
+    assert 'On branch master' in run.out
+
+    # created directories are STILL permissive
+    for pdir in PRIVATE_DIRS:
+        path = paths.work.join(pdir)
+        assert oct(path.stat().mode).endswith('77'), 'Directory is secure'

test/test_bootstrap.py

@@ -0,0 +1,35 @@
+"""Test bootstrap"""
+
+import pytest
+
+
+@pytest.mark.parametrize(
+    'exists, executable, code, expect', [
+        (False, False, 1, 'Cannot execute bootstrap'),
+        (True, False, 1, 'is not an executable program'),
+        (True, True, 123, 'Bootstrap successful'),
+    ], ids=[
+        'missing',
+        'not executable',
+        'executable',
+    ])
+def test_bootstrap(
+        runner, yadm_cmd, paths, exists, executable, code, expect):
+    """Test bootstrap command"""
+    if exists:
+        paths.bootstrap.write('')
+    if executable:
+        paths.bootstrap.write(
+            '#!/bin/bash\n'
+            f'echo {expect}\n'
+            f'exit {code}\n'
+        )
+        paths.bootstrap.chmod(0o775)
+    run = runner(command=yadm_cmd('bootstrap'))
+    assert run.code == code
+    if exists and executable:
+        assert run.err == ''
+        assert expect in run.out
+    else:
+        assert expect in run.err
+        assert run.out == ''

test/test_clean.py

@@ -0,0 +1,11 @@
+"""Test clean"""
+
+
+def test_clean_command(runner, yadm_cmd):
+    """Run with clean command"""
+    run = runner(command=yadm_cmd('clean'))
+    # do nothing, this is a dangerous Git command when managing dot files
+    # report the command as disabled and exit as a failure
+    assert run.failure
+    assert run.out == ''
+    assert 'disabled' in run.err

test/test_clone.py

@@ -0,0 +1,345 @@
+"""Test clone"""
+
+import os
+import re
+import pytest
+
+BOOTSTRAP_CODE = 123
+BOOTSTRAP_MSG = 'Bootstrap successful'
+
+
+@pytest.mark.usefixtures('remote')
+@pytest.mark.parametrize(
+    'good_remote, repo_exists, force, conflicts', [
+        (False, False, False, False),
+        (True, False, False, False),
+        (True, True, False, False),
+        (True, True, True, False),
+        (True, False, False, True),
+    ], ids=[
+        'bad remote',
+        'simple',
+        'existing repo',
+        '-f',
+        'conflicts',
+    ])
+def test_clone(
+        runner, paths, yadm_cmd, repo_config, ds1,
+        good_remote, repo_exists, force, conflicts):
+    """Test basic clone operation"""
+
+    # clear out the work path
+    paths.work.remove()
+    paths.work.mkdir()
+
+    # determine remote url
+    remote_url = f'file://{paths.remote}'
+    if not good_remote:
+        remote_url = 'file://bad_remote'
+
+    old_repo = None
+    if repo_exists:
+        # put a repo in the way
+        paths.repo.mkdir()
+        old_repo = paths.repo.join('old_repo')
+        old_repo.write('old_repo')
+
+    if conflicts:
+        ds1.tracked[0].relative.write('conflict')
+        assert ds1.tracked[0].relative.exists()
+
+    # run the clone command
+    args = ['clone', '-w', paths.work]
+    if force:
+        args += ['-f']
+    args += [remote_url]
+    run = runner(command=yadm_cmd(*args))
+
+    if not good_remote:
+        # clone should fail
+        assert run.failure
+        assert run.out == ''
+        assert 'Unable to clone the repository' in run.err
+        assert not paths.repo.exists()
+    elif repo_exists and not force:
+        # can't overwrite data
+        assert run.failure
+        assert run.out == ''
+        assert 'Git repo already exists' in run.err
+    else:
+        # clone should succeed, and repo should be configured properly
+        assert successful_clone(run, paths, repo_config)
+
+        # these clones should have master as HEAD
+        verify_head(paths, 'master')
+
+        # ensure conflicts are handled properly
+        if conflicts:
+            assert 'NOTE' in run.out
+            assert 'Local files with content that differs' in run.out
+
+        # confirm correct Git origin
+        run = runner(
+            command=('git', 'remote', '-v', 'show'),
+            env={'GIT_DIR': paths.repo})
+        assert run.success
+        assert run.err == ''
+        assert f'origin\t{remote_url}' in run.out
+
+        # ensure conflicts are really preserved
+        if conflicts:
+            # test that the conflicts are preserved in the work tree
+            run = runner(
+                command=yadm_cmd('status', '-uno', '--porcelain'),
+                cwd=paths.work)
+            assert run.success
+            assert run.err == ''
+            assert str(ds1.tracked[0].path) in run.out
+
+            # verify content of the conflicts
+            run = runner(command=yadm_cmd('diff'), cwd=paths.work)
+            assert run.success
+            assert run.err == ''
+            assert '\n+conflict' in run.out, 'conflict overwritten'
+
+    # another force-related assertion
+    if old_repo:
+        if force:
+            assert not old_repo.exists()
+        else:
+            assert old_repo.exists()
+
+
+@pytest.mark.usefixtures('remote')
+@pytest.mark.parametrize(
+    'bs_exists, bs_param, answer', [
+        (False, '--bootstrap', None),
+        (True, '--bootstrap', None),
+        (True, '--no-bootstrap', None),
+        (True, None, 'n'),
+        (True, None, 'y'),
+    ], ids=[
+        'force, missing',
+        'force, existing',
+        'prevent',
+        'existing, answer n',
+        'existing, answer y',
+    ])
+def test_clone_bootstrap(
+        runner, paths, yadm_cmd, repo_config, bs_exists, bs_param, answer):
+    """Test bootstrap clone features"""
+
+    # establish a bootstrap
+    create_bootstrap(paths, bs_exists)
+
+    # run the clone command
+    args = ['clone', '-w', paths.work]
+    if bs_param:
+        args += [bs_param]
+    args += [f'file://{paths.remote}']
+    expect = []
+    if answer:
+        expect.append(('Would you like to execute it now', answer))
+    run = runner(command=yadm_cmd(*args), expect=expect)
+
+    if answer:
+        assert 'Would you like to execute it now' in run.out
+
+    expected_code = 0
+    if bs_exists and bs_param != '--no-bootstrap':
+        expected_code = BOOTSTRAP_CODE
+
+    if answer == 'y':
+        expected_code = BOOTSTRAP_CODE
+        assert BOOTSTRAP_MSG in run.out
+    elif answer == 'n':
+        expected_code = 0
+        assert BOOTSTRAP_MSG not in run.out
+
+    assert successful_clone(run, paths, repo_config, expected_code)
+    verify_head(paths, 'master')
+
+    if not bs_exists:
+        assert BOOTSTRAP_MSG not in run.out
+
+
+def create_bootstrap(paths, exists):
+    """Create bootstrap file for test"""
+    if exists:
+        paths.bootstrap.write(
+            '#!/bin/sh\n'
+            f'echo {BOOTSTRAP_MSG}\n'
+            f'exit {BOOTSTRAP_CODE}\n')
+        paths.bootstrap.chmod(0o775)
+        assert paths.bootstrap.exists()
+    else:
+        assert not paths.bootstrap.exists()
+
+
+@pytest.mark.usefixtures('remote')
+@pytest.mark.parametrize(
+    'private_type, in_repo, in_work', [
+        ('ssh', False, True),
+        ('gnupg', False, True),
+        ('ssh', True, True),
+        ('gnupg', True, True),
+        ('ssh', True, False),
+        ('gnupg', True, False),
+    ], ids=[
+        'open ssh, not tracked',
+        'open gnupg, not tracked',
+        'open ssh, tracked',
+        'open gnupg, tracked',
+        'missing ssh, tracked',
+        'missing gnupg, tracked',
+    ])
+def test_clone_perms(
+        runner, yadm_cmd, paths, repo_config,
+        private_type, in_repo, in_work):
+    """Test clone permission-related functions"""
+
+    # update remote repo to include private data
+    if in_repo:
+        rpath = paths.work.mkdir(f'.{private_type}').join('related')
+        rpath.write('related')
+        os.system(f'GIT_DIR="{paths.remote}" git add {rpath}')
+        os.system(f'GIT_DIR="{paths.remote}" git commit -m "{rpath}"')
+        rpath.remove()
+
+    # ensure local private data is insecure at the start
+    if in_work:
+        pdir = paths.work.join(f'.{private_type}')
+        if not pdir.exists():
+            pdir.mkdir()
+        pfile = pdir.join('existing')
+        pfile.write('existing')
+        pdir.chmod(0o777)
+        pfile.chmod(0o777)
+    else:
+        paths.work.remove()
+        paths.work.mkdir()
+
+    env = {'HOME': paths.work}
+    run = runner(
+        yadm_cmd('clone', '-d', '-w', paths.work, f'file://{paths.remote}'),
+        env=env
+    )
+
+    assert successful_clone(run, paths, repo_config)
+    verify_head(paths, 'master')
+    if in_work:
+        # private directories which already exist, should be left as they are,
+        # which in this test is "insecure".
+        assert re.search(
+            f'initial private dir perms drwxrwxrwx.+.{private_type}',
+            run.out)
+        assert re.search(
+            f'pre-checkout private dir perms drwxrwxrwx.+.{private_type}',
+            run.out)
+        assert re.search(
+            f'post-checkout private dir perms drwxrwxrwx.+.{private_type}',
+            run.out)
+    else:
+        # private directories which are created, should be done prior to
+        # checkout, and with secure permissions.
+        assert 'initial private dir perms' not in run.out
+        assert re.search(
+            f'pre-checkout private dir perms drwx------.+.{private_type}',
+            run.out)
+        assert re.search(
+            f'post-checkout private dir perms drwx------.+.{private_type}',
+            run.out)
+
+    # standard perms still apply afterwards unless disabled with auto.perms
+    assert oct(
+        paths.work.join(f'.{private_type}').stat().mode).endswith('00'), (
+            f'.{private_type} has not been secured by auto.perms')
+
+
+@pytest.mark.usefixtures('remote')
+@pytest.mark.parametrize(
+    'branch', ['master', 'default', 'valid', 'invalid'])
+def test_alternate_branch(runner, paths, yadm_cmd, repo_config, branch):
+    """Test cloning a branch other than master"""
+
+    # add a "valid" branch to the remote
+    os.system(f'GIT_DIR="{paths.remote}" git checkout -b valid')
+    os.system(
+        f'GIT_DIR="{paths.remote}" git commit '
+        f'--allow-empty -m "This branch is valid"')
+    if branch != 'default':
+        # When branch == 'default', the "default" branch of the remote repo
+        # will remain "valid" to validate identification the correct default
+        # branch by inspecting the repo. Otherwise it will be set back to
+        # "master"
+        os.system(f'GIT_DIR="{paths.remote}" git checkout master')
+
+    # clear out the work path
+    paths.work.remove()
+    paths.work.mkdir()
+
+    remote_url = f'file://{paths.remote}'
+
+    # run the clone command
+    args = ['clone', '-w', paths.work]
+    if branch not in ['master', 'default']:
+        args += ['-b', branch]
+    args += [remote_url]
+    run = runner(command=yadm_cmd(*args))
+
+    if branch == 'invalid':
+        assert run.failure
+        assert 'ERROR: Unable to clone the repository' in run.err
+        assert f"Remote branch {branch} not found in upstream" in run.err
+    else:
+        assert successful_clone(run, paths, repo_config)
+
+        # confirm correct Git origin
+        run = runner(
+            command=('git', 'remote', '-v', 'show'),
+            env={'GIT_DIR': paths.repo})
+        assert run.success
+        assert run.err == ''
+        assert f'origin\t{remote_url}' in run.out
+        run = runner(command=yadm_cmd('show'))
+        if branch == 'master':
+            assert 'Initial commit' in run.out
+            verify_head(paths, 'master')
+        else:
+            assert 'This branch is valid' in run.out
+            verify_head(paths, 'valid')
+
+
+def successful_clone(run, paths, repo_config, expected_code=0):
+    """Assert clone is successful"""
+    assert run.code == expected_code
+    assert oct(paths.repo.stat().mode).endswith('00'), 'Repo is not secured'
+    assert repo_config('core.bare') == 'false'
+    assert repo_config('status.showUntrackedFiles') == 'no'
+    assert repo_config('yadm.managed') == 'true'
+    return True
+
+
+@pytest.fixture()
+def remote(paths, ds1_repo_copy):
+    """Function scoped remote (based on ds1)"""
+    # pylint: disable=unused-argument
+    # This is ignored because
+    # @pytest.mark.usefixtures('ds1_remote_copy')
+    # cannot be applied to another fixture.
+    paths.remote.remove()
+    paths.repo.move(paths.remote)
+
+
+def test_no_repo(runner, yadm_cmd, ):
+    """Test cloning without specifying a repo"""
+    run = runner(command=yadm_cmd('clone', '-f'))
+    assert run.failure
+    assert run.out == ''
+    assert 'ERROR: Unable to clone the repository' in run.err
+    assert 'repository \'repo.git\' does not exist' in run.err
+
+
+def verify_head(paths, branch):
+    """Assert the local repo has the correct head branch"""
+    assert paths.repo.join('HEAD').read() == f'ref: refs/heads/{branch}\n'

test/test_config.py

@@ -0,0 +1,163 @@
+"""Test config"""
+
+import os
+import pytest
+
+TEST_SECTION = 'test'
+TEST_ATTRIBUTE = 'attribute'
+TEST_KEY = f'{TEST_SECTION}.{TEST_ATTRIBUTE}'
+TEST_VALUE = 'testvalue'
+TEST_FILE = f'[{TEST_SECTION}]\n\t{TEST_ATTRIBUTE} = {TEST_VALUE}'
+
+
+def test_config_no_params(runner, yadm_cmd, supported_configs):
+    """No parameters
+
+    Display instructions
+    Display supported configs
+    Exit with 0
+    """
+
+    run = runner(yadm_cmd('config'))
+
+    assert run.success
+    assert run.err == ''
+    assert 'Please read the CONFIGURATION section' in run.out
+    for config in supported_configs:
+        assert config in run.out
+
+
+def test_config_read_missing(runner, yadm_cmd):
+    """Read missing attribute
+
+    Display an empty value
+    Exit with 0
+    """
+
+    run = runner(yadm_cmd('config', TEST_KEY))
+
+    assert run.success
+    assert run.err == ''
+    assert run.out == ''
+
+
+def test_config_write(runner, yadm_cmd, paths):
+    """Write attribute
+
+    Display no output
+    Update configuration file
+    Exit with 0
+    """
+
+    run = runner(yadm_cmd('config', TEST_KEY, TEST_VALUE))
+
+    assert run.success
+    assert run.err == ''
+    assert run.out == ''
+    assert paths.config.read().strip() == TEST_FILE
+
+
+def test_config_read(runner, yadm_cmd, paths):
+    """Read attribute
+
+    Display value
+    Exit with 0
+    """
+
+    paths.config.write(TEST_FILE)
+    run = runner(yadm_cmd('config', TEST_KEY))
+
+    assert run.success
+    assert run.err == ''
+    assert run.out.strip() == TEST_VALUE
+
+
+def test_config_update(runner, yadm_cmd, paths):
+    """Update attribute
+
+    Display no output
+    Update configuration file
+    Exit with 0
+    """
+
+    paths.config.write(TEST_FILE)
+
+    run = runner(yadm_cmd('config', TEST_KEY, TEST_VALUE + 'extra'))
+
+    assert run.success
+    assert run.err == ''
+    assert run.out == ''
+
+    assert paths.config.read().strip() == TEST_FILE + 'extra'
+
+
+@pytest.mark.usefixtures('ds1_repo_copy')
+def test_config_local_read(runner, yadm_cmd, paths, supported_local_configs):
+    """Read local attribute
+
+    Display value from the repo config
+    Exit with 0
+    """
+
+    # populate test values
+    for config in supported_local_configs:
+        os.system(
+            f'GIT_DIR="{paths.repo}" '
+            f'git config --local "{config}" "value_of_{config}"')
+
+    # run yadm config
+    for config in supported_local_configs:
+        run = runner(yadm_cmd('config', config))
+        assert run.success
+        assert run.err == ''
+        assert run.out.strip() == f'value_of_{config}'
+
+
+@pytest.mark.usefixtures('ds1_repo_copy')
+def test_config_local_write(runner, yadm_cmd, paths, supported_local_configs):
+    """Write local attribute
+
+    Display no output
+    Write value to the repo config
+    Exit with 0
+    """
+
+    # run yadm config
+    for config in supported_local_configs:
+        run = runner(yadm_cmd('config', config, f'value_of_{config}'))
+        assert run.success
+        assert run.err == ''
+        assert run.out == ''
+
+    # verify test values
+    for config in supported_local_configs:
+        run = runner(
+            command=('git', 'config', config),
+            env={'GIT_DIR': paths.repo})
+        assert run.success
+        assert run.err == ''
+        assert run.out.strip() == f'value_of_{config}'
+
+
+def test_config_without_parent_directory(runner, yadm_cmd, paths):
+    """Write and read attribute to/from config file with non-existent parent dir
+
+    Update configuration file
+    Display value
+    Exit with 0
+    """
+
+    config_file = paths.root + '/folder/does/not/exist/config'
+
+    run = runner(
+        yadm_cmd('--yadm-config', config_file, 'config', TEST_KEY, TEST_VALUE))
+
+    assert run.success
+    assert run.err == ''
+    assert run.out == ''
+
+    run = runner(yadm_cmd('--yadm-config', config_file, 'config', TEST_KEY))
+
+    assert run.success
+    assert run.err == ''
+    assert run.out.strip() == TEST_VALUE

test/test_encryption.py

@@ -0,0 +1,480 @@
+"""Test encryption"""
+
+import os
+import pipes
+import time
+import pytest
+
+KEY_FILE = 'test/test_key'
+KEY_FINGERPRINT = 'F8BBFC746C58945442349BCEBA54FFD04C599B1A'
+KEY_NAME = 'yadm-test1'
+KEY_TRUST = 'test/ownertrust.txt'
+PASSPHRASE = 'ExamplePassword'
+
+pytestmark = pytest.mark.usefixtures('config_git')
+
+
+def add_asymmetric_key(runner, gnupg):
+    """Add asymmetric key"""
+    env = os.environ.copy()
+    env['GNUPGHOME'] = gnupg.home
+    runner(
+        ['gpg', '--import', pipes.quote(KEY_FILE)],
+        env=env,
+        shell=True,
+    )
+    runner(
+        ['gpg', '--import-ownertrust', '<', pipes.quote(KEY_TRUST)],
+        env=env,
+        shell=True,
+    )
+
+
+def remove_asymmetric_key(runner, gnupg):
+    """Remove asymmetric key"""
+    env = os.environ.copy()
+    env['GNUPGHOME'] = gnupg.home
+    runner(
+        [
+            'gpg', '--batch', '--yes',
+            '--delete-secret-keys', pipes.quote(KEY_FINGERPRINT)
+        ],
+        env=env,
+        shell=True,
+    )
+    runner(
+        [
+            'gpg', '--batch', '--yes',
+            '--delete-key', pipes.quote(KEY_FINGERPRINT)
+        ],
+        env=env,
+        shell=True,
+    )
+
+
+@pytest.fixture
+def asymmetric_key(runner, gnupg):
+    """Fixture for asymmetric key, removed in teardown"""
+    add_asymmetric_key(runner, gnupg)
+    yield KEY_NAME
+    remove_asymmetric_key(runner, gnupg)
+
+
+@pytest.fixture
+def encrypt_targets(yadm_cmd, paths):
+    """Fixture for setting up data to encrypt
+
+    This fixture:
+      * inits an empty repo
+      * creates test files in the work tree
+      * creates a ".yadm/encrypt" file for testing:
+        * standard files
+        * standard globs
+        * directories
+        * comments
+        * empty lines and lines with just space
+        * exclusions
+      * returns a list of expected encrypted files
+    """
+
+    # init empty yadm repo
+    os.system(' '.join(yadm_cmd('init', '-w', str(paths.work), '-f')))
+
+    expected = []
+
+    # standard files w/ dirs & spaces
+    paths.work.join('inc file1').write('inc file1')
+    expected.append('inc file1')
+    paths.encrypt.write('inc file1\n')
+    paths.work.join('inc dir').mkdir()
+    paths.work.join('inc dir/inc file2').write('inc file2')
+    expected.append('inc dir/inc file2')
+    paths.encrypt.write('inc dir/inc file2\n', mode='a')
+
+    # standard globs w/ dirs & spaces
+    paths.work.join('globs file1').write('globs file1')
+    expected.append('globs file1')
+    paths.work.join('globs dir').mkdir()
+    paths.work.join('globs dir/globs file2').write('globs file2')
+    expected.append('globs dir/globs file2')
+    paths.encrypt.write('globs*\n', mode='a')
+
+    # blank lines
+    paths.encrypt.write('\n        \n\t\n', mode='a')
+
+    # comments
+    paths.work.join('commentfile1').write('commentfile1')
+    paths.encrypt.write('#commentfile1\n', mode='a')
+    paths.encrypt.write('        #commentfile1\n', mode='a')
+
+    # exclusions
+    paths.work.join('extest').mkdir()
+    paths.encrypt.write('extest/*\n', mode='a')  # include within extest
+    paths.work.join('extest/inglob1').write('inglob1')
+    paths.work.join('extest/exglob1').write('exglob1')
+    paths.work.join('extest/exglob2').write('exglob2')
+    paths.encrypt.write('!extest/ex*\n', mode='a')  # exclude the ex*
+    expected.append('extest/inglob1')  # should be left with only in*
+
+    return expected
+
+
+@pytest.fixture(scope='session')
+def decrypt_targets(tmpdir_factory, runner, gnupg):
+    """Fixture for setting data to decrypt
+
+    This fixture:
+      * creates symmetric/asymmetric encrypted archives
+      * creates a list of expected decrypted files
+    """
+
+    tmpdir = tmpdir_factory.mktemp('decrypt_targets')
+    symmetric = tmpdir.join('symmetric.tar.gz.gpg')
+    asymmetric = tmpdir.join('asymmetric.tar.gz.gpg')
+
+    expected = []
+
+    tmpdir.join('decrypt1').write('decrypt1')
+    expected.append('decrypt1')
+    tmpdir.join('decrypt2').write('decrypt2')
+    expected.append('decrypt2')
+    tmpdir.join('subdir').mkdir()
+    tmpdir.join('subdir/decrypt3').write('subdir/decrypt3')
+    expected.append('subdir/decrypt3')
+
+    gnupg.pw(PASSPHRASE)
+    env = os.environ.copy()
+    env['GNUPGHOME'] = gnupg.home
+    run = runner(
+        ['tar', 'cvf', '-'] +
+        expected +
+        ['|', 'gpg', '--batch', '--yes', '-c'] +
+        ['--output', pipes.quote(str(symmetric))],
+        cwd=tmpdir,
+        env=env,
+        shell=True)
+    assert run.success
+
+    gnupg.pw('')
+    add_asymmetric_key(runner, gnupg)
+    run = runner(
+        ['tar', 'cvf', '-'] +
+        expected +
+        ['|', 'gpg', '--batch', '--yes', '-e'] +
+        ['-r', pipes.quote(KEY_NAME)] +
+        ['--output', pipes.quote(str(asymmetric))],
+        cwd=tmpdir,
+        env=env,
+        shell=True)
+    assert run.success
+    remove_asymmetric_key(runner, gnupg)
+
+    return {
+        'asymmetric': asymmetric,
+        'expected': expected,
+        'symmetric': symmetric,
+    }
+
+
+@pytest.mark.parametrize(
+    'bad_phrase', [False, True],
+    ids=['good_phrase', 'bad_phrase'])
+@pytest.mark.parametrize(
+    'missing_encrypt', [False, True],
+    ids=['encrypt_exists', 'encrypt_missing'])
+@pytest.mark.parametrize(
+    'overwrite', [False, True],
+    ids=['clean', 'overwrite'])
+def test_symmetric_encrypt(
+        runner, yadm_cmd, paths, encrypt_targets,
+        gnupg, bad_phrase, overwrite, missing_encrypt):
+    """Test symmetric encryption"""
+
+    if missing_encrypt:
+        paths.encrypt.remove()
+
+    if bad_phrase:
+        gnupg.pw('')
+    else:
+        gnupg.pw(PASSPHRASE)
+
+    if overwrite:
+        paths.archive.write('existing archive')
+
+    env = os.environ.copy()
+    env['GNUPGHOME'] = gnupg.home
+    run = runner(yadm_cmd('encrypt'), env=env)
+
+    if missing_encrypt or bad_phrase:
+        assert run.failure
+    else:
+        assert run.success
+        assert run.err == ''
+
+    if missing_encrypt:
+        assert 'does not exist' in run.err
+    elif bad_phrase:
+        assert 'Invalid passphrase' in run.err
+    else:
+        assert encrypted_data_valid(
+            runner, gnupg, paths.archive, encrypt_targets)
+
+
+@pytest.mark.parametrize(
+    'bad_phrase', [False, True],
+    ids=['good_phrase', 'bad_phrase'])
+@pytest.mark.parametrize(
+    'archive_exists', [True, False],
+    ids=['archive_exists', 'archive_missing'])
+@pytest.mark.parametrize(
+    'dolist', [False, True],
+    ids=['decrypt', 'list'])
+def test_symmetric_decrypt(
+        runner, yadm_cmd, paths, decrypt_targets, gnupg,
+        dolist, archive_exists, bad_phrase):
+    """Test decryption"""
+
+    # init empty yadm repo
+    os.system(' '.join(yadm_cmd('init', '-w', str(paths.work), '-f')))
+
+    if bad_phrase:
+        gnupg.pw('')
+        time.sleep(1)  # allow gpg-agent cache to expire
+    else:
+        gnupg.pw(PASSPHRASE)
+
+    if archive_exists:
+        decrypt_targets['symmetric'].copy(paths.archive)
+
+    # to test overwriting
+    paths.work.join('decrypt1').write('pre-existing file')
+
+    env = os.environ.copy()
+    env['GNUPGHOME'] = gnupg.home
+
+    args = []
+
+    if dolist:
+        args.append('-l')
+    run = runner(yadm_cmd('decrypt') + args, env=env)
+
+    if archive_exists and not bad_phrase:
+        assert run.success
+        assert 'encrypted with 1 passphrase' in run.err
+        if dolist:
+            for filename in decrypt_targets['expected']:
+                if filename != 'decrypt1':  # this one should exist
+                    assert not paths.work.join(filename).exists()
+                assert filename in run.out
+        else:
+            for filename in decrypt_targets['expected']:
+                assert paths.work.join(filename).read() == filename
+    else:
+        assert run.failure
+
+
+@pytest.mark.usefixtures('asymmetric_key')
+@pytest.mark.parametrize(
+    'ask', [False, True],
+    ids=['no_ask', 'ask'])
+@pytest.mark.parametrize(
+    'key_exists', [True, False],
+    ids=['key_exists', 'key_missing'])
+@pytest.mark.parametrize(
+    'overwrite', [False, True],
+    ids=['clean', 'overwrite'])
+def test_asymmetric_encrypt(
+        runner, yadm_cmd, paths, encrypt_targets, gnupg,
+        overwrite, key_exists, ask):
+    """Test asymmetric encryption"""
+
+    # specify encryption recipient
+    if ask:
+        os.system(' '.join(yadm_cmd('config', 'yadm.gpg-recipient', 'ASK')))
+        expect = [('Enter the user ID', KEY_NAME), ('Enter the user ID', '')]
+    else:
+        os.system(' '.join(yadm_cmd('config', 'yadm.gpg-recipient', KEY_NAME)))
+        expect = []
+
+    if overwrite:
+        paths.archive.write('existing archive')
+
+    if not key_exists:
+        remove_asymmetric_key(runner, gnupg)
+
+    env = os.environ.copy()
+    env['GNUPGHOME'] = gnupg.home
+
+    run = runner(yadm_cmd('encrypt'), env=env, expect=expect)
+
+    if key_exists:
+        assert run.success
+        assert encrypted_data_valid(
+            runner, gnupg, paths.archive, encrypt_targets)
+    else:
+        assert run.failure
+        assert 'Unable to write' in run.out if expect else run.err
+
+    if ask:
+        assert 'Enter the user ID' in run.out
+
+
+@pytest.mark.usefixtures('asymmetric_key')
+@pytest.mark.usefixtures('encrypt_targets')
+def test_multi_key(runner, yadm_cmd, gnupg):
+    """Test multiple recipients"""
+
+    # specify two encryption recipient
+    os.system(' '.join(yadm_cmd(
+        'config', 'yadm.gpg-recipient', f'"second-key {KEY_NAME}"')))
+
+    env = os.environ.copy()
+    env['GNUPGHOME'] = gnupg.home
+
+    run = runner(yadm_cmd('encrypt'), env=env)
+
+    assert run.failure
+    assert 'second-key: skipped: No public key' in run.err
+
+
+@pytest.mark.usefixtures('asymmetric_key')
+@pytest.mark.parametrize(
+    'key_exists', [True, False],
+    ids=['key_exists', 'key_missing'])
+@pytest.mark.parametrize(
+    'dolist', [False, True],
+    ids=['decrypt', 'list'])
+def test_asymmetric_decrypt(
+        runner, yadm_cmd, paths, decrypt_targets, gnupg,
+        dolist, key_exists):
+    """Test decryption"""
+
+    # init empty yadm repo
+    os.system(' '.join(yadm_cmd('init', '-w', str(paths.work), '-f')))
+
+    decrypt_targets['asymmetric'].copy(paths.archive)
+
+    # to test overwriting
+    paths.work.join('decrypt1').write('pre-existing file')
+
+    if not key_exists:
+        remove_asymmetric_key(runner, gnupg)
+
+    args = []
+
+    if dolist:
+        args.append('-l')
+    env = os.environ.copy()
+    env['GNUPGHOME'] = gnupg.home
+    run = runner(yadm_cmd('decrypt') + args, env=env)
+
+    if key_exists:
+        assert run.success
+        if dolist:
+            for filename in decrypt_targets['expected']:
+                if filename != 'decrypt1':  # this one should exist
+                    assert not paths.work.join(filename).exists()
+                assert filename in run.out
+        else:
+            for filename in decrypt_targets['expected']:
+                assert paths.work.join(filename).read() == filename
+    else:
+        assert run.failure
+        assert 'Unable to extract encrypted files' in run.err
+
+
+@pytest.mark.parametrize(
+    'untracked',
+    [False, 'y', 'n'],
+    ids=['tracked', 'untracked_answer_y', 'untracked_answer_n'])
+def test_offer_to_add(
+        runner, yadm_cmd, paths, encrypt_targets, gnupg, untracked):
+    """Test offer to add encrypted archive
+
+    All the other encryption tests use an archive outside of the work tree.
+    However, the archive is often inside the work tree, and if it is, there
+    should be an offer to add it to the repo if it is not tracked.
+    """
+
+    worktree_archive = paths.work.join('worktree-archive.tar.gpg')
+
+    expect = []
+
+    gnupg.pw(PASSPHRASE)
+    env = os.environ.copy()
+    env['GNUPGHOME'] = gnupg.home
+
+    if untracked:
+        expect.append(('add it now', untracked))
+    else:
+        worktree_archive.write('exists')
+        os.system(' '.join(yadm_cmd('add', str(worktree_archive))))
+
+    run = runner(
+        yadm_cmd('encrypt', '--yadm-archive', str(worktree_archive)),
+        env=env,
+        expect=expect
+        )
+
+    assert run.success
+    assert run.err == ''
+    assert encrypted_data_valid(
+        runner, gnupg, worktree_archive, encrypt_targets)
+
+    run = runner(
+        yadm_cmd('status', '--porcelain', '-uall', str(worktree_archive)))
+    assert run.success
+    assert run.err == ''
+
+    if untracked == 'y':
+        # should be added to the index
+        assert f'A  {worktree_archive.basename}' in run.out
+    elif untracked == 'n':
+        # should NOT be added to the index
+        assert f'?? {worktree_archive.basename}' in run.out
+    else:
+        # should appear modified in the index
+        assert f'AM {worktree_archive.basename}' in run.out
+
+
+@pytest.mark.usefixtures('ds1_copy')
+def test_encrypt_added_to_exclude(runner, yadm_cmd, paths, gnupg):
+    """Confirm that .config/yadm/encrypt is added to exclude"""
+
+    gnupg.pw(PASSPHRASE)
+    env = os.environ.copy()
+    env['GNUPGHOME'] = gnupg.home
+
+    exclude_file = paths.repo.join('info/exclude')
+    paths.encrypt.write('test-encrypt-data\n')
+    paths.work.join('test-encrypt-data').write('')
+    exclude_file.write('original-data', ensure=True)
+
+    run = runner(yadm_cmd('encrypt'), env=env)
+
+    assert 'test-encrypt-data' in paths.repo.join('info/exclude').read()
+    assert 'original-data' in paths.repo.join('info/exclude').read()
+    assert run.success
+    assert run.err == ''
+
+
+def encrypted_data_valid(runner, gnupg, encrypted, expected):
+    """Verify encrypted data matches expectations"""
+    gnupg.pw(PASSPHRASE)
+    env = os.environ.copy()
+    env['GNUPGHOME'] = gnupg.home
+    run = runner([
+        'gpg',
+        '-d', pipes.quote(str(encrypted)),
+        '2>/dev/null',
+        '|', 'tar', 't'], env=env, shell=True, report=False)
+    file_count = 0
+    for filename in run.out.splitlines():
+        if filename.endswith('/'):
+            continue
+        file_count += 1
+        assert filename in expected, (
+            f'Unexpected file in archive: {filename}')
+    assert file_count == len(expected), (
+        'Number of files in archive does not match expected')
+    return True

test/test_enter.py

@@ -0,0 +1,110 @@
+"""Test enter"""
+
+import os
+import pytest
+
+
+@pytest.mark.parametrize(
+    'shell, success', [
+        ('delete', True),  # if there is no shell variable, bash creates it
+        ('', False),
+        ('/usr/bin/env', True),
+        ('noexec', False),
+    ], ids=[
+        'shell-missing',
+        'shell-empty',
+        'shell-env',
+        'shell-noexec',
+    ])
+@pytest.mark.usefixtures('ds1_copy')
+def test_enter(runner, yadm_cmd, paths, shell, success):
+    """Enter tests"""
+    env = os.environ.copy()
+    if shell == 'delete':
+        # remove shell
+        if 'SHELL' in env:
+            del env['SHELL']
+    elif shell == 'noexec':
+        # specify a non-executable path
+        noexec = paths.root.join('noexec')
+        noexec.write('')
+        noexec.chmod(0o664)
+        env['SHELL'] = str(noexec)
+    else:
+        env['SHELL'] = shell
+
+    run = runner(command=yadm_cmd('enter'), env=env)
+    assert run.success == success
+    prompt = f'yadm shell ({paths.repo})'
+    if success:
+        assert run.out.startswith('Entering yadm repo')
+        assert run.out.rstrip().endswith('Leaving yadm repo')
+        assert run.err == ''
+    else:
+        assert 'does not refer to an executable' in run.err
+    if 'env' in shell:
+        assert f'GIT_DIR={paths.repo}' in run.out
+        assert f'GIT_WORK_TREE={paths.work}' in run.out
+        assert f'PROMPT={prompt}' in run.out
+        assert f'PS1={prompt}' in run.out
+
+
+@pytest.mark.parametrize(
+    'shell, opts, path', [
+        ('bash', '--norc', '\\w'),
+        ('csh', '-f', '%~'),
+        ('zsh', '-f', '%~'),
+    ], ids=[
+        'bash',
+        'csh',
+        'zsh',
+    ])
+@pytest.mark.parametrize(
+    'cmd',
+    [False, 'cmd', 'cmd-bad-exit'],
+    ids=['no-cmd', 'cmd', 'cmd-bad-exit'])
+@pytest.mark.parametrize(
+    'term', ['', 'dumb'],
+    ids=['term-empty', 'term-dumb'])
+@pytest.mark.usefixtures('ds1_copy')
+def test_enter_shell_ops(runner, yadm_cmd, paths, shell,
+                         opts, path, cmd, term):
+    """Enter tests for specific shell options"""
+
+    change_exit = '\nfalse' if cmd == 'cmd-bad-exit' else ''
+
+    # Create custom shell to detect options passed
+    custom_shell = paths.root.join(shell)
+    custom_shell.write(
+        f'#!/bin/sh\necho OPTS=$*\necho PROMPT=$PROMPT{change_exit}'
+    )
+    custom_shell.chmod(0o775)
+
+    test_cmd = ['test1', 'test2', 'test3']
+
+    enter_cmd = ['enter']
+    if cmd:
+        enter_cmd += test_cmd
+
+    env = os.environ.copy()
+    env['TERM'] = term
+    env['SHELL'] = custom_shell
+
+    if shell == 'zsh' and term == 'dumb':
+        opts += ' --no-zle'
+
+    run = runner(command=yadm_cmd(*enter_cmd), env=env)
+    if cmd == 'cmd-bad-exit':
+        assert run.failure
+    else:
+        assert run.success
+    assert run.err == ''
+    assert f'OPTS={opts}' in run.out
+    assert f'PROMPT=yadm shell ({paths.repo}) {path} >' in run.out
+    if cmd:
+        assert '-c ' + ' '.join(test_cmd) in run.out
+        assert 'Entering yadm repo' not in run.out
+        assert 'Leaving yadm repo' not in run.out
+    else:
+        assert 'Entering yadm repo' in run.out
+        assert 'Leaving yadm repo' in run.out

test/test_ext_crypt.py

@@ -0,0 +1,48 @@
+"""Test external encryption commands"""
+
+import pytest
+
+
+@pytest.mark.parametrize(
+    'crypt',
+    [False, 'installed', 'installed-but-failed'],
+    ids=['not-installed', 'installed', 'installed-but-failed']
+)
+@pytest.mark.parametrize(
+        'cmd,var', [
+            ['git_crypt', 'GIT_CRYPT_PROGRAM'],
+            ['transcrypt', 'TRANSCRYPT_PROGRAM'],
+        ],
+        ids=['git-crypt', 'transcrypt'])
+def test_ext_encryption(runner, yadm, paths, tmpdir, crypt, cmd, var):
+    """External encryption tests"""
+
+    paths.repo.ensure(dir=True)
+    bindir = tmpdir.mkdir('bin')
+    pgm = bindir.join('test-ext-crypt')
+
+    if crypt:
+        pgm.write('#!/bin/sh\necho ext-crypt ran\n')
+        pgm.chmod(0o775)
+    if crypt == 'installed-but-failed':
+        pgm.write('false\n', mode='a')
+
+    script = f"""
+        YADM_TEST=1 source {yadm}
+        YADM_REPO={paths.repo}
+        {var}="{pgm}"
+        {cmd} "param1"
+    """
+
+    run = runner(command=['bash'], inp=script)
+
+    if crypt:
+        if crypt == 'installed-but-failed':
+            assert run.failure
+        else:
+            assert run.success
+        assert run.out.strip() == 'ext-crypt ran'
+        assert run.err == ''
+    else:
+        assert run.failure
+        assert f"command '{pgm}' cannot be located" in run.err

test/test_git.py

@@ -0,0 +1,58 @@
+"""Test git"""
+
+import re
+import pytest
+
+
+@pytest.mark.usefixtures('ds1_copy')
+def test_git(runner, yadm_cmd, paths):
+    """Test series of passthrough git commands
+
+    Passthru unknown commands to Git
+    Git command 'add' - badfile
+    Git command 'add'
+    Git command 'status'
+    Git command 'commit'
+    Git command 'log'
+    """
+
+    # passthru unknown commands to Git
+    run = runner(command=yadm_cmd('bogus'))
+    assert run.failure
+    assert "git: 'bogus' is not a git command." in run.err
+    assert "See 'git --help'" in run.err
+    assert run.out == ''
+
+    # git command 'add' - badfile
+    run = runner(command=yadm_cmd('add', '-v', 'does_not_exist'))
+    assert run.code == 128
+    assert "pathspec 'does_not_exist' did not match any files" in run.err
+    assert run.out == ''
+
+    # git command 'add'
+    newfile = paths.work.join('test_git')
+    newfile.write('test_git')
+    run = runner(command=yadm_cmd('add', '-v', str(newfile)))
+    assert run.success
+    assert run.err == ''
+    assert "add 'test_git'" in run.out
+
+    # git command 'status'
+    run = runner(command=yadm_cmd('status'))
+    assert run.success
+    assert run.err == ''
+    assert re.search(r'new file:\s+test_git', run.out)
+
+    # git command 'commit'
+    run = runner(command=yadm_cmd('commit', '-m', 'Add test_git'))
+    assert run.success
+    assert run.err == ''
+    assert '1 file changed' in run.out
+    assert '1 insertion' in run.out
+    assert re.search(r'create mode .+ test_git', run.out)
+
+    # git command 'log'
+    run = runner(command=yadm_cmd('log', '--oneline'))
+    assert run.success
+    assert run.err == ''
+    assert 'Add test_git' in run.out

test/test_help.py

@@ -0,0 +1,19 @@
+"""Test help"""
+import pytest
+
+
+def test_missing_command(runner, yadm_cmd):
+    """Run without any command"""
+    run = runner(command=yadm_cmd())
+    assert run.failure
+    assert run.err == ''
+    assert run.out.startswith('Usage: yadm')
+
+
+@pytest.mark.parametrize('cmd', ['--help', 'help'])
+def test_help_command(runner, yadm_cmd, cmd):
+    """Run with help command"""
+    run = runner(command=yadm_cmd(cmd))
+    assert run.failure
+    assert run.err == ''
+    assert run.out.startswith('Usage: yadm')

test/test_hooks.py

@@ -0,0 +1,171 @@
+"""Test hooks"""
+
+import pytest
+
+
+@pytest.mark.parametrize(
+    'pre, pre_code, post, post_code', [
+        (False, 0, False, 0),
+        (True, 0, False, 0),
+        (True, 5, False, 0),
+        (False, 0, True, 0),
+        (False, 0, True, 5),
+        (True, 0, True, 0),
+        (True, 5, True, 5),
+    ], ids=[
+        'no-hooks',
+        'pre-success',
+        'pre-fail',
+        'post-success',
+        'post-fail',
+        'pre-post-success',
+        'pre-post-fail',
+    ])
+@pytest.mark.parametrize('cmd', ['--version', 'version'])
+def test_hooks(
+        runner, yadm_cmd, paths, cmd,
+        pre, pre_code, post, post_code):
+    """Test pre/post hook"""
+
+    # generate hooks
+    if pre:
+        create_hook(paths, 'pre_version', pre_code)
+    if post:
+        create_hook(paths, 'post_version', post_code)
+
+    # run yadm
+    run = runner(yadm_cmd(cmd))
+    # when a pre hook fails, yadm should exit with the hook's code
+    assert run.code == pre_code
+    assert run.err == ''
+
+    if pre:
+        assert 'HOOK:pre_version' in run.out
+    # if pre hook is missing or successful, yadm itself should exit 0
+    if run.success:
+        if post:
+            assert 'HOOK:post_version' in run.out
+    else:
+        # when a pre hook fails, yadm should not run the command
+        assert 'version will not be run' in run.out
+        # when a pre hook fails, yadm should not run the post hook
+        assert 'HOOK:post_version' not in run.out
+
+
+# repo fixture is needed to test the population of YADM_HOOK_WORK
+@pytest.mark.usefixtures('ds1_repo_copy')
+def test_hook_env(runner, yadm_cmd, paths):
+    """Test hook environment"""
+
+    # test will be done with a non existent "git" passthru command
+    # which should exit with a failing code
+    cmd = 'passthrucmd'
+
+    # write the hook
+    hook = paths.hooks.join(f'post_{cmd}')
+    hook.write('#!/bin/bash\nenv\ndeclare\n')
+    hook.chmod(0o755)
+
+    run = runner(yadm_cmd(cmd, 'extra_args'))
+
+    # expect passthru to fail
+    assert run.failure
+    assert f"'{cmd}' is not a git command" in run.err
+
+    # verify hook environment
+    assert 'YADM_HOOK_EXIT=1\n' in run.out
+    assert f'YADM_HOOK_COMMAND={cmd}\n' in run.out
+    assert f'YADM_HOOK_DIR={paths.yadm}\n' in run.out
+    assert f'YADM_HOOK_FULL_COMMAND={cmd} extra_args\n' in run.out
+    assert f'YADM_HOOK_REPO={paths.repo}\n' in run.out
+    assert f'YADM_HOOK_WORK={paths.work}\n' in run.out
+    assert 'YADM_ENCRYPT_INCLUDE_FILES=\n' in run.out
+
+    # verify the hook environment contains certain exported functions
+    for func in [
+            'builtin_dirname',
+            'relative_path',
+            'unix_path',
+            'mixed_path',
+    ]:
+        assert f'BASH_FUNC_{func}' in run.out
+
+    # verify the hook environment contains the list of encrypted files
+    script = f"""
+        YADM_TEST=1 source {paths.pgm}
+        YADM_HOOKS="{paths.hooks}"
+        HOOK_COMMAND="{cmd}"
+        ENCRYPT_INCLUDE_FILES=(a b c)
+        invoke_hook "post"
+    """
+    run = runner(command=['bash'], inp=script)
+    assert run.success
+    assert run.err == ''
+    assert 'YADM_ENCRYPT_INCLUDE_FILES=a\nb\nc\n' in run.out
+
+
+def test_escaped(runner, yadm_cmd, paths):
+    """Test escaped values in YADM_HOOK_FULL_COMMAND"""
+
+    # test will be done with a non existent "git" passthru command
+    # which should exit with a failing code
+    cmd = 'passthrucmd'
+
+    # write the hook
+    hook = paths.hooks.join(f'post_{cmd}')
+    hook.write('#!/bin/bash\nenv\n')
+    hook.chmod(0o755)
+
+    run = runner(yadm_cmd(cmd, 'a b', 'c\td', 'e\\f'))
+
+    # expect passthru to fail
+    assert run.failure
+
+    # verify escaped values
+    assert (
+        f'YADM_HOOK_FULL_COMMAND={cmd} '
+        'a\\ b c\\\td e\\\\f\n') in run.out
+
+
+@pytest.mark.parametrize('condition', ['exec', 'no-exec', 'mingw'])
+def test_executable(runner, paths, condition):
+    """Verify hook must be exectuable"""
+    cmd = 'version'
+    hook = paths.hooks.join(f'pre_{cmd}')
+    hook.write('#!/bin/sh\necho HOOK\n')
+    hook.chmod(0o644)
+    if condition == 'exec':
+        hook.chmod(0o755)
+
+    mingw = 'OPERATING_SYSTEM="MINGWx"' if condition == 'mingw' else ''
+    script = f"""
+        YADM_TEST=1 source {paths.pgm}
+        YADM_HOOKS="{paths.hooks}"
+        HOOK_COMMAND="{cmd}"
+        {mingw}
+        invoke_hook "pre"
+    """
+    run = runner(command=['bash'], inp=script)
+
+    if condition != 'mingw':
+        assert run.success
+        assert run.err == ''
+    else:
+        assert run.failure
+        assert 'Permission denied' in run.err
+
+    if condition == 'exec':
+        assert 'HOOK' in run.out
+    elif condition == 'no-exec':
+        assert 'HOOK' not in run.out
+
+
+def create_hook(paths, name, code):
+    """Create hook"""
+    hook = paths.hooks.join(name)
+    hook.write(
+        '#!/bin/sh\n'
+        f'echo HOOK:{name}\n'
+        f'exit {code}\n'
+    )
+    hook.chmod(0o755)

test/test_init.py

@@ -0,0 +1,84 @@
+"""Test init"""
+
+import pytest
+
+
+@pytest.mark.parametrize(
+    'alt_work, repo_present, force', [
+        (False, False, False),
+        (True, False, False),
+        (False, True, False),
+        (False, True, True),
+        (True, True, True),
+    ], ids=[
+        'simple',
+        '-w',
+        'existing repo',
+        '-f',
+        '-w & -f',
+    ])
+@pytest.mark.usefixtures('ds1_work_copy')
+def test_init(
+        runner, yadm_cmd, paths, repo_config, alt_work, repo_present, force):
+    """Test init
+
+    Repos should have attribs:
+        - 0600 permissions
+        - not bare
+        - worktree = $HOME
+        - showUntrackedFiles = no
+        - yadm.managed = true
+    """
+
+    # these tests will assume this for $HOME
+    home = str(paths.root.mkdir('HOME'))
+
+    # ds1_work_copy comes WITH an empty repo dir present.
+    old_repo = paths.repo.join('old_repo')
+    if repo_present:
+        # Let's put some data in it, so we can confirm that data is gone when
+        # forced to be overwritten.
+        old_repo.write('old repo data')
+        assert old_repo.isfile()
+    else:
+        paths.repo.remove()
+
+    # command args
+    args = ['init']
+    cwd = None
+    if alt_work:
+        if force:
+            cwd = paths.work.dirname
+            args.extend(['-w', paths.work.basename])
+        else:
+            args.extend(['-w', paths.work])
+    if force:
+        args.append('-f')
+
+    # run init
+    run = runner(yadm_cmd(*args), env={'HOME': home}, cwd=cwd)
+
+    if repo_present and not force:
+        assert run.failure
+        assert 'repo already exists' in run.err
+        assert old_repo.isfile(), 'Missing original repo'
+    else:
+        assert run.success
+        assert 'Initialized empty shared Git repository' in run.out
+
+        if repo_present:
+            assert not old_repo.isfile(), 'Original repo still exists'
+        else:
+            assert run.err == ''
+
+        if alt_work:
+            assert repo_config('core.worktree') == paths.work
+        else:
+            assert repo_config('core.worktree') == home
+
+        # uniform repo assertions
+        assert oct(paths.repo.stat().mode).endswith('00'), (
+            'Repo is not secure')
+        assert repo_config('core.bare') == 'false'
+        assert repo_config('status.showUntrackedFiles') == 'no'
+        assert repo_config('yadm.managed') == 'true'

test/test_introspect.py

@@ -0,0 +1,46 @@
+"""Test introspect"""
+
+import pytest
+
+
+@pytest.mark.parametrize(
+    'name', [
+        '',
+        'invalid',
+        'commands',
+        'configs',
+        'repo',
+        'switches',
+    ])
+def test_introspect_category(
+        runner, yadm_cmd, paths, name,
+        supported_commands, supported_configs, supported_switches):
+    """Validate introspection category"""
+    if name:
+        run = runner(command=yadm_cmd('introspect', name))
+    else:
+        run = runner(command=yadm_cmd('introspect'))
+
+    assert run.success
+    assert run.err == ''
+
+    expected = []
+    if name == 'commands':
+        expected = supported_commands
+    elif name == 'configs':
+        expected = supported_configs
+    elif name == 'switches':
+        expected = supported_switches
+
+    # assert values
+    if name in ('', 'invalid'):
+        assert run.out == ''
+    if name == 'repo':
+        assert run.out.rstrip() == paths.repo
+
+    # make sure every expected value is present
+    for value in expected:
+        assert value in run.out
+    # make sure nothing extra is present
+    if expected:
+        assert len(run.out.split()) == len(expected)

test/test_key

@@ -0,0 +1,57 @@
+-----BEGIN PGP PRIVATE KEY BLOCK-----
+Version: GnuPG v1
+
+lQOYBFcWplIBCACyT3gCpP6QKuDGnSd1xsCydJhI1KnLPFR/YxuznkDfXVXMY6WC
+f29WiknfpqwARkNEt2j5o0AxoYKVtZSeLAR2dIwMRJMMfZerezMbMTizLA9Dc+U4
+NzEWoJwr+p1PnQcz5IdIT/O95UFswyBlkk6m7oWtZ8eYHDr8O+DYvj8B2fcm8rfq
+7c5IcwuzTgPMfz+VJynuB4WarS71Qh84t7eWhCbAZAiC8OEdSqHRli/0T02o04Mx
+jVRdxwImJfOc81B4oZr60tdsadwfvcW5dXdNL/kavCH25+QAfEobRU+/y1JI0yx+
+tGYlQ1hkVQYDUt7eA5/9sK9AMTYM0plnJk73ABEBAAEAB/9GeBKxVNzIRDHePKim
+KrzoKh0vF2DdUcQBLj158K6pt/zbEHyOROfPF0sXyQqL9zjJlQS3OBX8J1zw5rjM
+BBBlci0RAh7tXktNOZzaf8rtQJntqgVqgKF1VFc0KFD4cFIy53uxj+t/3nVLUxhg
+HADah0SsYennSyzil5WGgzVqeL1zct+fFf+MSPSIiQJqZbD2QbyLk8IRNcnRyes+
+78brrZkPYNiNv6k/aZejKCAwjSqU6kMNHr1rwxvaY3g5oL4662bOZXBTsp4qvaJK
+jb7LtB72Mtj++T+qBJzDdhty/OQGrsJjMDi6IdIllW7cc+s0FFCH3b+biB4BoKW7
+bnvpBADOb8gALC8v1WD7cEFZ12gIk3IrRcDJD8taozS7jWna83rga9W7qz+eW2Gb
+vOVS+rNG5n/O0Bm1Uvr+y0+i7l21+8iECA3KlP09k+7XDGZUu+IzO4S8guzAu33k
+hlQFj5KwRaXx4nNEGUMZfX75NVHvpcN5W1eKTg1t27I+K1R2mQQA3R73F9FZmnVg
+4VKvfPTgiwQcns8tOXnv/23BNpHqu14qG2E0Dh9xa5FTvtq6hrsKVdH61AU8dptX
+BnLTzG7xF0qEecFpYkmCuyqlVdVPrxBc+Q2PLxK66QpUX+/0m1R3pKGFJ/g+WLdz
+8yMSwMX4W8pSH7QmxVhh4zojmYbTvA8EALE7JmahLUcU/GLs//0sd06XcdS42ENn
+cB2TpqtzLqR9im8tx1/rImWGJFzAvoaAsk4ATXwSoKBiUjmt0jRtVU0Etbm7QTRg
+ub247h4SNKcQyNBZ5eKIn93Cpt2vaTH7rKJ9y5UYAXmsgVrdW9lihaGOgHrgqkMO
+nZV5j17elMNfRl20J1lBRE0gVGVzdCAxIDx5YWRtLXRlc3QxQGxvY2VoaWxpb3Mu
+Y29tPokBOAQTAQIAIgUCVxamUgIbAwYLCQgHAwIGFQgCCQoLBBYCAwECHgECF4AA
+CgkQulT/0ExZmxprzQf9HxoC10h0/GKlzMoNqVhGcrknCD0LMYmx+A8n2qEKVqGG
+9+Hsc5BNI/TQNKJUUsh3G/NGvIDhATKeKrGPI1ezIdpxubtynVJ5qPFOFe/tDFp3
+iMN00v0b64E8OLHXXM26D+fX5/5N6OI+UFaeUT8omrbXy67aAFy74Vm1Ybac2zni
+LuMtXLS65g23plAn509SXl/g1KPnXDIO8ccCn6/5o8s5ZSA3LKTQEtgwN2gX14rN
+n/9DvudpscelkWUWv6wxXOb9p9N/JmNOSGrQ2zyT1u6UWMBxkdgQ90+BZ+Y/wiCs
+lgBjC+dqU9ooJy7EtGD6PjJPunUBi3YjSteMOXnax50DmARXFqZSAQgA22z0PzyT
+6hFfioVVax7zppRJDPQwW+l4+2N7eYUCNoSELhC/uKYwQIZfhRJlX4rkaVv8PgwK
+LdtPyZhHckxGNfsq6w2V/orVFc46dwCiYGsuqIXlu9+KVCsBB4/it8D56koBPPET
+kz5yZDqR7WtoKLbjTPjwOlJwPk/7o87d6CyAcWP6bzVTIiFM3XAXtvdDfXwL9Mj8
+wgTrDc6GFGiwz2VCMVNWASLPvPrGiqEjrt7zaLUrRaLwK81FJUtGcNu06KbZRP6G
++Iu/9+UZ3hmIcZMJZtqNO87q7VHW6NecGRlrg/EZP6XyMTtk83w5aFrOvtzym0xc
+jkTOKGEE72UXVwARAQABAAf7BwcXT4suJZoG2FXq5XJpVVV8fXi4r8jrggmuo7a5
+2msmHJ+WtGBGPVrQZl+vdX7qT+GNU6NpFAzpIkjJSQTeXs47kqmtuyhRKNChGLyh
+drsYFHetYvYG5Sk3cDmQhlgc6P8TyRLjkJy4ZzNlBxigjmVFJGr4rrWDOMuxAI8Y
+ll3/TFa+XrFeBUoFakiC1C8jIanaVCK21kQ2Qam3EKCfuASvxGiCLb/nZ84mDF2d
+GrLiUGA2GumP2cXS/ml8Q/YCjOmQMSTYkM9zFAUkLtfrIZY0/cqIotDOuAY7H3lJ
+u4NlJrenRUnYerjS2QOxm6DdXKu9ChtHJKOrlDMkl3z1SQQA3hQx/DI2BJeSnQLI
+CeO1yMvUf52Dg0e66t7yE0dUcgn4eaIRChMi8aWX3fv3CBVBqPrH5o1BLpqDSHt6
+fGg/za1sMljrtWslnE17UPPl9ZTnS5c1mcNkg3YoyHjGa9RAiEbEMwWF3mPyS+YT
+NuqL6F+KGmTRcTi3eTLEWOf5ltMEAPzxAldXAeconblzupQkuyjhlnlwJYYKzx7P
+nJK2rQW8eOJIPjNC/1xbvWw25Hh/ZNIFN/kWk+lol9PmIPVGp4yfWMOegCH3v6xz
+YZarAyhTqlRQQEeVBddyp2RV6r6+6pz5goTJLGyFiNCgTzMdhZn1U14lnE6ABJW8
+z62Jm/LtA/sFqOSV5PYOdaRRZ7kTBKRmQNQKyJhT5yjnYiI6ME6ds8n5f3lLDnte
+VMUt/IULRIRKQ3JExgciGaDYLhYIy0ZALrpeh5jshM9jPJGK6heaM90h8bnPAdxM
+waNbo+DtTGbHLqqMbVDMSPjO7wSrCuSzfRvTBgaC1puz2YjsN5C/CD9liQEfBBgB
+AgAJBQJXFqZSAhsMAAoJELpU/9BMWZsabE8IAI+z0v6Y+TPoJR7vHAu8twaEWV8E
+z2BAkLabe0IvZH3lvXtlJyhGKm9XIfKINKruwwM+ty+XRXzl3llPUEeylkkPZ4TV
+isKmCazO/M3+2AZ8lexNeJqzUitf5tStapkhoyZOfjbEtpddR9vqUoJQ6aWjYk/y
+YV9Uh5Za5YAb7QcaDIwxGHnCmxovwyUr2T7Z3b4k4O9lqwgjOCezZYYb6+BTnVmz
++C2h9Pk+M1Fuh9fMCmNEL4pCGcCiRtSbeuUvXUtMcZNOuUjcdULw/vuPVko57YLH
+8Wd/F3ckIUEVbKlVYHFdl7DGysDQ08lZ2lvbJE+9L4I+emvgpVt33isXav0=
+=2hap
+-----END PGP PRIVATE KEY BLOCK-----

test/test_list.py

@@ -0,0 +1,48 @@
+"""Test list"""
+
+import os
+import pytest
+
+
+@pytest.mark.parametrize(
+    'location', [
+        'work',
+        'outside',
+        'subdir',
+    ])
+@pytest.mark.usefixtures('ds1_copy')
+def test_list(runner, yadm_cmd, paths, ds1, location):
+    """List tests"""
+    if location == 'work':
+        run_dir = paths.work
+    elif location == 'outside':
+        run_dir = paths.work.join('..')
+    elif location == 'subdir':
+        # first directory with tracked data
+        run_dir = paths.work.join(ds1.tracked_dirs[0])
+    with run_dir.as_cwd():
+        # test with '-a'
+        # should get all tracked files, relative to the work path
+        run = runner(command=yadm_cmd('list', '-a'))
+        assert run.success
+        assert run.err == ''
+        returned_files = set(run.out.splitlines())
+        expected_files = {e.path for e in ds1 if e.tracked}
+        assert returned_files == expected_files
+        # test without '-a'
+        # should get all tracked files, relative to the work path unless in a
+        # subdir, then those should be a limited set of files, relative to the
+        # subdir
+        run = runner(command=yadm_cmd('list'))
+        assert run.success
+        assert run.err == ''
+        returned_files = set(run.out.splitlines())
+        if location == 'subdir':
+            basepath = os.path.basename(os.getcwd())
+            # only expect files within the subdir
+            # names should be relative to subdir
+            expected_files = {
+                e.path[len(basepath)+1:]
+                for e in ds1 if e.tracked and e.path.startswith(basepath)
+            }
+        assert returned_files == expected_files

test/test_perms.py

@@ -0,0 +1,104 @@
+"""Test perms"""
+
+import os
+import pytest
+
+
+@pytest.mark.parametrize('autoperms', ['notest', 'unset', 'true', 'false'])
+@pytest.mark.usefixtures('ds1_copy')
+def test_perms(runner, yadm_cmd, paths, ds1, autoperms):
+    """Test perms"""
+    # set the value of auto-perms
+    if autoperms != 'notest':
+        if autoperms != 'unset':
+            os.system(' '.join(
+                yadm_cmd('config', 'yadm.auto-perms', autoperms)))
+
+    # privatepaths will hold all paths that should become secured
+    privatepaths = [paths.work.join('.ssh'), paths.work.join('.gnupg')]
+    privatepaths += [paths.work.join(private.path) for private in ds1.private]
+
+    # create an archive file
+    os.system(f'touch "{str(paths.archive)}"')
+    privatepaths.append(paths.archive)
+
+    # create encrypted file test data
+    efile1 = paths.work.join('efile1')
+    efile1.write('efile1')
+    efile2 = paths.work.join('efile2')
+    efile2.write('efile2')
+    paths.encrypt.write('efile1\nefile2\n!efile1\n')
+    insecurepaths = [efile1]
+    privatepaths.append(efile2)
+
+    # assert these paths begin unsecured
+    for private in privatepaths + insecurepaths:
+        assert not oct(private.stat().mode).endswith('00'), (
+            'Path started secured')
+
+    cmd = 'perms'
+    if autoperms != 'notest':
+        cmd = 'status'
+    run = runner(yadm_cmd(cmd), env={'HOME': paths.work})
+    assert run.success
+    assert run.err == ''
+    if cmd == 'perms':
+        assert run.out == ''
+
+    # these paths should be secured if processing perms
+    for private in privatepaths:
+        if autoperms == 'false':
+            assert not oct(private.stat().mode).endswith('00'), (
+                'Path should not be secured')
+        else:
+            assert oct(private.stat().mode).endswith('00'), (
+                'Path has not been secured')
+
+    # these paths should never be secured
+    for private in insecurepaths:
+        assert not oct(private.stat().mode).endswith('00'), (
+            'Path should not be secured')
+
+
+@pytest.mark.parametrize('sshperms', [None, 'true', 'false'])
+@pytest.mark.parametrize('gpgperms', [None, 'true', 'false'])
+@pytest.mark.usefixtures('ds1_copy')
+def test_perms_control(runner, yadm_cmd, paths, ds1, sshperms, gpgperms):
+    """Test fine control of perms"""
+    # set the value of ssh-perms
+    if sshperms:
+        os.system(' '.join(yadm_cmd('config', 'yadm.ssh-perms', sshperms)))
+
+    # set the value of gpg-perms
+    if gpgperms:
+        os.system(' '.join(yadm_cmd('config', 'yadm.gpg-perms', gpgperms)))
+
+    # privatepaths will hold all paths that should become secured
+    privatepaths = [paths.work.join('.ssh'), paths.work.join('.gnupg')]
+    privatepaths += [paths.work.join(private.path) for private in ds1.private]
+
+    # assert these paths begin unsecured
+    for private in privatepaths:
+        assert not oct(private.stat().mode).endswith('00'), (
+            'Path started secured')
+
+    run = runner(yadm_cmd('perms'), env={'HOME': paths.work})
+    assert run.success
+    assert run.err == ''
+    assert run.out == ''
+
+    # these paths should be secured if processing perms
+    for private in privatepaths:
+        if (
+                (sshperms == 'false' and 'ssh' in str(private))
+                or
+                (gpgperms == 'false' and 'gnupg' in str(private))
+        ):
+            assert not oct(private.stat().mode).endswith('00'), (
+                'Path should not be secured')
+        else:
+            assert oct(private.stat().mode).endswith('00'), (
+                'Path has not been secured')
+
+    # verify permissions aren't changed for the worktree
+    assert oct(paths.work.stat().mode).endswith('0755')

test/test_syntax.py

@@ -0,0 +1,65 @@
+"""Syntax checks"""
+
+import os
+import pytest
+
+
+def test_yadm_syntax(runner, yadm):
+    """Is syntactically valid"""
+    run = runner(command=['bash', '-n', yadm])
+    assert run.success
+
+
+def test_shellcheck(pytestconfig, runner, yadm, shellcheck_version):
+    """Passes shellcheck"""
+    if not pytestconfig.getoption("--force-linters"):
+        run = runner(command=['shellcheck', '-V'], report=False)
+        if f'version: {shellcheck_version}' not in run.out:
+            pytest.skip('Unsupported shellcheck version')
+    run = runner(command=['shellcheck', '-s', 'bash', yadm])
+    assert run.success
+
+
+def test_pylint(pytestconfig, runner, pylint_version):
+    """Passes pylint"""
+    if not pytestconfig.getoption("--force-linters"):
+        run = runner(command=['pylint', '--version'], report=False)
+        if f'pylint {pylint_version}' not in run.out:
+            pytest.skip('Unsupported pylint version')
+    pyfiles = list()
+    for tfile in os.listdir('test'):
+        if tfile.endswith('.py'):
+            pyfiles.append(f'test/{tfile}')
+    run = runner(command=['pylint'] + pyfiles)
+    assert run.success
+
+
+def test_flake8(pytestconfig, runner, flake8_version):
+    """Passes flake8"""
+    if not pytestconfig.getoption("--force-linters"):
+        run = runner(command=['flake8', '--version'], report=False)
+        if not run.out.startswith(flake8_version):
+            pytest.skip('Unsupported flake8 version')
+    run = runner(command=['flake8', 'test'])
+    assert run.success
+
+
+def test_yamllint(pytestconfig, runner, yamllint_version):
+    """Passes yamllint"""
+    if not pytestconfig.getoption("--force-linters"):
+        run = runner(command=['yamllint', '--version'], report=False)
+        if not run.out.strip().endswith(yamllint_version):
+            pytest.skip('Unsupported yamllint version')
+    run = runner(
+        command=['yamllint', '-s', '$(find . -name \\*.yml)'],
+        shell=True)
+    assert run.success
+
+
+def test_man(runner):
+    """Check for warnings from man"""
+    run = runner(
+        command=['man', '--warnings', './yadm.1'])
+    assert run.success
+    assert run.err == ''
+    assert 'yadm - Yet Another Dotfiles Manager' in run.out

test/test_unit_bootstrap_available.py

@@ -0,0 +1,33 @@
+"""Unit tests: bootstrap_available"""
+
+
+def test_bootstrap_missing(runner, paths):
+    """Test result of bootstrap_available, when bootstrap missing"""
+    run_test(runner, paths, False)
+
+
+def test_bootstrap_no_exec(runner, paths):
+    """Test result of bootstrap_available, when bootstrap not executable"""
+    paths.bootstrap.write('')
+    paths.bootstrap.chmod(0o644)
+    run_test(runner, paths, False)
+
+
+def test_bootstrap_exec(runner, paths):
+    """Test result of bootstrap_available, when bootstrap executable"""
+    paths.bootstrap.write('')
+    paths.bootstrap.chmod(0o775)
+    run_test(runner, paths, True)
+
+
+def run_test(runner, paths, success):
+    """Run bootstrap_available, and test result"""
+    script = f"""
+        YADM_TEST=1 source {paths.pgm}
+        YADM_BOOTSTRAP='{paths.bootstrap}'
+        bootstrap_available
+    """
+    run = runner(command=['bash'], inp=script)
+    assert run.success == success
+    assert run.err == ''
+    assert run.out == ''

test/test_unit_choose_template_cmd.py

@@ -0,0 +1,61 @@
+"""Unit tests: choose_template_cmd"""
+import pytest
+
+
+@pytest.mark.parametrize('label', ['', 'default', 'other'])
+@pytest.mark.parametrize('awk', [True, False], ids=['awk', 'no-awk'])
+def test_kind_default(runner, yadm, awk, label):
+    """Test kind: default"""
+
+    expected = 'template_default'
+    awk_avail = 'true'
+
+    if not awk:
+        awk_avail = 'false'
+        expected = ''
+
+    if label == 'other':
+        expected = ''
+
+    script = f"""
+        YADM_TEST=1 source {yadm}
+        function awk_available {{ { awk_avail}; }}
+        template="$(choose_template_cmd "{label}")"
+        echo "TEMPLATE:$template"
+    """
+    run = runner(command=['bash'], inp=script)
+    assert run.success
+    assert run.err == ''
+    assert f'TEMPLATE:{expected}\n' in run.out
+
+
+@pytest.mark.parametrize('label', ['envtpl', 'j2cli', 'j2', 'other'])
+@pytest.mark.parametrize('envtpl', [True, False], ids=['envtpl', 'no-envtpl'])
+@pytest.mark.parametrize('j2cli', [True, False], ids=['j2cli', 'no-j2cli'])
+def test_kind_j2cli_envtpl(runner, yadm, envtpl, j2cli, label):
+    """Test kind: j2 (both j2cli & envtpl)
+
+    j2cli is preferred over envtpl if available.
+    """
+
+    envtpl_avail = 'true' if envtpl else 'false'
+    j2cli_avail = 'true' if j2cli else 'false'
+
+    if label in ('j2cli', 'j2') and j2cli:
+        expected = 'template_j2cli'
+    elif label in ('envtpl', 'j2') and envtpl:
+        expected = 'template_envtpl'
+    else:
+        expected = ''
+
+    script = f"""
+        YADM_TEST=1 source {yadm}
+        function envtpl_available {{ { envtpl_avail}; }}
+        function j2cli_available {{ { j2cli_avail}; }}
+        template="$(choose_template_cmd "{label}")"
+        echo "TEMPLATE:$template"
+    """
+    run = runner(command=['bash'], inp=script)
+    assert run.success
+    assert run.err == ''
+    assert f'TEMPLATE:{expected}\n' in run.out

test/test_unit_configure_paths.py

@@ -0,0 +1,94 @@
+"""Unit tests: configure_paths"""
+
+import pytest
+
+ARCHIVE = 'archive'
+BOOTSTRAP = 'bootstrap'
+CONFIG = 'config'
+ENCRYPT = 'encrypt'
+HOME = '/testhome'
+REPO = 'repo.git'
+YDIR = '.config/yadm'
+YDATA = '.local/share/yadm'
+
+
+@pytest.mark.parametrize(
+    'override, expect', [
+        (None, {}),
+        ('-Y', {'yadm': 'YADM_DIR'}),
+        ('--yadm-data', {'data': 'YADM_DATA'}),
+        ('--yadm-repo', {'repo': 'YADM_REPO', 'git': 'GIT_DIR'}),
+        ('--yadm-config', {'config': 'YADM_CONFIG'}),
+        ('--yadm-encrypt', {'encrypt': 'YADM_ENCRYPT'}),
+        ('--yadm-archive', {'archive': 'YADM_ARCHIVE'}),
+        ('--yadm-bootstrap', {'bootstrap': 'YADM_BOOTSTRAP'}),
+    ], ids=[
+        'default',
+        'override yadm dir',
+        'override yadm data',
+        'override repo',
+        'override config',
+        'override encrypt',
+        'override archive',
+        'override bootstrap',
+    ])
+@pytest.mark.parametrize(
+    'path', ['.', './override', 'override', '.override', '/override'], ids=[
+        'cwd', './relative', 'relative', 'hidden relative', 'absolute'
+    ])
+def test_config(runner, paths, override, expect, path):
+    """Test configure_paths"""
+    if path.startswith('/'):
+        expected_path = path
+    else:
+        expected_path = str(paths.root.join(path))
+
+    args = [override, path] if override else []
+
+    if override == '-Y':
+        matches = match_map(expected_path)
+    elif override == '--yadm-data':
+        matches = match_map(None, expected_path)
+    else:
+        matches = match_map()
+
+    for ekey in expect.keys():
+        matches[ekey] = f'{expect[ekey]}="{expected_path}"'
+
+    run_test(runner, paths, args, matches.values(), cwd=str(paths.root))
+
+
+def match_map(yadm_dir=None, yadm_data=None):
+    """Create a dictionary of matches, relative to yadm_dir"""
+    if not yadm_dir:
+        yadm_dir = '/'.join([HOME, YDIR])
+    if not yadm_data:
+        yadm_data = '/'.join([HOME, YDATA])
+    return {
+        'yadm': f'YADM_DIR="{yadm_dir}"',
+        'repo': f'YADM_REPO="{yadm_data}/{REPO}"',
+        'config': f'YADM_CONFIG="{yadm_dir}/{CONFIG}"',
+        'encrypt': f'YADM_ENCRYPT="{yadm_dir}/{ENCRYPT}"',
+        'archive': f'YADM_ARCHIVE="{yadm_data}/{ARCHIVE}"',
+        'bootstrap': f'YADM_BOOTSTRAP="{yadm_dir}/{BOOTSTRAP}"',
+        'git': f'GIT_DIR="{yadm_data}/{REPO}"',
+        }
+
+
+def run_test(runner, paths, args, expected_matches, cwd=None):
+    """Run proces global args, and run configure_paths"""
+    argstring = ' '.join(['"'+a+'"' for a in args])
+    script = f"""
+        YADM_TEST=1 HOME="{HOME}" source {paths.pgm}
+        process_global_args {argstring}
+        XDG_CONFIG_HOME=
+        XDG_DATA_HOME=
+        HOME="{HOME}" set_yadm_dirs
+        configure_paths
+        declare -p | grep -E '(YADM|GIT)_'
+    """
+    run = runner(command=['bash'], inp=script, cwd=cwd)
+    assert run.success
+    assert run.err == ''
+    for match in expected_matches:
+        assert match in run.out

test/test_unit_copy_perms.py

@@ -0,0 +1,53 @@
+"""Unit tests: copy_perms"""
+import os
+import pytest
+
+OCTAL = '7654'
+NON_OCTAL = '9876'
+
+
+@pytest.mark.parametrize(
+    'stat_broken', [True, False], ids=['normal', 'stat broken'])
+def test_copy_perms(runner, yadm, tmpdir, stat_broken):
+    """Test function copy_perms"""
+    src_mode = 0o754
+    dst_mode = 0o644
+    source = tmpdir.join('source')
+    source.write('test', ensure=True)
+    source.chmod(src_mode)
+
+    dest = tmpdir.join('dest')
+    dest.write('test', ensure=True)
+    dest.chmod(dst_mode)
+
+    override_stat = ''
+    if stat_broken:
+        override_stat = 'function stat() { echo broken; }'
+    script = f"""
+        YADM_TEST=1 source {yadm}
+        {override_stat}
+        copy_perms "{source}" "{dest}"
+    """
+    run = runner(command=['bash'], inp=script)
+    assert run.success
+    assert run.err == ''
+    assert run.out == ''
+    expected = dst_mode if stat_broken else src_mode
+    assert oct(os.stat(dest).st_mode)[-3:] == oct(expected)[-3:]
+
+
+@pytest.mark.parametrize(
+    'stat_output', [OCTAL, NON_OCTAL], ids=['octal', 'non-octal'])
+def test_get_mode(runner, yadm, stat_output):
+    """Test function get_mode"""
+    script = f"""
+        YADM_TEST=1 source {yadm}
+        function stat() {{ echo {stat_output}; }}
+        mode=$(get_mode abc)
+        echo "MODE:$mode"
+    """
+    run = runner(command=['bash'], inp=script)
+    assert run.success
+    assert run.err == ''
+    expected = OCTAL if stat_output == OCTAL else ""
+    assert f'MODE:{expected}\n' in run.out

test/test_unit_encryption.py

@@ -0,0 +1,135 @@
+"""Unit tests: encryption functions"""
+
+import pytest
+
+
+@pytest.mark.parametrize('condition', ['default', 'override'])
+def test_get_cipher(runner, paths, condition):
+    """Test _get_cipher()"""
+
+    if condition == 'override':
+        paths.config.write('[yadm]\n\tcipher = override-cipher')
+
+    script = f"""
+        YADM_TEST=1 source {paths.pgm}
+        YADM_DIR="{paths.yadm}"
+        set_yadm_dirs
+        configure_paths
+        _get_cipher test-archive
+        echo "output_archive:$output_archive"
+        echo "yadm_cipher:$yadm_cipher"
+    """
+    run = runner(command=['bash'], inp=script)
+    assert run.success
+    assert run.err == ''
+    assert 'output_archive:test-archive' in run.out
+    if condition == 'override':
+        assert 'yadm_cipher:override-cipher' in run.out
+    else:
+        assert 'yadm_cipher:gpg' in run.out
+
+
+@pytest.mark.parametrize('cipher', ['gpg', 'openssl', 'bad'])
+@pytest.mark.parametrize('mode', ['_encrypt_to', '_decrypt_from'])
+def test_encrypt_decrypt(runner, paths, cipher, mode):
+    """Test _encrypt_to() & _decrypt_from"""
+
+    script = f"""
+        YADM_TEST=1 source {paths.pgm}
+        YADM_DIR="{paths.yadm}"
+        set_yadm_dirs
+        configure_paths
+        function mock_openssl() {{ echo openssl $*; }}
+        function mock_gpg() {{ echo gpg $*; }}
+        function _get_cipher() {{
+            output_archive="$1"
+            yadm_cipher="{cipher}"
+        }}
+        OPENSSL_PROGRAM=mock_openssl
+        GPG_PROGRAM=mock_gpg
+        {mode} {paths.archive}
+    """
+    run = runner(command=['bash'], inp=script)
+
+    if cipher != 'bad':
+        assert run.success
+        assert run.out.startswith(cipher)
+        assert str(paths.archive) in run.out
+        assert run.err == ''
+    else:
+        assert run.failure
+        assert 'Unknown cipher' in run.err
+
+
+@pytest.mark.parametrize('condition', ['default', 'override'])
+def test_get_openssl_ciphername(runner, paths, condition):
+    """Test _get_openssl_ciphername()"""
+
+    if condition == 'override':
+        paths.config.write('[yadm]\n\topenssl-ciphername = override-cipher')
+
+    script = f"""
+        YADM_TEST=1 source {paths.pgm}
+        YADM_DIR="{paths.yadm}"
+        set_yadm_dirs
+        configure_paths
+        result=$(_get_openssl_ciphername)
+        echo "result:$result"
+    """
+    run = runner(command=['bash'], inp=script)
+    assert run.success
+    assert run.err == ''
+    if condition == 'override':
+        assert run.out.strip() == 'result:override-cipher'
+    else:
+        assert run.out.strip() == 'result:aes-256-cbc'
+
+
+@pytest.mark.parametrize('condition', ['old', 'not-old'])
+def test_set_openssl_options(runner, paths, condition):
+    """Test _set_openssl_options()"""
+
+    if condition == 'old':
+        paths.config.write('[yadm]\n\topenssl-old = true')
+
+    script = f"""
+        YADM_TEST=1 source {paths.pgm}
+        YADM_DIR="{paths.yadm}"
+        set_yadm_dirs
+        configure_paths
+        function _get_openssl_ciphername() {{ echo "testcipher"; }}
+        _set_openssl_options
+        echo "result:${{OPENSSL_OPTS[@]}}"
+    """
+    run = runner(command=['bash'], inp=script)
+    assert run.success
+    assert run.err == ''
+    if condition == 'old':
+        assert '-testcipher -salt -md md5' in run.out
+    else:
+        assert '-testcipher -salt -pbkdf2 -iter 100000 -md sha512' in run.out
+
+
+@pytest.mark.parametrize('recipient', ['ASK', 'present', ''])
+def test_set_gpg_options(runner, paths, recipient):
+    """Test _set_gpg_options()"""
+
+    paths.config.write(f'[yadm]\n\tgpg-recipient = {recipient}')
+
+    script = f"""
+        YADM_TEST=1 source {paths.pgm}
+        YADM_DIR="{paths.yadm}"
+        set_yadm_dirs
+        configure_paths
+        _set_gpg_options
+        echo "result:${{GPG_OPTS[@]}}"
+    """
+    run = runner(command=['bash'], inp=script)
+    assert run.success
+    assert run.err == ''
+    if recipient == 'ASK':
+        assert run.out.strip() == 'result:--no-default-recipient -e'
+    elif recipient != '':
+        assert run.out.strip() == f'result:-e -r {recipient}'
+    else:
+        assert run.out.strip() == 'result:-c'

test/test_unit_exclude_encrypted.py

@@ -0,0 +1,66 @@
+"""Unit tests: exclude_encrypted"""
+import pytest
+
+
+@pytest.mark.parametrize(
+    'exclude', ['missing', 'outdated', 'up-to-date'])
+@pytest.mark.parametrize(
+    'encrypt_exists', [True, False], ids=['encrypt', 'no-encrypt'])
+@pytest.mark.parametrize(
+    'auto_exclude', [True, False], ids=['enabled', 'disabled'])
+def test_exclude_encrypted(
+        runner, tmpdir, yadm, encrypt_exists, auto_exclude, exclude):
+    """Test exclude_encrypted()"""
+
+    header = (
+        "# yadm-auto-excludes\n"
+        "# This section is managed by yadm.\n"
+        "# Any edits below will be lost.\n"
+    )
+
+    config_function = 'function config() { echo "false";}'
+    if auto_exclude:
+        config_function = 'function config() { return; }'
+
+    encrypt_file = tmpdir.join('encrypt_file')
+    repo_dir = tmpdir.join('repodir')
+    exclude_file = repo_dir.join('info/exclude')
+
+    if encrypt_exists:
+        encrypt_file.write('test-encrypt-data\n', ensure=True)
+    if exclude == 'outdated':
+        exclude_file.write(
+            f'original-exclude\n{header}outdated\n', ensure=True)
+    elif exclude == 'up-to-date':
+        exclude_file.write(
+            f'original-exclude\n{header}test-encrypt-data\n', ensure=True)
+
+    script = f"""
+        YADM_TEST=1 source {yadm}
+        {config_function}
+        DEBUG=1
+        YADM_ENCRYPT="{encrypt_file}"
+        YADM_REPO="{repo_dir}"
+        exclude_encrypted
+    """
+    run = runner(command=['bash'], inp=script)
+    assert run.success
+    assert run.err == ''
+
+    if auto_exclude:
+        if encrypt_exists:
+            assert exclude_file.exists()
+            if exclude == 'missing':
+                assert exclude_file.read() == f'{header}test-encrypt-data\n'
+            else:
+                assert exclude_file.read() == (
+                    'original-exclude\n'
+                    f'{header}test-encrypt-data\n')
+            if exclude != 'up-to-date':
+                assert f'Updating {exclude_file}' in run.out
+            else:
+                assert run.out == ''
+        else:
+            assert run.out == ''
+    else:
+        assert run.out == ''

test/test_unit_issue_legacy_path_warning.py

@@ -0,0 +1,41 @@
+"""Unit tests: issue_legacy_path_warning"""
+import pytest
+
+
+@pytest.mark.parametrize(
+    'legacy_path', [
+        None,
+        'repo.git',
+        'files.gpg',
+        ],
+    )
+@pytest.mark.parametrize(
+    'override', [True, False], ids=['override', 'no-override'])
+@pytest.mark.parametrize(
+    'upgrade', [True, False], ids=['upgrade', 'no-upgrade'])
+def test_legacy_warning(tmpdir, runner, yadm, upgrade, override, legacy_path):
+    """Use issue_legacy_path_warning"""
+    home = tmpdir.mkdir('home')
+
+    if legacy_path:
+        home.ensure(f'.config/yadm/{str(legacy_path)}')
+
+    override = 'YADM_OVERRIDE_REPO=override' if override else ''
+    main_args = 'MAIN_ARGS=("upgrade")' if upgrade else ''
+    script = f"""
+        XDG_CONFIG_HOME=
+        XDG_DATA_HOME=
+        HOME={home}
+        YADM_TEST=1 source {yadm}
+        {main_args}
+        {override}
+        set_yadm_dirs
+        issue_legacy_path_warning
+    """
+    run = runner(command=['bash'], inp=script)
+    assert run.success
+    assert run.out == ''
+    if legacy_path and (not upgrade) and (not override):
+        assert 'Legacy paths have been detected' in run.err
+    else:
+        assert 'Legacy paths have been detected' not in run.err

test/test_unit_parse_encrypt.py

@@ -0,0 +1,201 @@
+"""Unit tests: parse_encrypt"""
+
+import pytest
+
+
+def test_not_called(runner, paths):
+    """Test parse_encrypt (not called)"""
+    run = run_parse_encrypt(runner, paths, skip_parse=True)
+    assert run.success
+    assert run.err == ''
+    assert 'EIF:unparsed' in run.out, 'EIF should be unparsed'
+    assert 'EIF_COUNT:1' in run.out, 'Only value of EIF should be unparsed'
+
+
+def test_short_circuit(runner, paths):
+    """Test parse_encrypt (short-circuit)"""
+    run = run_parse_encrypt(runner, paths, twice=True)
+    assert run.success
+    assert run.err == ''
+    assert 'PARSE_ENCRYPT_SHORT=parse_encrypt() not reprocessed' in run.out, (
+        'parse_encrypt() should short-circuit')
+
+
+@pytest.mark.parametrize(
+    'encrypt', [
+        ('missing'),
+        ('empty'),
+    ])
+def test_empty(runner, paths, encrypt):
+    """Test parse_encrypt (file missing/empty)"""
+
+    # write encrypt file
+    if encrypt == 'missing':
+        assert not paths.encrypt.exists(), 'Encrypt should be missing'
+    else:
+        paths.encrypt.write('')
+        assert paths.encrypt.exists(), 'Encrypt should exist'
+        assert paths.encrypt.size() == 0, 'Encrypt should be empty'
+
+    # run parse_encrypt
+    run = run_parse_encrypt(runner, paths)
+    assert run.success
+    assert run.err == ''
+
+    # validate parsing result
+    assert 'EIF_COUNT:0' in run.out, 'EIF should be empty'
+
+
+def create_test_encrypt_data(paths):
+    """Generate test data for testing encrypt"""
+
+    edata = ''
+    expected = set()
+
+    # empty line
+    edata += '\n'
+
+    # simple comments
+    edata += '# a simple comment\n'
+    edata += '    # a comment with leading space\n'
+
+    # unreferenced directory
+    paths.work.join('unreferenced').mkdir()
+
+    # simple files
+    edata += 'simple_file\n'
+    edata += 'simple.file\n'
+    paths.work.join('simple_file').write('')
+    paths.work.join('simple.file').write('')
+    paths.work.join('simple_file2').write('')
+    paths.work.join('simple.file2').write('')
+    expected.add('simple_file')
+    expected.add('simple.file')
+
+    # simple files in directories
+    edata += 'simple_dir/simple_file\n'
+    paths.work.join('simple_dir/simple_file').write('', ensure=True)
+    paths.work.join('simple_dir/simple_file2').write('', ensure=True)
+    expected.add('simple_dir/simple_file')
+
+    # paths with spaces
+    edata += 'with space/with space\n'
+    paths.work.join('with space/with space').write('', ensure=True)
+    paths.work.join('with space/with space2').write('', ensure=True)
+    expected.add('with space/with space')
+
+    # hidden files
+    edata += '.hidden\n'
+    paths.work.join('.hidden').write('')
+    expected.add('.hidden')
+
+    # hidden files in directories
+    edata += '.hidden_dir/.hidden_file\n'
+    paths.work.join('.hidden_dir/.hidden_file').write('', ensure=True)
+    expected.add('.hidden_dir/.hidden_file')
+
+    # wildcards
+    edata += 'wild*\n'
+    paths.work.join('wildcard1').write('', ensure=True)
+    paths.work.join('wildcard2').write('', ensure=True)
+    expected.add('wildcard1')
+    expected.add('wildcard2')
+
+    edata += 'dirwild*\n'
+    paths.work.join('dirwildcard/file1').write('', ensure=True)
+    paths.work.join('dirwildcard/file2').write('', ensure=True)
+    expected.add('dirwildcard')
+
+    # excludes
+    edata += 'exclude*\n'
+    edata += 'ex ex/*\n'
+    paths.work.join('exclude_file1').write('')
+    paths.work.join('exclude_file2.ex').write('')
+    paths.work.join('exclude_file3.ex3').write('')
+    expected.add('exclude_file1')
+    expected.add('exclude_file3.ex3')
+    edata += '!*.ex\n'
+    edata += '!ex ex/*.txt\n'
+    paths.work.join('ex ex/file4').write('', ensure=True)
+    paths.work.join('ex ex/file5.txt').write('', ensure=True)
+    paths.work.join('ex ex/file6.text').write('', ensure=True)
+    expected.add('ex ex/file4')
+    expected.add('ex ex/file6.text')
+
+    # double star
+    edata += 'doublestar/**/file*\n'
+    edata += '!**/file3\n'
+    paths.work.join('doublestar/a/b/file1').write('', ensure=True)
+    paths.work.join('doublestar/c/d/file2').write('', ensure=True)
+    paths.work.join('doublestar/e/f/file3').write('', ensure=True)
+    paths.work.join('doublestar/g/h/nomatch').write('', ensure=True)
+    expected.add('doublestar/a/b/file1')
+    expected.add('doublestar/c/d/file2')
+    # doublestar/e/f/file3 is excluded
+
+    return edata, expected
+
+
+@pytest.mark.usefixtures('ds1_repo_copy')
+def test_file_parse_encrypt(runner, paths):
+    """Test parse_encrypt
+
+    Test an array of supported features of the encrypt configuration.
+    """
+
+    # generate test data & expectations
+    edata, expected = create_test_encrypt_data(paths)
+
+    # write encrypt file
+    print(f'ENCRYPT:\n---\n{edata}---\n')
+    paths.encrypt.write(edata)
+    assert paths.encrypt.isfile()
+
+    # run parse_encrypt
+    run = run_parse_encrypt(runner, paths)
+    assert run.success
+    assert run.err == ''
+
+    assert f'EIF_COUNT:{len(expected)}' in run.out, 'EIF count wrong'
+    for expected_file in expected:
+        assert f'EIF:{expected_file}\n' in run.out
+
+    sorted_expectations = '\n'.join(
+        [f'EIF:{exp}' for exp in sorted(expected)])
+    assert sorted_expectations in run.out
+
+
+def run_parse_encrypt(
+        runner, paths,
+        skip_parse=False,
+        twice=False):
+    """Run parse_encrypt
+
+    A count of ENCRYPT_INCLUDE_FILES will be reported as EIF_COUNT:X. All
+    values of ENCRYPT_INCLUDE_FILES will be reported as individual EIF:value
+    lines.
+    """
+    parse_cmd = 'parse_encrypt'
+    if skip_parse:
+        parse_cmd = ''
+    if twice:
+        parse_cmd = 'parse_encrypt; parse_encrypt'
+    script = f"""
+        YADM_TEST=1 source {paths.pgm}
+        YADM_ENCRYPT={paths.encrypt}
+        export YADM_ENCRYPT
+        GIT_DIR={paths.repo}
+        export GIT_DIR
+        YADM_WORK={paths.work}
+        export YADM_WORK
+        {parse_cmd}
+        export ENCRYPT_INCLUDE_FILES
+        export PARSE_ENCRYPT_SHORT
+        env
+        echo EIF_COUNT:${{#ENCRYPT_INCLUDE_FILES[@]}}
+        for value in "${{ENCRYPT_INCLUDE_FILES[@]}}"; do
+            echo "EIF:$value"
+        done
+    """
+    run = runner(command=['bash'], inp=script)
+    return run

test/test_unit_private_dirs.py

@@ -0,0 +1,34 @@
+"""Unit tests: private_dirs"""
+import pytest
+
+
+@pytest.mark.parametrize(
+    'gnupghome',
+    [True, False],
+    ids=['gnupghome-set', 'gnupghome-unset'],
+)
+@pytest.mark.parametrize('param', ['all', 'gnupg'])
+def test_relative_path(runner, paths, gnupghome, param):
+    """Test translate_to_relative"""
+
+    alt_gnupghome = 'alt/gnupghome'
+    env_gnupghome = paths.work.join(alt_gnupghome)
+
+    script = f"""
+        YADM_TEST=1 source {paths.pgm}
+        YADM_WORK={paths.work}
+        private_dirs {param}
+    """
+
+    env = {}
+    if gnupghome:
+        env['GNUPGHOME'] = env_gnupghome
+
+    expected = alt_gnupghome if gnupghome else '.gnupg'
+    if param == 'all':
+        expected = f'.ssh {expected}'
+
+    run = runner(command=['bash'], inp=script, env=env)
+    assert run.success
+    assert run.err == ''
+    assert run.out.strip() == expected

test/test_unit_query_distro.py

@@ -0,0 +1,32 @@
+"""Unit tests: query_distro"""
+import pytest
+
+
+@pytest.mark.parametrize(
+    'condition', ['lsb_release', 'os-release', 'os-release-quotes', 'missing'])
+def test_query_distro(runner, yadm, tst_distro, tmp_path, condition):
+    """Match lsb_release -si when present"""
+    test_release = 'testrelease'
+    lsb_release = ''
+    os_release = tmp_path.joinpath('os-release')
+    if 'os-release' in condition:
+        quotes = '"' if 'quotes' in condition else ''
+        os_release.write_text(
+            f"testing\nID={quotes}{test_release}{quotes}\nrelease")
+    if condition != 'lsb_release':
+        lsb_release = 'LSB_RELEASE_PROGRAM="missing_lsb_release"'
+    script = f"""
+        YADM_TEST=1 source {yadm}
+        {lsb_release}
+        OS_RELEASE="{os_release}"
+        query_distro
+    """
+    run = runner(command=['bash'], inp=script)
+    assert run.success
+    assert run.err == ''
+    if condition == 'lsb_release':
+        assert run.out.rstrip() == tst_distro
+    elif 'os-release' in condition:
+        assert run.out.rstrip() == test_release
+    else:
+        assert run.out.rstrip() == ''

test/test_unit_query_distro_family.py

@@ -0,0 +1,26 @@
+"""Unit tests: query_distro_family"""
+import pytest
+
+
+@pytest.mark.parametrize(
+    'condition', ['os-release', 'os-release-quotes', 'missing'])
+def test_query_distro_family(runner, yadm, tmp_path, condition):
+    """Match ID_LIKE when present"""
+    test_family = 'testfamily'
+    os_release = tmp_path.joinpath('os-release')
+    if 'os-release' in condition:
+        quotes = '"' if 'quotes' in condition else ''
+        os_release.write_text(
+            f"testing\nID_LIKE={quotes}{test_family}{quotes}\nfamily")
+    script = f"""
+        YADM_TEST=1 source {yadm}
+        OS_RELEASE="{os_release}"
+        query_distro_family
+    """
+    run = runner(command=['bash'], inp=script)
+    assert run.success
+    assert run.err == ''
+    if 'os-release' in condition:
+        assert run.out.rstrip() == test_family
+    else:
+        assert run.out.rstrip() == ''

test/test_unit_record_score.py

@@ -0,0 +1,141 @@
+"""Unit tests: record_score"""
+import pytest
+
+INIT_VARS = """
+    score=0
+    local_class=testclass
+    local_system=testsystem
+    local_host=testhost
+    local_user=testuser
+    alt_scores=()
+    alt_targets=()
+    alt_sources=()
+    alt_template_cmds=()
+"""
+
+REPORT_RESULTS = """
+    echo "SIZE:${#alt_scores[@]}"
+    echo "SCORES:${alt_scores[@]}"
+    echo "TARGETS:${alt_targets[@]}"
+    echo "SOURCES:${alt_sources[@]}"
+"""
+
+
+def test_dont_record_zeros(runner, yadm):
+    """Record nothing if the score is zero"""
+
+    script = f"""
+        YADM_TEST=1 source {yadm}
+        {INIT_VARS}
+        record_score "0" "testtgt" "testsrc"
+        {REPORT_RESULTS}
+    """
+    run = runner(command=['bash'], inp=script)
+    assert run.success
+    assert run.err == ''
+    assert 'SIZE:0\n' in run.out
+    assert 'SCORES:\n' in run.out
+    assert 'TARGETS:\n' in run.out
+    assert 'SOURCES:\n' in run.out
+
+
+def test_new_scores(runner, yadm):
+    """Test new scores"""
+
+    script = f"""
+        YADM_TEST=1 source {yadm}
+        {INIT_VARS}
+        record_score "1" "tgt_one"   "src_one"
+        record_score "2" "tgt_two"   "src_two"
+        record_score "4" "tgt_three" "src_three"
+        {REPORT_RESULTS}
+    """
+    run = runner(command=['bash'], inp=script)
+    assert run.success
+    assert run.err == ''
+    assert 'SIZE:3\n' in run.out
+    assert 'SCORES:1 2 4\n' in run.out
+    assert 'TARGETS:tgt_one tgt_two tgt_three\n' in run.out
+    assert 'SOURCES:src_one src_two src_three\n' in run.out
+
+
+@pytest.mark.parametrize('difference', ['lower', 'equal', 'higher'])
+def test_existing_scores(runner, yadm, difference):
+    """Test existing scores"""
+
+    expected_score = '2'
+    expected_src = 'existing_src'
+    if difference == 'lower':
+        score = '1'
+    elif difference == 'equal':
+        score = '2'
+    else:
+        score = '4'
+        expected_score = '4'
+        expected_src = 'new_src'
+
+    script = f"""
+        YADM_TEST=1 source {yadm}
+        {INIT_VARS}
+        alt_scores=(2)
+        alt_targets=("testtgt")
+        alt_sources=("existing_src")
+        record_score "{score}" "testtgt" "new_src"
+        {REPORT_RESULTS}
+    """
+    run = runner(command=['bash'], inp=script)
+    assert run.success
+    assert run.err == ''
+    assert 'SIZE:1\n' in run.out
+    assert f'SCORES:{expected_score}\n' in run.out
+    assert 'TARGETS:testtgt\n' in run.out
+    assert f'SOURCES:{expected_src}\n' in run.out
+
+
+def test_existing_template(runner, yadm):
+    """Record nothing if a template command is registered for this target"""
+
+    script = f"""
+        YADM_TEST=1 source {yadm}
+        {INIT_VARS}
+        alt_scores=(1)
+        alt_targets=("testtgt")
+        alt_sources=()
+        alt_template_cmds=("existing_template")
+        record_score "2" "testtgt" "new_src"
+        {REPORT_RESULTS}
+    """
+    run = runner(command=['bash'], inp=script)
+    assert run.success
+    assert run.err == ''
+    assert 'SIZE:1\n' in run.out
+    assert 'SCORES:1\n' in run.out
+    assert 'TARGETS:testtgt\n' in run.out
+    assert 'SOURCES:\n' in run.out
+
+
+def test_config_first(runner, yadm):
+    """Verify YADM_CONFIG is always processed first"""
+
+    config = 'yadm_config_file'
+    script = f"""
+        YADM_TEST=1 source {yadm}
+        {INIT_VARS}
+        YADM_CONFIG={config}
+        record_score "1" "tgt_before" "src_before"
+        record_template "tgt_tmp" "cmd_tmp" "src_tmp"
+        record_score "2" "{config}"   "src_config"
+        record_score "3" "tgt_after"  "src_after"
+        {REPORT_RESULTS}
+        echo "CMD_VALUE:${{alt_template_cmds[@]}}"
+        echo "CMD_INDEX:${{!alt_template_cmds[@]}}"
+    """
+    run = runner(command=['bash'], inp=script)
+    assert run.success
+    assert run.err == ''
+    assert 'SIZE:3\n' in run.out
+    assert 'SCORES:2 1 3\n' in run.out
+    assert f'TARGETS:{config} tgt_before tgt_tmp tgt_after\n' in run.out
+    assert 'SOURCES:src_config src_before src_tmp src_after\n' in run.out
+    assert 'CMD_VALUE:cmd_tmp\n' in run.out
+    assert 'CMD_INDEX:2\n' in run.out

test/test_unit_record_template.py

@@ -0,0 +1,55 @@
+"""Unit tests: record_template"""
+
+INIT_VARS = """
+    alt_targets=()
+    alt_template_cmds=()
+    alt_sources=()
+"""
+
+REPORT_RESULTS = """
+    echo "SIZE:${#alt_targets[@]}"
+    echo "TARGETS:${alt_targets[@]}"
+    echo "CMDS:${alt_template_cmds[@]}"
+    echo "SOURCES:${alt_sources[@]}"
+"""
+
+
+def test_new_template(runner, yadm):
+    """Test new template"""
+
+    script = f"""
+        YADM_TEST=1 source {yadm}
+        {INIT_VARS}
+        record_template "tgt_one"   "cmd_one"   "src_one"
+        record_template "tgt_two"   "cmd_two"   "src_two"
+        record_template "tgt_three" "cmd_three" "src_three"
+        {REPORT_RESULTS}
+    """
+    run = runner(command=['bash'], inp=script)
+    assert run.success
+    assert run.err == ''
+    assert 'SIZE:3\n' in run.out
+    assert 'TARGETS:tgt_one tgt_two tgt_three\n' in run.out
+    assert 'CMDS:cmd_one cmd_two cmd_three\n' in run.out
+    assert 'SOURCES:src_one src_two src_three\n' in run.out
+
+
+def test_existing_template(runner, yadm):
+    """Overwrite existing templates"""
+
+    script = f"""
+        YADM_TEST=1 source {yadm}
+        {INIT_VARS}
+        alt_targets=("testtgt")
+        alt_template_cmds=("existing_cmd")
+        alt_sources=("existing_src")
+        record_template "testtgt" "new_cmd" "new_src"
+        {REPORT_RESULTS}
+    """
+    run = runner(command=['bash'], inp=script)
+    assert run.success
+    assert run.err == ''
+    assert 'SIZE:1\n' in run.out
+    assert 'TARGETS:testtgt\n' in run.out
+    assert 'CMDS:new_cmd\n' in run.out
+    assert 'SOURCES:new_src\n' in run.out

test/test_unit_relative_path.py

@@ -0,0 +1,31 @@
+"""Unit tests: relative_path"""
+import pytest
+
+
+@pytest.mark.parametrize(
+    'base,full_path,expected',
+    [
+        ("/A/B/C", "/A", "../.."),
+        ("/A/B/C", "/A/B", ".."),
+        ("/A/B/C", "/A/B/C", ""),
+        ("/A/B/C", "/A/B/C/D", "D"),
+        ("/A/B/C", "/A/B/C/D/E", "D/E"),
+        ("/A/B/C", "/A/B/D", "../D"),
+        ("/A/B/C", "/A/B/D/E", "../D/E"),
+        ("/A/B/C", "/A/D", "../../D"),
+        ("/A/B/C", "/A/D/E", "../../D/E"),
+        ("/A/B/C", "/D/E/F", "../../../D/E/F"),
+    ],
+)
+def test_relative_path(runner, paths, base, full_path, expected):
+    """Test translate_to_relative"""
+
+    script = f"""
+        YADM_TEST=1 source {paths.pgm}
+        relative_path "{base}" "{full_path}"
+    """
+
+    run = runner(command=['bash'], inp=script)
+    assert run.success
+    assert run.err == ''
+    assert run.out.strip() == expected

test/test_unit_remove_stale_links.py

@@ -0,0 +1,37 @@
+"""Unit tests: remove_stale_links"""
+import os
+import pytest
+
+
+@pytest.mark.parametrize('linked', [True, False])
+@pytest.mark.parametrize('kind', ['file', 'symlink'])
+def test_remove_stale_links(runner, yadm, tmpdir, kind, linked):
+    """Test remove_stale_links()"""
+
+    source_file = tmpdir.join('source_file')
+    source_file.write('source file', ensure=True)
+    link = tmpdir.join('link')
+
+    if kind == 'file':
+        link.write('link file', ensure=True)
+    else:
+        os.system(f'ln -s {source_file} {link}')
+
+    alt_linked = ''
+    if linked:
+        alt_linked = source_file
+
+    script = f"""
+        YADM_TEST=1 source {yadm}
+        possible_alts=({link})
+        alt_linked=({alt_linked})
+        function rm() {{ echo rm "$@"; }}
+        remove_stale_links
+    """
+
+    run = runner(command=['bash'], inp=script)
+    assert run.err == ''
+    if kind == 'symlink' and not linked:
+        assert f'rm -f {link}' in run.out
+    else:
+        assert run.out == ''

test/test_unit_report_invalid_alts.py

@@ -0,0 +1,30 @@
+"""Unit tests: report_invalid_alts"""
+import pytest
+
+
+@pytest.mark.parametrize('valid', [True, False], ids=['valid', 'no_valid'])
+@pytest.mark.parametrize('previous', [True, False], ids=['prev', 'no_prev'])
+def test_report_invalid_alts(runner, yadm, valid, previous):
+    """Use report_invalid_alts"""
+
+    lwi = ''
+    alts = 'INVALID_ALT=()'
+    if previous:
+        lwi = 'LEGACY_WARNING_ISSUED=1'
+    if not valid:
+        alts = 'INVALID_ALT=("file##invalid")'
+
+    script = f"""
+        YADM_TEST=1 source {yadm}
+        {lwi}
+        {alts}
+        report_invalid_alts
+    """
+    run = runner(command=['bash'], inp=script)
+    assert run.success
+    assert run.out == ''
+    if not valid and not previous:
+        assert 'WARNING' in run.err
+        assert 'file##invalid' in run.err
+    else:
+        assert run.err == ''

test/test_unit_score_file.py

@@ -0,0 +1,351 @@
+"""Unit tests: score_file"""
+import pytest
+
+CONDITION = {
+    'default': {
+        'labels': ['default'],
+        'modifier': 0,
+        },
+    'arch': {
+        'labels': ['a', 'arch'],
+        'modifier': 1,
+        },
+    'system': {
+        'labels': ['o', 'os'],
+        'modifier': 2,
+        },
+    'distro': {
+        'labels': ['d', 'distro'],
+        'modifier': 4,
+        },
+    'distro_family': {
+        'labels': ['f', 'distro_family'],
+        'modifier': 8,
+        },
+    'class': {
+        'labels': ['c', 'class'],
+        'modifier': 16,
+        },
+    'hostname': {
+        'labels': ['h', 'hostname'],
+        'modifier': 32,
+        },
+    'user': {
+        'labels': ['u', 'user'],
+        'modifier': 64,
+        },
+    }
+TEMPLATE_LABELS = ['t', 'template', 'yadm']
+
+
+def calculate_score(filename):
+    """Calculate the expected score"""
+    # pylint: disable=too-many-branches
+    score = 0
+
+    _, conditions = filename.split('##', 1)
+
+    for condition in conditions.split(','):
+        label = condition
+        value = None
+        if '.' in condition:
+            label, value = condition.split('.', 1)
+        if label in CONDITION['default']['labels']:
+            score += 1000
+        elif label in CONDITION['arch']['labels']:
+            if value == 'testarch':
+                score += 1000 + CONDITION['arch']['modifier']
+            else:
+                score = 0
+                break
+        elif label in CONDITION['system']['labels']:
+            if value == 'testsystem':
+                score += 1000 + CONDITION['system']['modifier']
+            else:
+                score = 0
+                break
+        elif label in CONDITION['distro']['labels']:
+            if value == 'testdistro':
+                score += 1000 + CONDITION['distro']['modifier']
+            else:
+                score = 0
+                break
+        elif label in CONDITION['class']['labels']:
+            if value == 'testclass':
+                score += 1000 + CONDITION['class']['modifier']
+            else:
+                score = 0
+                break
+        elif label in CONDITION['hostname']['labels']:
+            if value == 'testhost':
+                score += 1000 + CONDITION['hostname']['modifier']
+            else:
+                score = 0
+                break
+        elif label in CONDITION['user']['labels']:
+            if value == 'testuser':
+                score += 1000 + CONDITION['user']['modifier']
+            else:
+                score = 0
+                break
+        elif label in TEMPLATE_LABELS:
+            score = 0
+            break
+    return score
+
+
+@pytest.mark.parametrize(
+    'default', ['default', None], ids=['default', 'no-default'])
+@pytest.mark.parametrize(
+    'arch', ['arch', None], ids=['arch', 'no-arch'])
+@pytest.mark.parametrize(
+    'system', ['system', None], ids=['system', 'no-system'])
+@pytest.mark.parametrize(
+    'distro', ['distro', None], ids=['distro', 'no-distro'])
+@pytest.mark.parametrize(
+    'cla', ['class', None], ids=['class', 'no-class'])
+@pytest.mark.parametrize(
+    'host', ['hostname', None], ids=['hostname', 'no-host'])
+@pytest.mark.parametrize(
+    'user', ['user', None], ids=['user', 'no-user'])
+def test_score_values(
+        runner, yadm, default, arch, system, distro, cla, host, user):
+    """Test score results"""
+    # pylint: disable=too-many-branches
+    local_class = 'testclass'
+    local_arch = 'testarch'
+    local_system = 'testsystem'
+    local_distro = 'testdistro'
+    local_host = 'testhost'
+    local_user = 'testuser'
+    filenames = {'filename##': 0}
+
+    if default:
+        for filename in list(filenames):
+            for label in CONDITION[default]['labels']:
+                newfile = filename
+                if not newfile.endswith('##'):
+                    newfile += ','
+                newfile += label
+                filenames[newfile] = calculate_score(newfile)
+    if arch:
+        for filename in list(filenames):
+            for match in [True, False]:
+                for label in CONDITION[arch]['labels']:
+                    newfile = filename
+                    if not newfile.endswith('##'):
+                        newfile += ','
+                    newfile += '.'.join([
+                        label,
+                        local_arch if match else 'badarch'
+                        ])
+                    filenames[newfile] = calculate_score(newfile)
+    if system:
+        for filename in list(filenames):
+            for match in [True, False]:
+                for label in CONDITION[system]['labels']:
+                    newfile = filename
+                    if not newfile.endswith('##'):
+                        newfile += ','
+                    newfile += '.'.join([
+                        label,
+                        local_system if match else 'badsys'
+                        ])
+                    filenames[newfile] = calculate_score(newfile)
+    if distro:
+        for filename in list(filenames):
+            for match in [True, False]:
+                for label in CONDITION[distro]['labels']:
+                    newfile = filename
+                    if not newfile.endswith('##'):
+                        newfile += ','
+                    newfile += '.'.join([
+                        label,
+                        local_distro if match else 'baddistro'
+                        ])
+                    filenames[newfile] = calculate_score(newfile)
+    if cla:
+        for filename in list(filenames):
+            for match in [True, False]:
+                for label in CONDITION[cla]['labels']:
+                    newfile = filename
+                    if not newfile.endswith('##'):
+                        newfile += ','
+                    newfile += '.'.join([
+                        label,
+                        local_class if match else 'badclass'
+                        ])
+                    filenames[newfile] = calculate_score(newfile)
+    if host:
+        for filename in list(filenames):
+            for match in [True, False]:
+                for label in CONDITION[host]['labels']:
+                    newfile = filename
+                    if not newfile.endswith('##'):
+                        newfile += ','
+                    newfile += '.'.join([
+                        label,
+                        local_host if match else 'badhost'
+                        ])
+                    filenames[newfile] = calculate_score(newfile)
+    if user:
+        for filename in list(filenames):
+            for match in [True, False]:
+                for label in CONDITION[user]['labels']:
+                    newfile = filename
+                    if not newfile.endswith('##'):
+                        newfile += ','
+                    newfile += '.'.join([
+                        label,
+                        local_user if match else 'baduser'
+                        ])
+                    filenames[newfile] = calculate_score(newfile)
+
+    script = f"""
+        YADM_TEST=1 source {yadm}
+        score=0
+        local_class={local_class}
+        local_classes=({local_class})
+        local_arch={local_arch}
+        local_system={local_system}
+        local_distro={local_distro}
+        local_host={local_host}
+        local_user={local_user}
+    """
+    expected = ''
+    for filename in filenames:
+        script += f"""
+            score_file "{filename}"
+            echo "{filename}"
+            echo "$score"
+        """
+        expected += filename + '\n'
+        expected += str(filenames[filename]) + '\n'
+    run = runner(command=['bash'], inp=script)
+    assert run.success
+    assert run.err == ''
+    assert run.out == expected
+
+
+@pytest.mark.parametrize('ext', [None, 'e', 'extension'])
+def test_extensions(runner, yadm, ext):
+    """Verify extensions do not effect scores"""
+    local_user = 'testuser'
+    filename = f'filename##u.{local_user}'
+    if ext:
+        filename += f',{ext}.xyz'
+    expected = ''
+    script = f"""
+        YADM_TEST=1 source {yadm}
+        score=0
+        local_user={local_user}
+        score_file "{filename}"
+        echo "$score"
+    """
+    expected = f'{1000 + CONDITION["user"]["modifier"]}\n'
+    run = runner(command=['bash'], inp=script)
+    assert run.success
+    assert run.err == ''
+    assert run.out == expected
+
+
+def test_score_values_templates(runner, yadm):
+    """Test score results"""
+    local_class = 'testclass'
+    local_arch = 'arch'
+    local_system = 'testsystem'
+    local_distro = 'testdistro'
+    local_host = 'testhost'
+    local_user = 'testuser'
+    filenames = {'filename##': 0}
+
+    for filename in list(filenames):
+        for label in TEMPLATE_LABELS:
+            newfile = filename
+            if not newfile.endswith('##'):
+                newfile += ','
+            newfile += '.'.join([label, 'testtemplate'])
+            filenames[newfile] = calculate_score(newfile)
+
+    script = f"""
+        YADM_TEST=1 source {yadm}
+        score=0
+        local_class={local_class}
+        local_arch={local_arch}
+        local_system={local_system}
+        local_distro={local_distro}
+        local_host={local_host}
+        local_user={local_user}
+    """
+    expected = ''
+    for filename in filenames:
+        script += f"""
+            score_file "{filename}"
+            echo "{filename}"
+            echo "$score"
+        """
+        expected += filename + '\n'
+        expected += str(filenames[filename]) + '\n'
+    run = runner(command=['bash'], inp=script)
+    assert run.success
+    assert run.err == ''
+    assert run.out == expected
+
+
+@pytest.mark.parametrize(
+    'cmd_generated',
+    [True, False],
+    ids=['supported-template', 'unsupported-template'])
+def test_template_recording(runner, yadm, cmd_generated):
+    """Template should be recorded if choose_template_cmd outputs a command"""
+
+    mock = 'function choose_template_cmd() { return; }'
+    expected = ''
+    if cmd_generated:
+        mock = 'function choose_template_cmd() { echo "test_cmd"; }'
+        expected = 'template recorded'
+
+    script = f"""
+        YADM_TEST=1 source {yadm}
+        function record_template() {{ echo "template recorded"; }}
+        {mock}
+        score_file "testfile##template.kind"
+    """
+    run = runner(command=['bash'], inp=script)
+    assert run.success
+    assert run.err == ''
+    assert run.out.rstrip() == expected
+
+
+def test_underscores_in_distro_and_family(runner, yadm):
+    """Test replacing spaces in distro / distro_family with underscores"""
+    local_distro = 'test distro'
+    local_distro_family = 'test family'
+    filenames = {
+            'filename##distro.test distro': 1004,
+            'filename##distro.test-distro': 0,
+            'filename##distro.test_distro': 1004,
+            'filename##distro_family.test family': 1008,
+            'filename##distro_family.test-family': 0,
+            'filename##distro_family.test_family': 1008,
+            }
+
+    script = f"""
+        YADM_TEST=1 source {yadm}
+        score=0
+        local_distro="{local_distro}"
+        local_distro_family="{local_distro_family}"
+    """
+    expected = ''
+    for filename in filenames:
+        script += f"""
+            score_file "{filename}"
+            echo "{filename}"
+            echo "$score"
+        """
+        expected += filename + '\n'
+        expected += str(filenames[filename]) + '\n'
+    run = runner(command=['bash'], inp=script)
+    assert run.success
+    assert run.err == ''
+    assert run.out == expected

test/test_unit_set_local_alt_values.py

@@ -0,0 +1,92 @@
+"""Unit tests: set_local_alt_values"""
+import pytest
+import utils
+
+
+@pytest.mark.parametrize(
+    'override', [
+        False,
+        'class',
+        'arch',
+        'os',
+        'hostname',
+        'user',
+        ],
+    ids=[
+        'no-override',
+        'override-class',
+        'override-arch',
+        'override-os',
+        'override-hostname',
+        'override-user',
+        ]
+    )
+@pytest.mark.usefixtures('ds1_copy')
+def test_set_local_alt_values(
+        runner, yadm, paths, tst_arch, tst_sys, tst_host, tst_user, override):
+    """Use issue_legacy_path_warning"""
+    script = f"""
+        YADM_TEST=1 source {yadm} &&
+        set_operating_system &&
+        YADM_DIR={paths.yadm} YADM_DATA={paths.data} configure_paths &&
+        set_local_alt_values
+        echo "class='$local_class'"
+        echo "arch='$local_arch'"
+        echo "os='$local_system'"
+        echo "host='$local_host'"
+        echo "user='$local_user'"
+    """
+
+    if override == 'class':
+        utils.set_local(paths, override, 'first')
+        utils.set_local(paths, override, 'override', add=True)
+    elif override:
+        utils.set_local(paths, override, 'override')
+
+    run = runner(command=['bash'], inp=script)
+    assert run.success
+    assert run.err == ''
+
+    if override == 'class':
+        assert "class='override'" in run.out
+    else:
+        assert "class=''" in run.out
+
+    if override == 'arch':
+        assert "arch='override'" in run.out
+    else:
+        assert f"arch='{tst_arch}'" in run.out
+
+    if override == 'os':
+        assert "os='override'" in run.out
+    else:
+        assert f"os='{tst_sys}'" in run.out
+
+    if override == 'hostname':
+        assert "host='override'" in run.out
+    else:
+        assert f"host='{tst_host}'" in run.out
+
+    if override == 'user':
+        assert "user='override'" in run.out
+    else:
+        assert f"user='{tst_user}'" in run.out
+
+
+def test_distro_and_family(runner, yadm):
+    """Assert that local_distro/local_distro_family are set"""
+
+    script = f"""
+        YADM_TEST=1 source {yadm}
+        function config() {{ echo "$1"; }}
+        function query_distro() {{ echo "testdistro"; }}
+        function query_distro_family() {{ echo "testfamily"; }}
+        set_local_alt_values
+        echo "distro='$local_distro'"
+        echo "distro_family='$local_distro_family'"
+    """
+    run = runner(command=['bash'], inp=script)
+    assert run.success
+    assert run.err == ''
+    assert "distro='testdistro'" in run.out
+    assert "distro_family='testfamily'" in run.out

test/test_unit_set_os.py

@@ -0,0 +1,38 @@
+"""Unit tests: set_operating_system"""
+
+import pytest
+
+
+@pytest.mark.parametrize(
+    'proc_value, expected_os', [
+        ('missing', 'uname'),
+        ('has microsoft inside', 'WSL'),  # case insensitive
+        ('has Microsoft inside', 'WSL'),  # case insensitive
+        ('another value', 'uname'),
+    ], ids=[
+        '/proc/version missing',
+        '/proc/version includes ms',
+        '/proc/version excludes Ms',
+        'another value',
+    ])
+def test_set_operating_system(
+        runner, paths, tst_sys, proc_value, expected_os):
+    """Run set_operating_system and test result"""
+
+    # Normally /proc/version (set in PROC_VERSION) is inspected to identify
+    # WSL. During testing, we will override that value.
+    proc_version = paths.root.join('proc_version')
+    if proc_value != 'missing':
+        proc_version.write(proc_value)
+    script = f"""
+        YADM_TEST=1 source {paths.pgm}
+        PROC_VERSION={proc_version}
+        set_operating_system
+        echo $OPERATING_SYSTEM
+    """
+    run = runner(command=['bash'], inp=script)
+    assert run.success
+    assert run.err == ''
+    if expected_os == 'uname':
+        expected_os = tst_sys
+    assert run.out.rstrip() == expected_os

test/test_unit_set_yadm_dir.py

@@ -0,0 +1,48 @@
+"""Unit tests: set_yadm_dirs"""
+import pytest
+
+
+@pytest.mark.parametrize(
+    'condition', [
+        'basic',
+        'override',
+        'override_data',
+        'xdg_config_home',
+        'xdg_data_home'
+        ],
+    )
+def test_set_yadm_dirs(runner, yadm, condition):
+    """Test set_yadm_dirs"""
+    setup = ''
+    if condition == 'override':
+        setup = 'YADM_DIR=/override'
+    elif condition == 'override_data':
+        setup = 'YADM_DATA=/override'
+    elif condition == 'xdg_config_home':
+        setup = 'XDG_CONFIG_HOME=/xdg'
+    elif condition == 'xdg_data_home':
+        setup = 'XDG_DATA_HOME=/xdg'
+    script = f"""
+        HOME=/testhome
+        YADM_TEST=1 source {yadm}
+        XDG_CONFIG_HOME=
+        XDG_DATA_HOME=
+        {setup}
+        set_yadm_dirs
+        echo "YADM_DIR=$YADM_DIR"
+        echo "YADM_DATA=$YADM_DATA"
+    """
+    run = runner(command=['bash'], inp=script)
+    assert run.success
+    assert run.err == ''
+    if condition == 'basic':
+        assert 'YADM_DIR=/testhome/.config/yadm' in run.out
+        assert 'YADM_DATA=/testhome/.local/share/yadm' in run.out
+    elif condition == 'override':
+        assert 'YADM_DIR=/override' in run.out
+    elif condition == 'override_data':
+        assert 'YADM_DATA=/override' in run.out
+    elif condition == 'xdg_config_home':
+        assert 'YADM_DIR=/xdg/yadm' in run.out
+    elif condition == 'xdg_data_home':
+        assert 'YADM_DATA=/xdg/yadm' in run.out

test/test_unit_template_default.py

@@ -0,0 +1,262 @@
+"""Unit tests: template_default"""
+import os
+
+FILE_MODE = 0o754
+
+# these values are also testing the handling of bizarre characters
+LOCAL_CLASS = "default_Test+@-!^Class"
+LOCAL_CLASS2 = "default_Test+@-|^2nd_Class withSpace"
+LOCAL_ARCH = "default_Test+@-!^Arch"
+LOCAL_SYSTEM = "default_Test+@-!^System"
+LOCAL_HOST = "default_Test+@-!^Host"
+LOCAL_USER = "default_Test+@-!^User"
+LOCAL_DISTRO = "default_Test+@-!^Distro"
+LOCAL_DISTRO_FAMILY = "default_Test+@-!^Family"
+TEMPLATE = f'''
+start of template
+default class         = >{{{{yadm.class}}}}<
+default arch          = >{{{{yadm.arch}}}}<
+default os            = >{{{{yadm.os}}}}<
+default host          = >{{{{yadm.hostname}}}}<
+default user          = >{{{{yadm.user}}}}<
+default distro        = >{{{{yadm.distro}}}}<
+default distro_family = >{{{{yadm.distro_family}}}}<
+classes = >{{{{yadm.classes}}}}<
+{{% if yadm.class == "else1" %}}
+wrong else 1
+{{% else %}}
+Included section from else
+{{% endif %}}
+{{% if yadm.class == "wrongclass1" %}}
+wrong class 1
+{{% endif %}}
+{{% if yadm.class == "{LOCAL_CLASS}" %}}
+Included section for class = {{{{yadm.class}}}} ({{{{yadm.class}}}} repeated)
+Multiple lines
+{{% else %}}
+Should not be included...
+{{% endif %}}
+{{% if yadm.class == "{LOCAL_CLASS2}" %}}
+Included section for second class
+{{% endif %}}
+{{% if yadm.class == "wrongclass2" %}}
+wrong class 2
+{{% endif %}}
+{{% if yadm.arch == "wrongarch1" %}}
+wrong arch 1
+{{% endif %}}
+{{% if yadm.arch == "{LOCAL_ARCH}" %}}
+Included section for arch = {{{{yadm.arch}}}} ({{{{yadm.arch}}}} repeated)
+{{% endif %}}
+{{% if yadm.arch == "wrongarch2" %}}
+wrong arch 2
+{{% endif %}}
+{{% if yadm.os == "wrongos1" %}}
+wrong os 1
+{{% endif %}}
+{{% if yadm.os == "{LOCAL_SYSTEM}" %}}
+Included section for os = {{{{yadm.os}}}} ({{{{yadm.os}}}} repeated)
+{{% endif %}}
+{{% if yadm.os == "wrongos2" %}}
+wrong os 2
+{{% endif %}}
+{{% if yadm.hostname == "wronghost1" %}}
+wrong host 1
+{{% endif %}}
+{{% if yadm.hostname == "{LOCAL_HOST}" %}}
+Included section for host = {{{{yadm.hostname}}}} ({{{{yadm.hostname}}}} again)
+{{% endif %}}
+{{% if yadm.hostname == "wronghost2" %}}
+wrong host 2
+{{% endif %}}
+{{% if yadm.user == "wronguser1" %}}
+wrong user 1
+{{% endif %}}
+{{% if yadm.user == "{LOCAL_USER}" %}}
+Included section for user = {{{{yadm.user}}}} ({{{{yadm.user}}}} repeated)
+{{% endif %}}
+{{% if yadm.user == "wronguser2" %}}
+wrong user 2
+{{% endif %}}
+{{% if yadm.distro == "wrongdistro1" %}}
+wrong distro 1
+{{% endif %}}
+{{% if yadm.distro == "{LOCAL_DISTRO}" %}}
+Included section for distro = {{{{yadm.distro}}}} ({{{{yadm.distro}}}} again)
+{{% endif %}}
+{{% if yadm.distro == "wrongdistro2" %}}
+wrong distro 2
+{{% endif %}}
+{{% if yadm.distro_family == "wrongfamily1" %}}
+wrong family 1
+{{% endif %}}
+{{% if yadm.distro_family == "{LOCAL_DISTRO_FAMILY}" %}}
+Included section for distro_family = \
+{{{{yadm.distro_family}}}} ({{{{yadm.distro_family}}}} again)
+{{% endif %}}
+{{% if yadm.distro_family == "wrongfamily2" %}}
+wrong family 2
+{{% endif %}}
+end of template
+'''
+EXPECTED = f'''
+start of template
+default class         = >{LOCAL_CLASS}<
+default arch          = >{LOCAL_ARCH}<
+default os            = >{LOCAL_SYSTEM}<
+default host          = >{LOCAL_HOST}<
+default user          = >{LOCAL_USER}<
+default distro        = >{LOCAL_DISTRO}<
+default distro_family = >{LOCAL_DISTRO_FAMILY}<
+classes = >{LOCAL_CLASS2}
+{LOCAL_CLASS}<
+Included section from else
+Included section for class = {LOCAL_CLASS} ({LOCAL_CLASS} repeated)
+Multiple lines
+Included section for second class
+Included section for arch = {LOCAL_ARCH} ({LOCAL_ARCH} repeated)
+Included section for os = {LOCAL_SYSTEM} ({LOCAL_SYSTEM} repeated)
+Included section for host = {LOCAL_HOST} ({LOCAL_HOST} again)
+Included section for user = {LOCAL_USER} ({LOCAL_USER} repeated)
+Included section for distro = {LOCAL_DISTRO} ({LOCAL_DISTRO} again)
+Included section for distro_family = \
+{LOCAL_DISTRO_FAMILY} ({LOCAL_DISTRO_FAMILY} again)
+end of template
+'''
+
+INCLUDE_BASIC = 'basic\n'
+INCLUDE_VARIABLES = '''\
+included <{{ yadm.class }}> file
+
+empty line above
+'''
+INCLUDE_NESTED = 'no newline at the end'
+
+TEMPLATE_INCLUDE = '''\
+The first line
+{% include empty %}
+An empty file removes the line above
+{%include basic%}
+{% include "./variables.{{ yadm.os }}"  %}
+{% include dir/nested %}
+Include basic again:
+{% include basic %}
+'''
+EXPECTED_INCLUDE = f'''\
+The first line
+An empty file removes the line above
+basic
+included <{LOCAL_CLASS}> file
+
+empty line above
+no newline at the end
+Include basic again:
+basic
+'''
+
+
+def test_template_default(runner, yadm, tmpdir):
+    """Test template_default"""
+
+    input_file = tmpdir.join('input')
+    input_file.write(TEMPLATE, ensure=True)
+    input_file.chmod(FILE_MODE)
+    output_file = tmpdir.join('output')
+
+    # ensure overwrite works when file exists as read-only (there is some
+    # special processing when this is encountered because some environments do
+    # not properly overwrite read-only files)
+    output_file.write('existing')
+    output_file.chmod(0o400)
+
+    script = f"""
+        YADM_TEST=1 source {yadm}
+        set_awk
+        local_class="{LOCAL_CLASS}"
+        local_classes=("{LOCAL_CLASS2}" "{LOCAL_CLASS}")
+        local_arch="{LOCAL_ARCH}"
+        local_system="{LOCAL_SYSTEM}"
+        local_host="{LOCAL_HOST}"
+        local_user="{LOCAL_USER}"
+        local_distro="{LOCAL_DISTRO}"
+        local_distro_family="{LOCAL_DISTRO_FAMILY}"
+        template_default "{input_file}" "{output_file}"
+    """
+    run = runner(command=['bash'], inp=script)
+    assert run.success
+    assert run.err == ''
+    assert output_file.read() == EXPECTED
+    assert os.stat(output_file).st_mode == os.stat(input_file).st_mode
+
+
+def test_source(runner, yadm, tmpdir):
+    """Test yadm.source"""
+
+    input_file = tmpdir.join('input')
+    input_file.write('{{yadm.source}}', ensure=True)
+    input_file.chmod(FILE_MODE)
+    output_file = tmpdir.join('output')
+
+    script = f"""
+        YADM_TEST=1 source {yadm}
+        set_awk
+        template_default "{input_file}" "{output_file}"
+    """
+    run = runner(command=['bash'], inp=script)
+    assert run.success
+    assert run.err == ''
+    assert output_file.read().strip() == str(input_file)
+    assert os.stat(output_file).st_mode == os.stat(input_file).st_mode
+
+
+def test_include(runner, yadm, tmpdir):
+    """Test include"""
+
+    empty_file = tmpdir.join('empty')
+    empty_file.write('', ensure=True)
+
+    basic_file = tmpdir.join('basic')
+    basic_file.write(INCLUDE_BASIC)
+
+    variables_file = tmpdir.join(f'variables.{LOCAL_SYSTEM}')
+    variables_file.write(INCLUDE_VARIABLES)
+
+    nested_file = tmpdir.join('dir').join('nested')
+    nested_file.write(INCLUDE_NESTED, ensure=True)
+
+    input_file = tmpdir.join('input')
+    input_file.write(TEMPLATE_INCLUDE)
+    input_file.chmod(FILE_MODE)
+    output_file = tmpdir.join('output')
+
+    script = f"""
+        YADM_TEST=1 source {yadm}
+        set_awk
+        local_class="{LOCAL_CLASS}"
+        local_system="{LOCAL_SYSTEM}"
+        template_default "{input_file}" "{output_file}"
+    """
+    run = runner(command=['bash'], inp=script)
+    assert run.success
+    assert run.err == ''
+    assert output_file.read() == EXPECTED_INCLUDE
+    assert os.stat(output_file).st_mode == os.stat(input_file).st_mode
+
+
+def test_env(runner, yadm, tmpdir):
+    """Test env"""
+
+    input_file = tmpdir.join('input')
+    input_file.write('{{env.PWD}}', ensure=True)
+    input_file.chmod(FILE_MODE)
+    output_file = tmpdir.join('output')
+
+    script = f"""
+        YADM_TEST=1 source {yadm}
+        set_awk
+        template_default "{input_file}" "{output_file}"
+    """
+    run = runner(command=['bash'], inp=script)
+    assert run.success
+    assert run.err == ''
+    assert output_file.read().strip() == os.environ['PWD']

test/test_unit_template_esh.py

@@ -0,0 +1,166 @@
+"""Unit tests: template_esh"""
+import os
+
+FILE_MODE = 0o754
+
+LOCAL_CLASS = "esh_Test+@-!^Class"
+LOCAL_CLASS2 = "esh_Test+@-|^2nd_Class withSpace"
+LOCAL_ARCH = "esh_Test+@-!^Arch"
+LOCAL_SYSTEM = "esh_Test+@-!^System"
+LOCAL_HOST = "esh_Test+@-!^Host"
+LOCAL_USER = "esh_Test+@-!^User"
+LOCAL_DISTRO = "esh_Test+@-!^Distro"
+LOCAL_DISTRO_FAMILY = "esh_Test+@-!^Family"
+TEMPLATE = f'''
+start of template
+esh class         = ><%=$YADM_CLASS%><
+esh arch          = ><%=$YADM_ARCH%><
+esh os            = ><%=$YADM_OS%><
+esh host          = ><%=$YADM_HOSTNAME%><
+esh user          = ><%=$YADM_USER%><
+esh distro        = ><%=$YADM_DISTRO%><
+esh distro_family = ><%=$YADM_DISTRO_FAMILY%><
+esh classes = ><%=$YADM_CLASSES%><
+<% if [ "$YADM_CLASS" = "wrongclass1" ]; then -%>
+wrong class 1
+<% fi -%>
+<% if [ "$YADM_CLASS" = "{LOCAL_CLASS}" ]; then -%>
+Included esh section for class = <%=$YADM_CLASS%> (<%=$YADM_CLASS%> repeated)
+<% fi -%>
+<% if [ "$YADM_CLASS" = "wrongclass2" ]; then -%>
+wrong class 2
+<% fi -%>
+<% echo "$YADM_CLASSES" | while IFS='' read cls; do
+   if [ "$cls" = "{LOCAL_CLASS2}" ]; then -%>
+Included esh section for second class
+<% fi; done -%>
+<% if [ "$YADM_ARCH" = "wrongarch1" ]; then -%>
+wrong arch 1
+<% fi -%>
+<% if [ "$YADM_ARCH" = "{LOCAL_ARCH}" ]; then -%>
+Included esh section for arch = <%=$YADM_ARCH%> (<%=$YADM_ARCH%> repeated)
+<% fi -%>
+<% if [ "$YADM_ARCH" = "wrongarch2" ]; then -%>
+wrong arch 2
+<% fi -%>
+<% if [ "$YADM_OS" = "wrongos1" ]; then -%>
+wrong os 1
+<% fi -%>
+<% if [ "$YADM_OS" = "{LOCAL_SYSTEM}" ]; then -%>
+Included esh section for os = <%=$YADM_OS%> (<%=$YADM_OS%> repeated)
+<% fi -%>
+<% if [ "$YADM_OS" = "wrongos2" ]; then -%>
+wrong os 2
+<% fi -%>
+<% if [ "$YADM_HOSTNAME" = "wronghost1" ]; then -%>
+wrong host 1
+<% fi -%>
+<% if [ "$YADM_HOSTNAME" = "{LOCAL_HOST}" ]; then -%>
+Included esh section for host = <%=$YADM_HOSTNAME%> (<%=$YADM_HOSTNAME%> again)
+<% fi -%>
+<% if [ "$YADM_HOSTNAME" = "wronghost2" ]; then -%>
+wrong host 2
+<% fi -%>
+<% if [ "$YADM_USER" = "wronguser1" ]; then -%>
+wrong user 1
+<% fi -%>
+<% if [ "$YADM_USER" = "{LOCAL_USER}" ]; then -%>
+Included esh section for user = <%=$YADM_USER%> (<%=$YADM_USER%> repeated)
+<% fi -%>
+<% if [ "$YADM_USER" = "wronguser2" ]; then -%>
+wrong user 2
+<% fi -%>
+<% if [ "$YADM_DISTRO" = "wrongdistro1" ]; then -%>
+wrong distro 1
+<% fi -%>
+<% if [ "$YADM_DISTRO" = "{LOCAL_DISTRO}" ]; then -%>
+Included esh section for distro = <%=$YADM_DISTRO%> (<%=$YADM_DISTRO%> again)
+<% fi -%>
+<% if [ "$YADM_DISTRO" = "wrongdistro2" ]; then -%>
+wrong distro 2
+<% fi -%>
+<% if [ "$YADM_DISTRO_FAMILY" = "wrongfamily1" ]; then -%>
+wrong family 1
+<% fi -%>
+<% if [ "$YADM_DISTRO_FAMILY" = "{LOCAL_DISTRO_FAMILY}" ]; then -%>
+Included esh section for distro_family = \
+<%=$YADM_DISTRO_FAMILY%> (<%=$YADM_DISTRO_FAMILY%> again)
+<% fi -%>
+<% if [ "$YADM_DISTRO" = "wrongfamily2" ]; then -%>
+wrong family 2
+<% fi -%>
+end of template
+'''
+EXPECTED = f'''
+start of template
+esh class         = >{LOCAL_CLASS}<
+esh arch          = >{LOCAL_ARCH}<
+esh os            = >{LOCAL_SYSTEM}<
+esh host          = >{LOCAL_HOST}<
+esh user          = >{LOCAL_USER}<
+esh distro        = >{LOCAL_DISTRO}<
+esh distro_family = >{LOCAL_DISTRO_FAMILY}<
+esh classes = >{LOCAL_CLASS2} {LOCAL_CLASS}<
+Included esh section for class = {LOCAL_CLASS} ({LOCAL_CLASS} repeated)
+Included esh section for second class
+Included esh section for arch = {LOCAL_ARCH} ({LOCAL_ARCH} repeated)
+Included esh section for os = {LOCAL_SYSTEM} ({LOCAL_SYSTEM} repeated)
+Included esh section for host = {LOCAL_HOST} ({LOCAL_HOST} again)
+Included esh section for user = {LOCAL_USER} ({LOCAL_USER} repeated)
+Included esh section for distro = {LOCAL_DISTRO} ({LOCAL_DISTRO} again)
+Included esh section for distro_family = \
+{LOCAL_DISTRO_FAMILY} ({LOCAL_DISTRO_FAMILY} again)
+end of template
+'''
+
+
+def test_template_esh(runner, yadm, tmpdir):
+    """Test processing by esh"""
+
+    input_file = tmpdir.join('input')
+    input_file.write(TEMPLATE, ensure=True)
+    input_file.chmod(FILE_MODE)
+    output_file = tmpdir.join('output')
+
+    # ensure overwrite works when file exists as read-only (there is some
+    # special processing when this is encountered because some environments do
+    # not properly overwrite read-only files)
+    output_file.write('existing')
+    output_file.chmod(0o400)
+
+    script = f"""
+        YADM_TEST=1 source {yadm}
+        local_class="{LOCAL_CLASS}"
+        local_classes=("{LOCAL_CLASS2}" "{LOCAL_CLASS}")
+        local_arch="{LOCAL_ARCH}"
+        local_system="{LOCAL_SYSTEM}"
+        local_host="{LOCAL_HOST}"
+        local_user="{LOCAL_USER}"
+        local_distro="{LOCAL_DISTRO}"
+        local_distro_family="{LOCAL_DISTRO_FAMILY}"
+        template_esh "{input_file}" "{output_file}"
+    """
+    run = runner(command=['bash'], inp=script)
+    assert run.success
+    assert run.err == ''
+    assert output_file.read().strip() == str(EXPECTED).strip()
+    assert os.stat(output_file).st_mode == os.stat(input_file).st_mode
+
+
+def test_source(runner, yadm, tmpdir):
+    """Test YADM_SOURCE"""
+
+    input_file = tmpdir.join('input')
+    input_file.write('<%= $YADM_SOURCE %>', ensure=True)
+    input_file.chmod(FILE_MODE)
+    output_file = tmpdir.join('output')
+
+    script = f"""
+        YADM_TEST=1 source {yadm}
+        template_esh "{input_file}" "{output_file}"
+    """
+    run = runner(command=['bash'], inp=script)
+    assert run.success
+    assert run.err == ''
+    assert output_file.read().strip() == str(input_file)
+    assert os.stat(output_file).st_mode == os.stat(input_file).st_mode

test/test_unit_template_j2.py

@@ -0,0 +1,172 @@
+"""Unit tests: template_j2cli & template_envtpl"""
+import os
+import pytest
+
+FILE_MODE = 0o754
+
+LOCAL_CLASS = "j2_Test+@-!^Class"
+LOCAL_CLASS2 = "j2_Test+@-|^2nd_Class withSpace"
+LOCAL_ARCH = "j2_Test+@-!^Arch"
+LOCAL_SYSTEM = "j2_Test+@-!^System"
+LOCAL_HOST = "j2_Test+@-!^Host"
+LOCAL_USER = "j2_Test+@-!^User"
+LOCAL_DISTRO = "j2_Test+@-!^Distro"
+LOCAL_DISTRO_FAMILY = "j2_Test+@-!^Family"
+TEMPLATE = f'''
+start of template
+j2 class         = >{{{{YADM_CLASS}}}}<
+j2 arch          = >{{{{YADM_ARCH}}}}<
+j2 os            = >{{{{YADM_OS}}}}<
+j2 host          = >{{{{YADM_HOSTNAME}}}}<
+j2 user          = >{{{{YADM_USER}}}}<
+j2 distro        = >{{{{YADM_DISTRO}}}}<
+j2 distro_family = >{{{{YADM_DISTRO_FAMILY}}}}<
+j2 classes = >{{{{YADM_CLASSES}}}}<
+{{%- if YADM_CLASS == "wrongclass1" %}}
+wrong class 1
+{{%- endif %}}
+{{%- if YADM_CLASS == "{LOCAL_CLASS}" %}}
+Included j2 section for class = \
+{{{{YADM_CLASS}}}} ({{{{YADM_CLASS}}}} repeated)
+{{%- endif %}}
+{{%- if YADM_CLASS == "wrongclass2" %}}
+wrong class 2
+{{%- endif %}}
+{{%- if "{LOCAL_CLASS2}" in YADM_CLASSES.split("\\n") %}}
+Included j2 section for second class
+{{%- endif %}}
+{{%- if YADM_ARCH == "wrongarch1" %}}
+wrong arch 1
+{{%- endif %}}
+{{%- if YADM_ARCH == "{LOCAL_ARCH}" %}}
+Included j2 section for arch = {{{{YADM_ARCH}}}} ({{{{YADM_ARCH}}}} repeated)
+{{%- endif %}}
+{{%- if YADM_ARCH == "wrongarch2" %}}
+wrong arch 2
+{{%- endif %}}
+{{%- if YADM_OS == "wrongos1" %}}
+wrong os 1
+{{%- endif %}}
+{{%- if YADM_OS == "{LOCAL_SYSTEM}" %}}
+Included j2 section for os = {{{{YADM_OS}}}} ({{{{YADM_OS}}}} repeated)
+{{%- endif %}}
+{{%- if YADM_OS == "wrongos2" %}}
+wrong os 2
+{{%- endif %}}
+{{%- if YADM_HOSTNAME == "wronghost1" %}}
+wrong host 1
+{{%- endif %}}
+{{%- if YADM_HOSTNAME == "{LOCAL_HOST}" %}}
+Included j2 section for host = \
+{{{{YADM_HOSTNAME}}}} ({{{{YADM_HOSTNAME}}}} again)
+{{%- endif %}}
+{{%- if YADM_HOSTNAME == "wronghost2" %}}
+wrong host 2
+{{%- endif %}}
+{{%- if YADM_USER == "wronguser1" %}}
+wrong user 1
+{{%- endif %}}
+{{%- if YADM_USER == "{LOCAL_USER}" %}}
+Included j2 section for user = {{{{YADM_USER}}}} ({{{{YADM_USER}}}} repeated)
+{{%- endif %}}
+{{%- if YADM_USER == "wronguser2" %}}
+wrong user 2
+{{%- endif %}}
+{{%- if YADM_DISTRO == "wrongdistro1" %}}
+wrong distro 1
+{{%- endif %}}
+{{%- if YADM_DISTRO == "{LOCAL_DISTRO}" %}}
+Included j2 section for distro = \
+{{{{YADM_DISTRO}}}} ({{{{YADM_DISTRO}}}} again)
+{{%- endif %}}
+{{%- if YADM_DISTRO == "wrongdistro2" %}}
+wrong distro 2
+{{%- endif %}}
+{{%- if YADM_DISTRO_FAMILY == "wrongfamily1" %}}
+wrong family 1
+{{%- endif %}}
+{{%- if YADM_DISTRO_FAMILY == "{LOCAL_DISTRO_FAMILY}" %}}
+Included j2 section for distro_family = \
+{{{{YADM_DISTRO_FAMILY}}}} ({{{{YADM_DISTRO_FAMILY}}}} again)
+{{%- endif %}}
+{{%- if YADM_DISTRO_FAMILY == "wrongfamily2" %}}
+wrong family 2
+{{%- endif %}}
+end of template
+'''
+EXPECTED = f'''
+start of template
+j2 class         = >{LOCAL_CLASS}<
+j2 arch          = >{LOCAL_ARCH}<
+j2 os            = >{LOCAL_SYSTEM}<
+j2 host          = >{LOCAL_HOST}<
+j2 user          = >{LOCAL_USER}<
+j2 distro        = >{LOCAL_DISTRO}<
+j2 distro_family = >{LOCAL_DISTRO_FAMILY}<
+j2 classes = >{LOCAL_CLASS2}
+{LOCAL_CLASS}<
+Included j2 section for class = {LOCAL_CLASS} ({LOCAL_CLASS} repeated)
+Included j2 section for second class
+Included j2 section for arch = {LOCAL_ARCH} ({LOCAL_ARCH} repeated)
+Included j2 section for os = {LOCAL_SYSTEM} ({LOCAL_SYSTEM} repeated)
+Included j2 section for host = {LOCAL_HOST} ({LOCAL_HOST} again)
+Included j2 section for user = {LOCAL_USER} ({LOCAL_USER} repeated)
+Included j2 section for distro = {LOCAL_DISTRO} ({LOCAL_DISTRO} again)
+Included j2 section for distro_family = \
+{LOCAL_DISTRO_FAMILY} ({LOCAL_DISTRO_FAMILY} again)
+end of template
+'''
+
+
+@pytest.mark.parametrize('processor', ('j2cli', 'envtpl'))
+def test_template_j2(runner, yadm, tmpdir, processor):
+    """Test processing by j2cli & envtpl"""
+
+    input_file = tmpdir.join('input')
+    input_file.write(TEMPLATE, ensure=True)
+    input_file.chmod(FILE_MODE)
+    output_file = tmpdir.join('output')
+
+    # ensure overwrite works when file exists as read-only (there is some
+    # special processing when this is encountered because some environments do
+    # not properly overwrite read-only files)
+    output_file.write('existing')
+    output_file.chmod(0o400)
+
+    script = f"""
+        YADM_TEST=1 source {yadm}
+        local_class="{LOCAL_CLASS}"
+        local_classes=("{LOCAL_CLASS2}" "{LOCAL_CLASS}")
+        local_arch="{LOCAL_ARCH}"
+        local_system="{LOCAL_SYSTEM}"
+        local_host="{LOCAL_HOST}"
+        local_user="{LOCAL_USER}"
+        local_distro="{LOCAL_DISTRO}"
+        local_distro_family="{LOCAL_DISTRO_FAMILY}"
+        template_{processor} "{input_file}" "{output_file}"
+    """
+    run = runner(command=['bash'], inp=script)
+    assert run.success
+    assert run.err == ''
+    assert output_file.read() == EXPECTED
+    assert os.stat(output_file).st_mode == os.stat(input_file).st_mode
+
+
+@pytest.mark.parametrize('processor', ('j2cli', 'envtpl'))
+def test_source(runner, yadm, tmpdir, processor):
+    """Test YADM_SOURCE"""
+
+    input_file = tmpdir.join('input')
+    input_file.write('{{YADM_SOURCE}}', ensure=True)
+    input_file.chmod(FILE_MODE)
+    output_file = tmpdir.join('output')
+
+    script = f"""
+        YADM_TEST=1 source {yadm}
+        template_{processor} "{input_file}" "{output_file}"
+    """
+    run = runner(command=['bash'], inp=script)
+    assert run.success
+    assert run.err == ''
+    assert output_file.read().strip() == str(input_file)
+    assert os.stat(output_file).st_mode == os.stat(input_file).st_mode

test/test_unit_upgrade.py

@@ -0,0 +1,122 @@
+"""Unit tests: upgrade"""
+import pytest
+
+
+@pytest.mark.parametrize('condition', ['override', 'equal', 'existing_repo'])
+def test_upgrade_errors(tmpdir, runner, yadm, condition):
+    """Test upgrade() error conditions"""
+
+    home = tmpdir.mkdir('home')
+    yadm_dir = home.join('.config/yadm')
+    yadm_data = home.join('.local/share/yadm')
+    override = ''
+    if condition == 'override':
+        override = 'override'
+    if condition == 'equal':
+        yadm_data = yadm_dir
+    if condition == 'existing_repo':
+        yadm_dir.ensure_dir('repo.git')
+        yadm_data.ensure_dir('repo.git')
+
+    script = f"""
+        YADM_TEST=1 source {yadm}
+        YADM_DIR="{yadm_dir}"
+        YADM_DATA="{yadm_data}"
+        YADM_REPO="{yadm_data}/repo.git"
+        YADM_LEGACY_ARCHIVE="files.gpg"
+        YADM_OVERRIDE_REPO="{override}"
+        upgrade
+    """
+    run = runner(command=['bash'], inp=script)
+    assert run.failure
+    assert 'Unable to upgrade' in run.err
+    if condition in ['override', 'equal']:
+        assert 'Paths have been overridden' in run.err
+    elif condition == 'existing_repo':
+        assert 'already exists' in run.err
+
+
+@pytest.mark.parametrize(
+    'condition', ['no-paths', 'untracked', 'tracked', 'submodules'])
+def test_upgrade(tmpdir, runner, yadm, condition):
+    """Test upgrade()
+
+    When testing the condition of git-tracked data, "echo" will be used as a
+    mock for git. echo will return true, simulating a positive result from "git
+    ls-files". Also echo will report the parameters for "git mv".
+    """
+    legacy_paths = ('config', 'encrypt', 'bootstrap', 'hooks/pre_cmd')
+    home = tmpdir.mkdir('home')
+    yadm_dir = home.join('.config/yadm')
+    yadm_data = home.join('.local/share/yadm')
+    yadm_legacy = home.join('.yadm')
+
+    if condition != 'no-paths':
+        yadm_dir.join('repo.git/config').write('test-repo', ensure=True)
+        yadm_dir.join('files.gpg').write('files.gpg', ensure=True)
+        for path in legacy_paths:
+            yadm_legacy.join(path).write(path, ensure=True)
+
+    mock_git = ""
+    if condition != 'no-paths':
+        mock_git = f'''
+            function git() {{
+                echo "$@"
+                if [[ "$*" = *"submodule status" ]]; then
+                    { 'echo " 1234567 mymodule (1.0)"'
+                        if condition == 'submodules' else ':' }
+                fi
+                if [[ "$*" = *ls-files* ]]; then
+                    return { 1 if condition == 'untracked' else 0 }
+                fi
+                return 0
+            }}
+        '''
+
+    script = f"""
+        YADM_TEST=1 source {yadm}
+        YADM_LEGACY_DIR="{yadm_legacy}"
+        YADM_DIR="{yadm_dir}"
+        YADM_DATA="{yadm_data}"
+        YADM_REPO="{yadm_data}/repo.git"
+        YADM_ARCHIVE="{yadm_data}/archive"
+        GIT_PROGRAM="git"
+        {mock_git}
+        function cd {{ echo "$@";}}
+        upgrade
+    """
+    run = runner(command=['bash'], inp=script)
+    assert run.success
+    assert run.err == ''
+    if condition == 'no-paths':
+        assert 'Upgrade is not necessary' in run.out
+    else:
+        for (lpath, npath) in [
+                ('repo.git', 'repo.git'), ('files.gpg', 'archive')]:
+            expected = (
+                f'Moving {yadm_dir.join(lpath)} '
+                f'to {yadm_data.join(npath)}')
+            assert expected in run.out
+        for path in legacy_paths:
+            expected = (
+                f'Moving {yadm_legacy.join(path)} '
+                f'to {yadm_dir.join(path)}')
+            assert expected in run.out
+        if condition == 'untracked':
+            assert 'test-repo' in yadm_data.join('repo.git/config').read()
+            assert 'files.gpg' in yadm_data.join('archive').read()
+            for path in legacy_paths:
+                assert path in yadm_dir.join(path).read()
+        elif condition in ['tracked', 'submodules']:
+            expected = (
+                f'mv {yadm_dir.join("files.gpg")} '
+                f'{yadm_data.join("archive")}')
+            assert expected in run.out
+            assert 'files tracked by yadm have been renamed' in run.out
+            if condition == 'submodules':
+                assert 'submodule deinit -- mymodule' in run.out
+                assert 'submodule update --init --recursive -- mymodule' \
+                    in run.out
+            else:
+                assert 'submodule deinit' not in run.out
+                assert 'submodule update --init --recursive' not in run.out

test/test_unit_x_program.py

@@ -0,0 +1,48 @@
+"""Unit tests: yadm.[git,gpg]-program"""
+
+import os
+import pytest
+
+
+@pytest.mark.parametrize(
+    'executable, success, value, match', [
+        (None, True, 'program', None),
+        ('cat', True, 'cat', None),
+        ('badprogram', False, None, 'badprogram'),
+    ], ids=[
+        'executable missing',
+        'valid alternative',
+        'invalid alternative',
+    ])
+@pytest.mark.parametrize('program', ['git', 'gpg'])
+def test_x_program(
+        runner, yadm_cmd, paths, program, executable, success, value, match):
+    """Set yadm.X-program, and test result of require_X"""
+
+    # set configuration
+    if executable:
+        os.system(' '.join(yadm_cmd(
+            'config', f'yadm.{program}-program', executable)))
+
+    # test require_[git,gpg]
+    script = f"""
+        YADM_TEST=1 source {paths.pgm}
+        YADM_OVERRIDE_CONFIG="{paths.config}"
+        configure_paths
+        require_{program}
+        echo ${program.upper()}_PROGRAM
+    """
+    run = runner(command=['bash'], inp=script)
+    assert run.success == success
+
+    # [GIT,GPG]_PROGRAM set correctly
+    if value == 'program':
+        assert run.out.rstrip() == program
+    elif value:
+        assert run.out.rstrip() == value
+
+    # error reported about bad config
+    if match:
+        assert match in run.err
+    else:
+        assert run.err == ''

test/test_upgrade.py

@@ -0,0 +1,129 @@
+"""Test upgrade"""
+
+import os
+import pytest
+
+
+@pytest.mark.parametrize(
+    'versions', [
+        ('1.12.0', '2.5.0'),
+        ('1.12.0',),
+        ('2.5.0',),
+    ], ids=[
+        '1.12.0 -> 2.5.0 -> latest',
+        '1.12.0 -> latest',
+        '2.5.0 -> latest',
+    ])
+@pytest.mark.parametrize(
+    'submodule', [False, True],
+    ids=['no submodule', 'with submodules'])
+def test_upgrade(tmpdir, runner, versions, submodule):
+    """Upgrade tests"""
+    # pylint: disable=too-many-statements
+    home = tmpdir.mkdir('HOME')
+    env = {'HOME': str(home)}
+
+    if submodule:
+        ext_repo = tmpdir.mkdir('ext_repo')
+        ext_repo.join('afile').write('some data')
+
+        for cmd in (('init',), ('add', 'afile'), ('commit', '-m', 'test')):
+            run = runner(['git', '-C', str(ext_repo), *cmd])
+            assert run.success
+
+    os.environ.pop('XDG_CONFIG_HOME', None)
+    os.environ.pop('XDG_DATA_HOME', None)
+
+    def run_version(version, *args, check_stderr=True):
+        yadm = 'yadm-%s' % version if version else '/yadm/yadm'
+        run = runner([yadm, *args], shell=True, cwd=str(home), env=env)
+        assert run.success
+        if check_stderr:
+            assert run.err == ''
+        return run
+
+    # Initialize the repo with the first version
+    first = versions[0]
+    run_version(first, 'init')
+
+    home.join('file').write('some data')
+    run_version(first, 'add', 'file')
+    run_version(first, 'commit', '-m', '"First commit"')
+
+    if submodule:
+        # When upgrading via 2.5.0 we can't have a submodule that's been added
+        # after being cloned as 2.5.0 fails the upgrade in that case.
+        can_upgrade_cloned_submodule = '2.5.0' not in versions[1:]
+        if can_upgrade_cloned_submodule:
+            # Check out a repo and then add it as a submodule
+            run = runner(['git', '-C', str(home), 'clone', str(ext_repo), 'b'])
+            assert run.success
+            run_version(first, 'submodule', 'add', str(ext_repo), 'b')
+
+        # Add submodule without first checking it out
+        run_version(first, 'submodule', 'add', str(ext_repo), 'a',
+                    check_stderr=False)
+        run_version(first, 'submodule', 'add', str(ext_repo), 'c',
+                    check_stderr=False)
+
+        run_version(first, 'commit', '-m', '"Add submodules"')
+
+    for path in ('.yadm', '.config/yadm'):
+        yadm_dir = home.join(path)
+        if yadm_dir.exists():
+            break
+
+    yadm_dir.join('bootstrap').write('init stuff')
+    run_version(first, 'add', yadm_dir.join('bootstrap'))
+    run_version(first, 'commit', '-m', 'bootstrap')
+
+    yadm_dir.join('encrypt').write('secret')
+
+    hooks_dir = yadm_dir.mkdir('hooks')
+    hooks_dir.join('pre_status').write('status')
+    hooks_dir.join('post_commit').write('commit')
+
+    run_version(first, 'config', 'local.class', 'test')
+    run_version(first, 'config', 'foo.bar', 'true')
+
+    # Run upgrade with intermediate versions and latest
+    latest = None
+    for version in versions[1:] + (latest,):
+        run = run_version(version, 'upgrade', check_stderr=not submodule)
+        if submodule:
+            lines = run.err.splitlines()
+            if can_upgrade_cloned_submodule:
+                assert 'Migrating git directory of' in lines[0]
+                assert str(home.join('b/.git')) in lines[1]
+                assert str(yadm_dir.join('repo.git/modules/b')) in lines[2]
+                del lines[:3]
+            for line in lines:
+                assert line.startswith('Submodule')
+                assert 'registered for path' in line
+
+    # Verify result for the final upgrade
+    run_version(latest, 'status')
+
+    run = run_version(latest, 'show', 'HEAD:file')
+    assert run.out == 'some data'
+
+    if submodule:
+        if can_upgrade_cloned_submodule:
+            assert home.join('b/afile').read() == 'some data'
+        assert home.join('a/afile').read() == 'some data'
+        assert home.join('c/afile').read() == 'some data'
+
+    yadm_dir = home.join('.config/yadm')
+
+    assert yadm_dir.join('bootstrap').read() == 'init stuff'
+    assert yadm_dir.join('encrypt').read() == 'secret'
+
+    hooks_dir = yadm_dir.join('hooks')
+    assert hooks_dir.join('pre_status').read() == 'status'
+    assert hooks_dir.join('post_commit').read() == 'commit'
+
+    run = run_version(latest, 'config', 'local.class')
+    assert run.out.rstrip() == 'test'
+
+    run = run_version(latest, 'config', 'foo.bar')
+    assert run.out.rstrip() == 'true'

test/test_version.py

@@ -0,0 +1,38 @@
+"""Test version"""
+
+import re
+import pytest
+
+
+@pytest.fixture(scope='module')
+def expected_version(yadm):
+    """
+    Expected semantic version number. This is taken directly out of yadm,
+    searching for the VERSION= string.
+    """
+    yadm_version = re.findall(
+        r'VERSION=([^\n]+)',
+        open(yadm).read())
+    if yadm_version:
+        return yadm_version[0]
+    pytest.fail(f'version not found in {yadm}')
+    return 'not found'
+
+
+def test_semantic_version(expected_version):
+    """Version is semantic"""
+    # semantic version conforms to MAJOR.MINOR.PATCH
+    assert re.search(r'^\d+\.\d+\.\d+$', expected_version), (
+        'does not conform to MAJOR.MINOR.PATCH')
+
+
+@pytest.mark.parametrize('cmd', ['--version', 'version'])
+def test_reported_version(
+        runner, yadm_cmd, cmd, expected_version):
+    """Report correct version and bash/git versions"""
+    run = runner(command=yadm_cmd(cmd))
+    assert run.success
+    assert run.err == ''
+    assert 'bash version' in run.out
+    assert 'git version' in run.out
+    assert run.out.endswith(f'\nyadm version {expected_version}\n')

test/utils.py

@@ -0,0 +1,117 @@
+"""Testing Utilities
+
+This module holds values/functions common to multiple tests.
+"""
+
+import re
+import os
+
+ALT_FILE1 = 'test_alt'
+ALT_FILE2 = 'test alt/test alt'
+ALT_DIR = 'test alt/test alt dir'
+
+# Directory based alternates must have a tracked contained file.
+# This will be the test contained file name
+CONTAINED = 'contained_file'
+
+# These variables are used for making include files which will be processed
+# within jinja templates
+INCLUDE_FILE = 'inc_file'
+INCLUDE_DIRS = ['', 'test alt']
+INCLUDE_CONTENT = '8780846c02e34c930d0afd127906668f'
+
+
+def set_local(paths, variable, value, add=False):
+    """Set local override"""
+    add = "--add" if add else ""
+    os.system(
+        f'GIT_DIR={str(paths.repo)} '
+        f'git config --local {add} "local.{variable}" "{value}"'
+    )
+
+
+def create_alt_files(paths, suffix,
+                     preserve=False, tracked=True,
+                     encrypt=False, exclude=False,
+                     content=None, includefile=False,
+                     yadm_alt=False, yadm_dir=None):
+    """Create new files, and add to the repo
+
+    This is used for testing alternate files. In each case, a suffix is
+    appended to two standard file paths. Particulars of the file creation and
+    repo handling are dependent upon the function arguments.
+    """
+
+    basepath = yadm_dir.join('alt') if yadm_alt else paths.work
+
+    if not preserve:
+        for remove_path in (ALT_FILE1, ALT_FILE2, ALT_DIR):
+            if basepath.join(remove_path).exists():
+                basepath.join(remove_path).remove(rec=1, ignore_errors=True)
+                assert not basepath.join(remove_path).exists()
+
+    new_file1 = basepath.join(ALT_FILE1 + suffix)
+    new_file1.write(ALT_FILE1 + suffix, ensure=True)
+    new_file2 = basepath.join(ALT_FILE2 + suffix)
+    new_file2.write(ALT_FILE2 + suffix, ensure=True)
+    new_dir = basepath.join(ALT_DIR + suffix).join(CONTAINED)
+    new_dir.write(ALT_DIR + suffix, ensure=True)
+
+    # Do not test directory support for jinja alternates
+    test_paths = [new_file1, new_file2]
+    test_names = [ALT_FILE1, ALT_FILE2]
+    if not re.match(r'##(t$|t\.|template|yadm)', suffix):
+        test_paths += [new_dir]
+        test_names += [ALT_DIR]
+
+    for test_path in test_paths:
+        if content:
+            test_path.write('\n' + content, mode='a', ensure=True)
+        assert test_path.exists()
+
+    _create_includefiles(includefile, test_paths, basepath)
+    _create_tracked(tracked, test_paths, paths)
+
+    prefix = '.config/yadm/alt/' if yadm_alt else ''
+    _create_encrypt(encrypt, test_names, suffix, paths, exclude, prefix)
+
+
+def parse_alt_output(output, linked=True):
+    """Parse output of 'alt', and return list of linked files"""
+    regex = r'Creating (.+) from template (.+)$'
+    if linked:
+        regex = r'Linking (.+) to (.+)$'
+    parsed_list = dict()
+    for line in output.splitlines():
+        match = re.match(regex, line)
+        if match:
+            if linked:
+                parsed_list[match.group(2)] = match.group(1)
+            else:
+                parsed_list[match.group(1)] = match.group(2)
+    return parsed_list.values()
+
+
+def _create_includefiles(includefile, test_paths, basepath):
+    if includefile:
+        for dpath in INCLUDE_DIRS:
+            incfile = basepath.join(dpath + '/' + INCLUDE_FILE)
+            incfile.write(INCLUDE_CONTENT, ensure=True)
+            test_paths += [incfile]
+
+
+def _create_tracked(tracked, test_paths, paths):
+    if tracked:
+        for track_path in test_paths:
+            os.system(f'GIT_DIR={str(paths.repo)} git add "{track_path}"')
+        os.system(f'GIT_DIR={str(paths.repo)} git commit -m "Add test files"')
+
+
+def _create_encrypt(encrypt, test_names, suffix, paths, exclude, prefix):
+    if encrypt:
+        for encrypt_name in test_names:
+            paths.encrypt.write(
+                f'{prefix + encrypt_name + suffix}\n', mode='a')
+            if exclude:
+                paths.encrypt.write(
+                    f'!{prefix + encrypt_name + suffix}\n', mode='a')

yadm.md

@@ -4,14 +4,15 @@
 ## NAME
        yadm - Yet Another Dotfiles Manager
 
+
 ## SYNOPSIS
        yadm command [options]
 
        yadm git-command-or-alias [options]
 
-       yadm init [-f]
+       yadm init [-f] [-w dir]
 
-       yadm clone url [-f] [-w directory]
+       yadm clone url [-f] [-w dir] [-b branch] [--bootstrap] [--no-bootstrap]
 
        yadm config name [value]
 
@@ -19,6 +20,8 @@
 
        yadm list [-a]
 
+       yadm bootstrap
+
        yadm encrypt
 
        yadm decrypt [-l]
@@ -27,100 +30,229 @@
 
        yadm perms
 
+       yadm enter [ command ]
+
+       yadm git-crypt [ options ]
+
+       yadm transcrypt [ options ]
+
+       yadm upgrade [-f]
+
+       yadm introspect category
+
+
 ## DESCRIPTION
-       yadm  is a tool for managing a collection of files across multiple com-
+       yadm  is a tool for managing a collection of files across multiple com‐
        puters, using a shared Git repository.  In addition,  yadm  provides  a
-       feature  to  select  alternate versions of files based on the operation
-       system or host name.  Lastly, yadm supplies the  ability  to  manage  a
-       subset of secure files, which are encrypted before they are included in
-       the repository.
+       feature  to  select alternate versions of files for particular systems.
+       Lastly, yadm supplies the ability to manage a subset of  secure  files,
+       which are encrypted before they are included in the repository.
+
 
 ## COMMANDS
        git-command or git-alias
-              Any command not internally handled by yadm is passed through  to
-              git(1).   Git commands or aliases are invoked with the yadm man-
-              aged repository.  The working directory for git commands will be
+              Any  command not internally handled by yadm is passed through to
+              git(1).  Git commands or aliases are invoked with the yadm  man‐
+              aged repository.  The working directory for Git commands will be
               the configured work-tree (usually $HOME).
 
-              Dotfiles  are  managed by using standard git commands; add, com-
+              Dotfiles are managed by using standard git commands;  add,  com‐
               mit, push, pull, etc.
 
-              The config command is not passed directly through.  Instead  use
+              The  config command is not passed directly through.  Instead use
               the gitconfig command (see below).
 
-       alt    Create  symbolic links for any managed files matching the naming
-              rules describe in the ALTERNATES section.  It is usually  unnec-
-              essary  to  run  this  command,  as yadm automatically processes
-              alternates by default.  This automatic behavior can be  disabled
-              by setting the configuration yadm.auto-alt to "false".
+       alt    Create symbolic links and  process  templates  for  any  managed
+              files  matching the naming rules described in the ALTERNATES and
+              TEMPLATES sections. It is usually unnecessary to run  this  com‐
+              mand,  as  yadm  automatically  processes alternates by default.
+              This automatic behavior can be disabled by setting the  configu‐
+              ration yadm.auto-alt to "false".
+
+       bootstrap
+              Execute $HOME/.config/yadm/bootstrap if it exists.
 
        clone url
-              Clone a remote repository for tracking dotfiles.  After the con-
-              tents of the remote repository have been fetched, a  "merge"  of
-              origin/master  is  attempted.   If  there  are conflicting files
-              already present in the  work-tree,  this  merge  will  fail  and
-              instead  a  "reset"  of origin/master will be done.  It is up to
-              the user to resolve these conflicts, but if the  desired  action
-              is to have the contents in the repository overwrite the existing
-              files, then a "hard reset" should accomplish that:
+              Clone a remote repository for tracking dotfiles.  After the con‐
+              tents of the remote repository have been fetched, a "check  out"
+              of  the remote HEAD branch is attempted.  If there are conflict‐
+              ing files already present in the work-tree,  the  local  version
+              will  be  left  unmodified and you'll have to review and resolve
+              the difference.
 
-                     yadm reset --hard origin/master
-
-              The repository is stored in $HOME/.yadm/repo.git.   By  default,
-              $HOME  will be used as the work-tree, but this can be overridden
-              with the -w option.  yadm can be forced to overwrite an existing
-              repository by providing the -f option.
+              The repository is  stored  in  $HOME/.local/share/yadm/repo.git.
+              By default, $HOME will be used as the work-tree, but this can be
+              overridden with the -w option.  yadm can be forced to  overwrite
+              an  existing repository by providing the -f option.  If you want
+              to use a branch other than the remote HEAD branch you can  spec‐
+              ify  it  using the -b option.  By default yadm will ask the user
+              if the bootstrap program should be run (if it exists).  The  op‐
+              tions  --bootstrap or --no-bootstrap will either force the boot‐
+              strap to be run, or prevent it from being run, without prompting
+              the user.
 
        config This  command  manages  configurations  for  yadm.  This command
-              works exactly they way git-config(1) does.  See  the  CONFIGURA-
-              TION section for more details.
+              works exactly the way git-config(1) does.  See the CONFIGURATION
+              section for more details.
 
        decrypt
-              Decrypt   all  files  stored  in  $HOME/.yadm/files.gpg.   Files
-              decrypted will be relative to the configured work-tree  (usually
-              $HOME).   Using the -l option will list the files stored without
-              extracting them.
+              Decrypt  all  files  stored  in $HOME/.local/share/yadm/archive.
+              Files decrypted will be relative  to  the  configured  work-tree
+              (usually $HOME).  Using the -l option will list the files stored
+              without extracting them.
 
        encrypt
-              Encrypt   all   files   matching   the   patterns    found    in
-              $HOME/.yadm/encrypt.    See  the  ENCRYPTION  section  for  more
-              details.
+              Encrypt all files matching the  patterns  found  in  $HOME/.con‐
+              fig/yadm/encrypt.  See the ENCRYPTION section for more details.
+
+       enter  Run  a  sub-shell with all Git variables set. Exit the sub-shell
+              the same way you leave  your  normal  shell  (usually  with  the
+              "exit"  command).  This sub-shell can be used to easily interact
+              with your yadm repository using "git" commands.  This  could  be
+              useful  if you are using a tool which uses Git directly, such as
+              tig, vim-fugitive, git-cola, etc.
+
+              Optionally, you can provide a command after "enter", and instead
+              of invoking your shell, that command will be run with all of the
+              Git variables exposed to the command's environment.
+
+              Emacs Tramp and Magit can manage files by using this  configura‐
+              tion:
+
+                  (add-to-list 'tramp-methods
+                       '("yadm"
+                         (tramp-login-program "yadm")
+                         (tramp-login-args (("enter")))
+                         (tramp-login-env (("SHELL") ("/bin/sh")))
+                         (tramp-remote-shell "/bin/sh")
+                         (tramp-remote-shell-args ("-c"))))
+
+              With this config, use (magit-status "/yadm::").
+
+       git-crypt options
+              If  git-crypt  is installed, this command allows you to pass op‐
+              tions directly to git-crypt, with the environment configured  to
+              use the yadm repository.
+
+              git-crypt enables transparent encryption and decryption of files
+              in a git repository.  You can read  https://github.com/AGWA/git-
+              crypt for details.
 
        gitconfig
-              Pass options to the git config command. Since yadm already  uses
-              the  config  command to manage its own configurations, this com-
-              mand is provided as a way to change configurations of the repos-
-              itory  managed  by yadm.  One particularly useful case may be to
-              configure the repository so untracked files are hidden from sta-
-              tus commands:
+              Pass  options to the git config command. Since yadm already uses
+              the config command to manage its own configurations,  this  com‐
+              mand is provided as a way to change configurations of the repos‐
+              itory managed by yadm.  One useful case might  be  to  configure
+              the  repository so untracked files are shown in status commands.
+              yadm initially configures its repository so that untracked files
+              are  not  shown.   If  you wish use the default Git behavior (to
+              show untracked files and directories), you can remove this  con‐
+              figuration.
 
-                     yadm gitconfig status.showUntrackedFiles no
+                     yadm gitconfig --unset status.showUntrackedFiles
 
        help   Print a summary of yadm commands.
 
        init   Initialize  a  new, empty repository for tracking dotfiles.  The
-              repository is stored in $HOME/.yadm/repo.git.  By default, $HOME
-              will  be  used as the work-tree, but this can be overridden with
-              the -w option.  yadm can be  forced  to  overwrite  an  existing
-              repository by providing the -f option.
+              repository is stored  in  $HOME/.local/share/yadm/repo.git.   By
+              default,  $HOME  will  be used as the work-tree, but this can be
+              overridden with the -w option.  yadm can be forced to  overwrite
+              an existing repository by providing the -f option.
 
        list   Print a list of files managed by yadm.  The -a option will cause
               all managed files to be listed.  Otherwise, the list  will  only
               include files from the current directory or below.
 
+       introspect category
+              Report  internal  yadm  data. Supported categories are commands,
+              configs, repo, and switches.  The purpose of introspection is to
+              support command line completion.
+
        perms  Update  permissions as described in the PERMISSIONS section.  It
-              is usually unnecessary to run this command,  as  yadm  automati-
-              cally processes permissions by default.  This automatic behavior
+              is usually unnecessary to run this command,  as  yadm  automati‐
+              cally  processes permissions by default. This automatic behavior
               can be disabled by setting the configuration yadm.auto-perms  to
               "false".
 
+       transcrypt options
+              If  transcrypt is installed, this command allows you to pass op‐
+              tions directly to transcrypt, with the environment configured to
+              use the yadm repository.
+
+              transcrypt  enables  transparent  encryption  and  decryption of
+              files    in    a    git    repository.      You     can     read
+              https://github.com/elasticdog/transcrypt for details.
+
+       upgrade
+              Version  3  of yadm uses a different directory for storing data.
+              When you start to use version 3 for the first time, you may  see
+              warnings about moving your data to this new directory.  The eas‐
+              iest way to accomplish this is by running "yadm upgrade".   This
+              command  will  start  by  moving your yadm repo to the new path.
+              Next it will move any archive data.  If the archive  is  tracked
+              within your yadm repo, this command will "stage" the renaming of
+              that file in the repo's index.
+
+              Upgrading will attempt to de-initialize and  re-initialize  your
+              submodules. If your submodules cannot be de-initialized, the up‐
+              grade will fail. The most common reason submodules will fail  to
+              de-initialize  is  because they have local modifications. If you
+              are willing to lose the local modifications to those submodules,
+              you  can  use  the -f option with the "upgrade" command to force
+              the de-initialization.
+
+              After running "yadm upgrade", you should run  "yadm  status"  to
+              review  changes  which have been staged, and commit them to your
+              repository.
+
+              You can read https://yadm.io/docs/upgrade_from_2 for more infor‐
+              mation.
+
        version
               Print the version of yadm.
 
+
+## OPTIONS
+       yadm  supports a set of universal options that alter the paths it uses.
+       The default paths are documented in the FILES section. Any path  speci‐
+       fied  by  these  options must be fully qualified. If you always want to
+       override one or more of these paths, it may  be  useful  to  create  an
+       alias  for the yadm command.  For example, the following alias could be
+       used to override the repository directory.
+
+              alias yadm='yadm --yadm-repo /alternate/path/to/repo'
+
+       The following is the full  list  of  universal  options.   Each  option
+       should be followed by a path.
+
+       -Y,--yadm-dir
+              Override  the  yadm  directory.   yadm stores its configurations
+              relative to this directory.
+
+       --yadm-data
+              Override the yadm data directory.  yadm stores its data relative
+              to this directory.
+
+       --yadm-repo
+              Override the location of the yadm repository.
+
+       --yadm-config
+              Override the location of the yadm configuration file.
+
+       --yadm-encrypt
+              Override the location of the yadm encryption configuration.
+
+       --yadm-archive
+              Override the location of the yadm encrypted files archive.
+
+       --yadm-bootstrap
+              Override the location of the yadm bootstrap program.
+
+
 ## CONFIGURATION
-       yadm  uses  a  configuration  file named $HOME/.yadm/config.  This file
-       uses the same format as git-config(1).  Also, you can control the  con-
-       tents  of  the  configuration  file  via the yadm config command (which
+       yadm  uses  a configuration file named $HOME/.config/yadm/config.  This
+       file uses the same format as git-config(1).  Also, you can control  the
+       contents  of  the configuration file via the yadm config command (which
        works exactly like git-config).  For example, to disable alternates you
        can run the command:
 
@@ -128,133 +260,521 @@
 
        The following is the full list of supported configurations:
 
+       yadm.alt-copy
+              If set to "true", alternate files will be copies instead of sym‐
+              bolic links.  This might be desirable, because some systems  may
+              not properly support symlinks.
+
        yadm.auto-alt
-              Disable  the  automatic  linking described in the section ALTER-
-              NATES.  If disabled, you may still run yadm alt manually to cre-
-              ate the alternate links.  This feature is enabled by default.
+              Disable  the  automatic  linking described in the section ALTER‐
+              NATES. If disabled, you may still run  "yadm  alt"  manually  to
+              create the alternate links. This feature is enabled by default.
+
+       yadm.auto-exclude
+              Disable   the   automatic   exclusion  of  patterns  defined  in
+              $HOME/.config/yadm/encrypt.  This feature is enabled by default.
 
        yadm.auto-perms
-              Disable  the  automatic permission changes described in the sec-
-              tion PERMISSIONS.  If disabled, you may  still  run  yadm  perms
-              manually  to  update  permissions.   This  feature is enabled by
+              Disable the automatic permission changes described in  the  sec‐
+              tion  PERMISSIONS.   If  disabled,  you may still run yadm perms
+              manually to update permissions.  This feature is enabled by  de‐
+              fault.
+
+       yadm.auto-private-dirs
+              Disable  the automatic creating of private directories described
+              in the section PERMISSIONS.
+
+       yadm.cipher
+              Configure which encryption system is used by the encrypt/decrypt
+              commands.  Valid options are "gpg" and "openssl". The default is
+              "gpg".  Detailed information can be found in the section ENCRYP‐
+              TION.
+
+       yadm.git-program
+              Specify  an  alternate  program to use instead of "git".  By de‐
+              fault, the first "git" found in $PATH is used.
+
+       yadm.gpg-perms
+              Disable the permission changes to $HOME/.gnupg/*.  This  feature
+              is enabled by default.
+
+       yadm.gpg-program
+              Specify  an  alternate  program to use instead of "gpg".  By de‐
+              fault, the first "gpg" found in $PATH is used.
+
+       yadm.gpg-recipient
+              Asymmetrically encrypt files with a gpg public/private key pair.
+              Provide  a "key ID" to specify which public key to encrypt with.
+              The key must exist in your public keyrings.  Multiple recipients
+              can  be  specified  (separated  by space).  If left blank or not
+              provided, symmetric encryption  is  used  instead.   If  set  to
+              "ASK",  gpg  will interactively ask for recipients.  See the EN‐
+              CRYPTION section for more details.  This feature is disabled  by
               default.
 
+       yadm.openssl-ciphername
+              Specify  which  cipher should be used by openssl.  "aes-256-cbc"
+              is used by default.
+
+       yadm.openssl-old
+              Newer versions of openssl  support  the  pbkdf2  key  derivation
+              function.  This is used by default. If this configuration is set
+              to "true", openssl operations will use options  compatible  with
+              older  versions  of openssl. If you change this option, you will
+              need to recreate your encrypted archive.
+
+       yadm.openssl-program
+              Specify an alternate program to use instead  of  "openssl".   By
+              default, the first "openssl" found in $PATH is used.
+
        yadm.ssh-perms
               Disable the permission changes to $HOME/.ssh/*.  This feature is
               enabled by default.
 
+       The following  five  "local"  configurations  are  not  stored  in  the
+       $HOME/.config/yadm/config, they are stored in the local repository.
+
+
+       local.class
+              Specify  a  class for the purpose of symlinking alternate files.
+              By default, no class will be matched.  The local host can be as‐
+              signed multiple classes using command:
+
+              yadm config --add local.class <additional-class>
+
+       local.arch
+              Override  the  architecture for the purpose of symlinking alter‐
+              nate files.
+
+       local.hostname
+              Override the hostname for the purpose  of  symlinking  alternate
+              files.
+
+       local.os
+              Override the OS for the purpose of symlinking alternate files.
+
+       local.user
+              Override the user for the purpose of symlinking alternate files.
+
+
 ## ALTERNATES
        When managing a set of files across different systems, it can be useful
        to have an automated way of choosing an alternate version of a file for
-       a  different  operation  system  or  simply for a different host.  yadm
-       implements a feature which will automatically create a symbolic link to
-       the  appropriate  version  of  a file, as long as you follow a specific
-       naming convention.  yadm can detect files with names ending in:
+       a different operating system, host, user, etc.
 
-              ##OS.HOSTNAME or ##OS or ##
+       yadm  will automatically create a symbolic link to the appropriate ver‐
+       sion of a file, when a valid suffix is appended to  the  filename.  The
+       suffix  contains  the  conditions  that must be met for that file to be
+       used.
 
-       If there are any files managed by yadm's repository  which  match  this
-       naming  convention,  symbolic links will be created for the most appro-
-       priate version.  This may best be demonstrated by example.  Assume  the
-       following files are managed by yadm's repository:
+       The suffix begins with "##", followed by any number of conditions sepa‐
+       rated by commas.
 
-         - $HOME/path/example.txt##
-         - $HOME/path/example.txt##Darwin
-         - $HOME/path/example.txt##Darwin.host1
-         - $HOME/path/example.txt##Darwin.host2
-         - $HOME/path/example.txt##Linux
-         - $HOME/path/example.txt##Linux.host1
-         - $HOME/path/example.txt##Linux.host2
+         ##<condition>[,<condition>,...]
+
+       Each  condition is an attribute/value pair, separated by a period. Some
+       conditions do not require a "value", and in that case, the  period  and
+       value  can  be  omitted. Most attributes can be abbreviated as a single
+       letter.
+
+         <attribute>[.<value>]
+
+       These are the supported attributes, in the order of the weighted prece‐
+       dence:
+
+
+       template, t
+              Valid  when  the  value  matches a supported template processor.
+              See the TEMPLATES section for more details.
+
+       user, u
+              Valid if the value matches the current user.   Current  user  is
+              calculated by running id -u -n.
+
+       hostname, h
+              Valid if the value matches the short hostname.  Hostname is cal‐
+              culated by running uname -n, and trimming off any domain.
+
+       class, c
+              Valid if the value matches the local.class configuration.  Class
+              must be manually set using yadm config local.class <class>.  See
+              the CONFIGURATION section for more  details  about  setting  lo‐
+              cal.class.
+
+       distro, d
+              Valid  if the value matches the distro.  Distro is calculated by
+              running lsb_release -si or by inspecting the ID from /etc/os-re‐
+              lease.
+
+       distro_family, f
+              Valid  if the value matches the distro family.  Distro family is
+              calculated by inspecting the ID_LIKE line from /etc/os-release.
+
+       os, o  Valid if the value matches the OS.  OS is calculated by  running
+              uname -s.
+
+       arch, a
+              Valid  if  the  value matches the architecture.  Architecture is
+              calculated by running uname -m.
+
+       default
+              Valid when no other alternate is valid.
+
+       extension, e
+              A special "condition" that doesn't affect the selection process.
+              Its purpose is instead to allow the alternate file to end with a
+              certain extension to e.g. make  editors  highlight  the  content
+              properly.
+
+       NOTE:  The  OS  for "Windows Subsystem for Linux" is reported as "WSL",
+       even though uname identifies as "Linux".
+
+       You may use any number of conditions, in any order.  An alternate  will
+       only  be  used  if  ALL conditions are valid.  For all files managed by
+       yadm's repository or  listed  in  $HOME/.config/yadm/encrypt,  if  they
+       match  this  naming  convention, symbolic links will be created for the
+       most appropriate version.
+
+       The "most appropriate" version is determined by calculating a score for
+       each  version  of  a  file. A template is always scored higher than any
+       symlink condition. The number of conditions is the next largest  factor
+       in scoring.  Files with more conditions will always be favored. Any in‐
+       valid condition will disqualify that file completely.
+
+       If you don't care to have all versions of alternates stored in the same
+       directory  as  the  generated  symlink,  you  can  place  them  in  the
+       $HOME/.config/yadm/alt directory. The generated  symlink  or  processed
+       template will be created using the same relative path.
+
+       Alternate  linking may best be demonstrated by example. Assume the fol‐
+       lowing files are managed by yadm's repository:
+
+         - $HOME/path/example.txt##default
+         - $HOME/path/example.txt##class.Work
+         - $HOME/path/example.txt##os.Darwin
+         - $HOME/path/example.txt##os.Darwin,hostname.host1
+         - $HOME/path/example.txt##os.Darwin,hostname.host2
+         - $HOME/path/example.txt##os.Linux
+         - $HOME/path/example.txt##os.Linux,hostname.host1
+         - $HOME/path/example.txt##os.Linux,hostname.host2
 
        If running on a Macbook named "host2", yadm will create a symbolic link
        which looks like this:
 
-       $HOME/path/example.txt -> $HOME/path/example.txt##Darwin.host2
+       $HOME/path/example.txt    ->    $HOME/path/example.txt##os.Darwin,host‐
+       name.host2
 
        However, on another Mackbook named "host3", yadm will create a symbolic
        link which looks like this:
 
-       $HOME/path/example.txt -> $HOME/path/example.txt##Darwin
+       $HOME/path/example.txt -> $HOME/path/example.txt##os.Darwin
 
        Since  the  hostname  doesn't  match any of the managed files, the more
        generic version is chosen.
 
        If running on a Linux server named "host4", the link will be:
 
-       $HOME/path/example.txt -> $HOME/path/example.txt##Linux
+       $HOME/path/example.txt -> $HOME/path/example.txt##os.Linux
 
-       If running on a Solaris server, the link use the default "##" version:
+       If running on a Solaris server, the link will use the default version:
 
-       $HOME/path/example.txt -> $HOME/path/example.txt##
+       $HOME/path/example.txt -> $HOME/path/example.txt##default
 
-       If no "##" version exists and no files match the current  OS  or  HOST-
-       NAME, then no link will be created.
+       If running on a system, with class set to "Work", the link will be:
+
+       $HOME/path/example.txt -> $HOME/path/example.txt##class.Work
+
+       If no "##default" version exists and no files  have  valid  conditions,
+       then no link will be created.
+
+       Links  are also created for directories named this way, as long as they
+       have at least one yadm managed file within them (at the top level).
+
+       yadm will automatically create these links by default. This can be dis‐
+       abled  using  the yadm.auto-alt configuration.  Even if disabled, links
+       can be manually created by running yadm alt.
+
+       Class is a special value which is stored locally on each  host  (inside
+       the  local repository). To use alternate symlinks using class, you must
+       set the value of class using the configuration  local.class.   This  is
+       set like any other yadm configuration with the yadm config command. The
+       following sets the class to be "Work".
+
+         yadm config local.class Work
+
+       Similarly, the values of architecture, os, hostname, and  user  can  be
+       manually  overridden  using  the  configuration options local.arch, lo‐
+       cal.os, local.hostname, and local.user.
+
+
+## TEMPLATES
+       If a template condition is defined in an alternate file's "##"  suffix,
+       and the necessary dependencies for the template are available, then the
+       file will be processed to create or overwrite files.
+
+       Supported template processors:
+
+       default
+              This is yadm's built-in template processor.  This  processor  is
+              very basic, with a Jinja-like syntax. The advantage of this pro‐
+              cessor is that it only depends upon awk, which is  available  on
+              most  *nix  systems. To use this processor, specify the value of
+              "default" or just leave the value off (e.g. "##template").
+
+       ESH    ESH is a template processor written in POSIX compliant shell. It
+              allows  executing  shell  commands within templates. This can be
+              used to reference your own configurations within templates,  for
+              example:
+
+                <% yadm config mysection.myconfig %>
+
+              To use the ESH template processor, specify the value of "esh"
+
+       j2cli  To  use the j2cli Jinja template processor, specify the value of
+              "j2"  or "j2cli".
+
+       envtpl To use the envtpl Jinja template processor, specify the value of
+              "j2" or "envtpl".
+
+       NOTE: Specifying "j2" as the processor will attempt to use j2cli or en‐
+       vtpl, whichever is available.
+
+       If the template processor specified is  available,  templates  will  be
+       processed to create or overwrite files.
+
+       During  processing,  the  following variables are available in the tem‐
+       plate:
+
+        Default              Jinja or ESH         Description
+        -------------        -------------        ----------------------------
+        yadm.arch            YADM_ARCH            uname -m
+        yadm.class           YADM_CLASS           Last locally defined class
+        yadm.classes         YADM_CLASSES         All classes
+        yadm.distro          YADM_DISTRO          lsb_release -si
+        yadm.distro_family   YADM_DISTRO_FAMILY   ID_LIKE from /etc/os-release
+        yadm.hostname        YADM_HOSTNAME        uname -n (without domain)
+        yadm.os              YADM_OS              uname -s
+        yadm.source          YADM_SOURCE          Template filename
+        yadm.user            YADM_USER            id -u -n
+        env.VAR                                   Environment variable VAR
+
+       NOTE: The OS for "Windows Subsystem for Linux" is  reported  as  "WSL",
+       even though uname identifies as "Linux".
+
+       NOTE:  If lsb_release is not available, DISTRO will be the ID specified
+       in /etc/os-release.
+
+       Examples:
+
+       whatever##template with the following content
+
+         {% if yadm.user == "harvey" %}
+         config={{yadm.class}}-{{yadm.os}}
+         {% else %}
+         config=dev-whatever
+         {% include "whatever.extra" %}
+         {% endif %}
+
+       would output a file named whatever with the following  content  if  the
+       user is "harvey":
+
+         config=work-Linux
+
+       and the following otherwise (if whatever.extra contains admin=false):
+
+         config=dev-whatever
+         admin=false
+
+       An  equivalent  Jinja  template  named whatever##template.j2 would look
+       like:
+
+         {% if YADM_USER == 'harvey' -%}
+         config={{YADM_CLASS}}-{{YADM_OS}}
+         {% else -%}
+         config=dev-whatever
+         {% include 'whatever.extra' %}
+         {% endif -%}
+
+       An equivalent ESH templated  named  whatever##template.esh  would  look
+       like:
+
+         <% if [ "$YADM_USER" = "harvey" ]; then -%>
+         config=<%= $YADM_CLASS %>-<%= $YADM_OS %>
+         <% else -%>
+         config=dev-whatever
+         <%+ whatever.extra %>
+         <% fi -%>
 
-       OS  is  determined  by  running uname -s, and HOSTNAME by running host-
-       name -s.  yadm will automatically create these links by  default.  This
-       can  be  disabled  using the yadm.auto-alt configuration.  Even if dis-
-       abled, links can be manually created by running yadm alt.
 
 ## ENCRYPTION
-       It can be useful to manage confidential files, like  SSH  keys,  across
-       multiple  systems.  However,  doing so would put plain text data into a
-       Git repository, which often resides on a public  system.   yadm  imple-
-       ments  a feature which can make it easy to encrypt and decrypt a set of
-       files so the encrypted version can be maintained in the Git repository.
-       This feature will only work if the gpg(1) command is available.
+       It  can  be  useful to manage confidential files, like SSH or GPG keys,
+       across multiple systems. However, doing so would put  plain  text  data
+       into a Git repository, which often resides on a public system. yadm can
+       make it easy to encrypt and decrypt a set of  files  so  the  encrypted
+       version  can  be  maintained  in the Git repository.  This feature will
+       only work if a supported tool is available.  Both gpg(1) and openssl(1)
+       are  supported.   gpg is used by default, but openssl can be configured
+       with the yadm.cipher configuration.
 
-       To  use  this  feature, a list of patterns must be created and saved as
-       $HOME/.yadm/encrypt.  This list of patterns should be relative  to  the
-       configured work-tree (usually $HOME).  For example:
+       To use this feature, a list of patterns must be created  and  saved  as
+       $HOME/.config/yadm/encrypt.   This  list of patterns should be relative
+       to the configured work-tree (usually $HOME).  For example:
 
-               .ssh/*.key
+                  .ssh/*.key
+                  .gnupg/*.gpg
+
+       Standard filename expansions (*, ?, [) are supported.  If you have Bash
+       version  4,  you may use "**" to match all subdirectories.  Other shell
+       expansions like brace and tilde are not supported.  Spaces in paths are
+       supported,  and should not be quoted.  If a directory is specified, its
+       contents will be included, but not recursively.  Paths beginning with a
+       "!" will be excluded.
 
        The yadm encrypt command will find all files matching the patterns, and
        prompt for a password. Once a  password  has  confirmed,  the  matching
-       files  will  be encrypted and saved as $HOME/.yadm/files.gpg.  The pat-
-       terns and files.gpg should be added to the yadm repository so they  are
-       available across multiple systems.
+       files  will  be encrypted and saved as $HOME/.local/share/yadm/archive.
+       The "encrypt" and "archive" files should be added to the  yadm  reposi‐
+       tory so they are available across multiple systems.
 
        To decrypt these files later, or on another system run yadm decrypt and
        provide the correct password.  After files are  decrypted,  permissions
        are automatically updated as described in the PERMISSIONS section.
 
-       NOTE:  It is recommended that you use a private repository when keeping
+       Symmetric  encryption is used by default, but asymmetric encryption may
+       be enabled using the yadm.gpg-recipient configuration.
+
+       NOTE: It is recommended that you use a private repository when  keeping
        confidential files, even though they are encrypted.
 
+       Patterns found in $HOME/.config/yadm/encrypt are automatically added to
+       the repository's info/exclude file every  time  yadm  encrypt  is  run.
+       This is to prevent accidentally committing sensitive data to the repos‐
+       itory.  This can be disabled using the yadm.auto-exclude configuration.
+
+       Using transcrypt or git-crypt
+
+       A completely separate option for encrypting data is to install and  use
+       transcrypt  or  git-crypt.   Once installed, you can use these tools by
+       running yadm transcrypt or yadm git-crypt.  These tools enables  trans‐
+       parent  encryption and decryption of files in a git repository. See the
+       following web sites for more information:
+
+       - https://github.com/elasticdog/transcrypt
+
+       - https://github.com/AGWA/git-crypt
+
 ## PERMISSIONS
-       When files are checked out of a Git repository, their  initial  permis-
-       sions are dependent upon the user's umask. This can result in confiden-
-       tial files with lax permissions.
+       When files are checked out of a Git repository, their  initial  permis‐
+       sions  are  dependent upon the user's umask. Because of this, yadm will
+       automatically update the permissions of some file  paths.  The  "group"
+       and "others" permissions will be removed from the following files:
 
-       To prevent this, yadm will automatically update the permissions of con-
-       fidential  files.  The "group" and "others" permissions will be removed
-       from the following files:
+       - $HOME/.local/share/yadm/archive
 
-       - $HOME/.yadm/files.gpg
-
-       - All files matching patterns in $HOME/.yadm/encrypt
+       - All files matching patterns in $HOME/.config/yadm/encrypt
 
        - The SSH directory and files, .ssh/*
 
-       yadm will automatically update permissions by default. This can be dis-
-       abled  using the yadm.auto-perms configuration.  Even if disabled, per-
-       missions can be manually updated by running yadm perms.  The SSH direc-
-       tory processing can be disabled using the yadm.ssh-perms configuration.
+       - The GPG directory and files, .gnupg/*
+
+       yadm will automatically update permissions by default. This can be dis‐
+       abled using the yadm.auto-perms configuration. Even if  disabled,  per‐
+       missions  can  be manually updated by running yadm perms.  The .ssh di‐
+       rectory processing can be disabled using the yadm.ssh-perms  configura‐
+       tion.  The  .gnupg  directory  processing  can  be  disabled  using the
+       yadm.gpg-perms configuration.
+
+       When cloning a repo which includes data in a .ssh or .gnupg  directory,
+       if  those  directories  do  not exist at the time of cloning, yadm will
+       create the directories with mask 0700 prior to merging the fetched data
+       into the work-tree.
+
+       When running a Git command and .ssh or .gnupg directories do not exist,
+       yadm will create those directories with mask 0700 prior to running  the
+       Git command. This can be disabled using the yadm.auto-private-dirs con‐
+       figuration.
+
+
+## HOOKS
+       For every command yadm supports, a program can be provided to  run  be‐
+       fore  or  after  that  command.  These are referred to as "hooks". yadm
+       looks for hooks in the directory $HOME/.config/yadm/hooks.   Each  hook
+       is named using a prefix of pre_ or post_, followed by the command which
+       should trigger the hook. For example, to create a hook which is run af‐
+       ter every yadm pull command, create a hook named post_pull.  Hooks must
+       have the executable file permission set.
+
+       If a pre_ hook is defined, and the hook terminates with a non-zero exit
+       status,  yadm  will  refuse  to run the yadm command. For example, if a
+       pre_commit hook is defined, but that command ends with a non-zero  exit
+       status,  the  yadm commit will never be run. This allows one to "short-
+       circuit" any operation using a pre_ hook.
+
+       Hooks have the following environment variables  available  to  them  at
+       runtime:
+
+       YADM_HOOK_COMMAND
+              The command which triggered the hook
+
+       YADM_HOOK_EXIT
+              The exit status of the yadm command
+
+       YADM_HOOK_FULL_COMMAND
+              The yadm command with all command line arguments (parameters are
+              space delimited, and any space, tab or backslash will be escaped
+              with a backslash)
+
+       YADM_HOOK_REPO
+              The path to the yadm repository
+
+       YADM_HOOK_WORK
+              The path to the work-tree
+
 
 ## FILES
-       $HOME/.yadm/config
+       All  of  yadm's  configurations  are  relative to the "yadm directory".
+       yadm uses the "XDG Base Directory Specification" to determine this  di‐
+       rectory.   If the environment variable $XDG_CONFIG_HOME is defined as a
+       fully qualified path, this  directory  will  be  $XDG_CONFIG_HOME/yadm.
+       Otherwise it will be $HOME/.config/yadm.
+
+       Similarly, yadm's data files are relative to the "yadm data directory".
+       yadm uses the "XDG Base Directory Specification" to determine this  di‐
+       rectory.   If  the  environment variable $XDG_DATA_HOME is defined as a
+       fully qualified path, this directory will be $XDG_DATA_HOME/yadm.  Oth‐
+       erwise it will be $HOME/.local/share/yadm.
+
+       The  following  are the default paths yadm uses for its own data.  Most
+       of these paths can be altered using universal options.  See the OPTIONS
+       section for details.
+
+       $HOME/.config/yadm
+              The yadm directory. By default, all configs yadm stores is rela‐
+              tive to this directory.
+
+       $HOME/.local/share/yadm
+              The yadm data directory. By default, all  data  yadm  stores  is
+              relative to this directory.
+
+       $YADM_DIR/config
               Configuration file for yadm.
 
-       $HOME/.yadm/repo.git
+       $YADM_DIR/alt
+              This  is  a  directory  to keep "alternate files" without having
+              them side-by-side with the resulting symlink or  processed  tem‐
+              plate.  Alternate files placed in this directory will be created
+              relative to $HOME instead.
+
+       $YADM_DATA/repo.git
               Git repository used by yadm.
 
-       $HOME/.yadm/encrypt
+       $YADM_DIR/encrypt
               List of globs used for encrypt/decrypt
 
-       $HOME/.yadm/files.gpg
+       $YADM_DATA/archive
               All files encrypted with yadm encrypt are stored in this file.
 
+
 ## EXAMPLES
        yadm init
               Create an empty repo for managing files
@@ -268,28 +788,27 @@
        yadm push -u origin master
               Initial push of master to origin
 
-       echo .ssh/*.key >> $HOME/.yadm/encrypt
+       echo .ssh/*.key >> $HOME/.config/yadm/encrypt
               Add a new pattern to the list of encrypted files
 
-       yadm encrypt ; yadm add ~/.yadm/files.gpg ; yadm commit
+       yadm encrypt ; yadm add ~/.local/share/yadm/archive ; yadm commit
               Commit a new set of encrypted files
 
+
 ## REPORTING BUGS
        Report issues or create pull requests at GitHub:
 
-       https://github.com/TheLocehiliosan/yadm
+       https://github.com/TheLocehiliosan/yadm/issues
+
 
 ## AUTHOR
        Tim Byrne <sultan@locehilios.com>
 
+
 ## SEE ALSO
-       git(1), gpg(1)
+       git(1), gpg(1) openssl(1) transcrypt(1) git-crypt(1)
 
-       Other management tools which inspired the creation of yadm:
-
-       homeshick <https://github.com/andsens/homeshick>
-
-       vcsh <https://github.com/RichiH/vcsh>
+       https://yadm.io/
 
 
 

yadm.spec

@@ -0,0 +1,48 @@
+%{!?_pkgdocdir: %global _pkgdocdir %{_docdir}/%{name}-%{version}}
+Name: yadm
+Summary: Yet Another Dotfiles Manager
+Version: 3.2.2
+Group: Development/Tools
+Release: 1%{?dist}
+URL: https://yadm.io
+License: GPL-3.0-only
+Requires: bash
+Requires: git
+
+Source: %{name}.tar.gz
+BuildRoot: %{_tmppath}/%{name}-%{version}-build
+BuildArch: noarch
+
+%description
+yadm is a tool for managing a collection of files across multiple computers,
+using a shared Git repository. In addition, yadm provides a feature to select
+alternate versions of files based on the operation system or host name. Lastly,
+yadm supplies the ability to manage a subset of secure files, which are
+encrypted before they are included in the repository.
+
+%prep
+%setup -c
+
+%build
+
+%install
+
+# this is done to allow paths other than yadm-x.x.x (for example, when building
+# from branches instead of release tags)
+test -f yadm || cd *yadm-*
+
+%{__mkdir} -p %{buildroot}%{_bindir}
+%{__cp}  yadm %{buildroot}%{_bindir}
+
+%{__mkdir} -p  %{buildroot}%{_mandir}/man1
+%{__cp} yadm.1 %{buildroot}%{_mandir}/man1
+
+%{__mkdir} -p                        %{buildroot}%{_pkgdocdir}
+%{__cp} README.md                    %{buildroot}%{_pkgdocdir}/README
+%{__cp} CHANGES CONTRIBUTORS LICENSE %{buildroot}%{_pkgdocdir}
+%{__cp} -r completion contrib        %{buildroot}%{_pkgdocdir}
+
+%files
+%attr(755,root,root) %{_bindir}/yadm
+%attr(644,root,root) %{_mandir}/man1/*
+%doc %{_pkgdocdir}