Add tests for plugin installation

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# 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 [email protected]. 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

CONTRIBUTING.md

@@ -0,0 +1,13 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via issue before making a change. 
+
+Please note we have a code of conduct, please follow it in all your interactions with the project.
+
+## Pull Request Process
+
+1. Update the [README.md](README.md) or [USAGE.md](USAGE.md) with details of changes to the interface, this includes new environment 
+   variables, useful file locations and other parameters.
+2. If possible add [test cases](tests/README.md) to cover the issues or new feature.
+3. You may merge the Pull Request in once you have the sign-off of two other developers, or if you 
+   do not have permission to do that, you may request the second reviewer to merge it for you.

README.md

@@ -34,10 +34,10 @@ Additional documentation, resources and examples can be found [here](USAGE.md).
 
 ## Moving parts of project
 
-* `scripts/install.sh` - Script used as the hook to download and install sops and install git diff configuration for helm-secrets files.
-* `scripts/run.sh` - Main helm-secrets plugin code for all helm-secrets plugin actions available in `helm secrets help` after plugin install
-* `tests` - Test scripts to check if all parts of the plugin work. Using example dir with vars structure and PGP keys to make real tests on real data with real encryption/decryption.
-* `examples` - Some example secrets.yaml 
+* [`scripts/install.sh`](scripts/install.sh) - Script used as the hook to download and install sops and install git diff configuration for helm-secrets files.
+* [`scripts/run.sh`](scripts/run.sh) - Main helm-secrets plugin code for all helm-secrets plugin actions available in `helm secrets help` after plugin install
+* [`tests`](tests) - Test scripts to check if all parts of the plugin work. Using test assets with PGP keys to make real tests on real data with real encryption/decryption.
+* [`examples`](examples) - Some example secrets.yaml 
 
 ## Installation and Dependencies
 

tests/README.md

@@ -0,0 +1,110 @@
+# helm-secrets test suite
+
+This tests suite use the [bats-core](https://github.com/bats-core/bats-core) framework.
+
+Some test extension libraries are included in this project as git submodule.
+
+Run
+```bash
+git submodule update --init --force
+```
+to checkout the submodules.
+
+## Wording
+
+Inside helm-secrets we have 2 groups of tests:
+
+* **unit tests**
+
+  Can be run without an reachable kubernetes cluster
+  Located under [./unit/](./unit)
+
+* **integration tests**
+
+  Depends against a reachable kubernetes cluster
+  Located under [./it/](./it)
+
+## Requirements
+
+To execute the tests have to install some utilities first.
+
+### bats
+Then follow the installation instruction for bats here: https://github.com/bats-core/bats-core#installation
+
+More information's here: https://github.com/bats-core/bats-core
+
+### sops
+Can be downloaded here: https://github.com/mozilla/sops/releases
+
+Alternately available via [homebrew](https://brew.sh/):
+
+```bash
+brew install sops
+```
+
+More information's here: https://github.com/mozilla/sops
+
+### gpg
+sops only non public cloud encryption method based on gpg.
+
+Alternately available via [homebrew](https://brew.sh/):
+```bash
+brew info gnupg
+```
+
+On Linux use your package manager to install gpg if it's not already installed.
+
+### vault-cli (optional)
+The vault cli is only required to run the tests with the `HELM_SECRETS_DRIVER=vault` environment variable.
+
+You could download vault here: https://www.vaultproject.io/downloads
+
+Alternately available via [homebrew](https://brew.sh/):
+```bash
+brew info vault
+```
+
+## Run
+
+If possible start the tests from the root of the repository. Then execute:
+
+```bash
+# Unit Tests
+bats -r tests/unit
+
+# IT Tests
+bats -r tests/it
+```
+
+If bats is not installed locally, you could run bats directory from this repo:
+
+```bash
+# Unit Tests
+./tests/bats/core/bin/bats -r tests/unit
+
+# IT Tests
+./tests/bats/core/bin/bats -r tests/it
+```
+
+This method is described as "Run bats from source" inside the bats-core documentation.
+
+More information about running single tests or filtering tests can be found here: https://github.com/bats-core/bats-core#usage
+
+By default, the sops driver is selected for tests. If you want to test an other secrets driver like
+[vault](../scripts/drivers/vault.sh) you could do it by env variable `HELM_SECRETS_DRIVER=vault`.
+
+```bash
+# Unit Tests
+HELM_SECRETS_DRIVER=vault bats -r tests/unit
+
+# IT Tests
+HELM_SECRETS_DRIVER=vault bats -r tests/it
+```
+
+The vault tests require a reachable vault server. Start one on you local machine by run:
+
+```bash
+vault server -dev -dev-root-token-id=test
+```
+
+The tests will seed the vault server as needed.

tests/unit/plugin-install.bats

@@ -6,6 +6,20 @@ load '../bats/extensions/bats-assert/load'
 load '../bats/extensions/bats-file/load'
 
 @test "plugin-install: helm plugin install" {
+    HOME=$(mktemp -d)
+    run helm plugin install "${GIT_ROOT}"
+    assert_output --regexp "$(printf "sops is already installed: sops .*\nInstalled plugin: secrets")"
+    assert_file_exist "${HOME}/.gitconfig"
+}
+
+@test "plugin-install: SKIP_SOPS_INSTALL=true helm plugin install" {
+    SKIP_SOPS_INSTALL=true
+    export SKIP_SOPS_INSTALL
+
+    HOME=$(mktemp -d)
+
+    run helm plugin install "${GIT_ROOT}"
+    assert_output --regexp "$(printf "Skipping sops installation.\nInstalled plugin: secrets")"
     assert_file_exist "${HOME}/.gitconfig"
 }