Testing of seekrets rulesets using BATS

[LinuxBozo]

In order to ensure that our regex rules are correct, they should be tested, using BATS and run automatically with Travis.

Rulesets for git-seekrets are defined as regex inside a yaml file. These include rule name, the regex for the match, and any acceptable false positives as unmatch. Existing rulesets that need tests defined are here:
https://github.com/18F/laptop/tree/seekret/seekret-rules

Depends on #75 for easier implementation.

If fixing, please use seekret branch so it's merged into PR #69

More about the rules YAML: https://github.com/apuigsech/seekret/blob/75ab481819b4c1e1794497defea9a9332943295b/README.rst#rules

Acceptance Criteria

• Install git seekret in a repeatable way ( should be covered in another story )
• Install BATS in a repeatable way, readme
• Write BATS tests for each of these:
  • Check for git seekret installation.
  • Check for rulesets enabled.
  • Check that git seekret is called on a test repository and secrets are detected. (positives)
  • Check that git seekret is called on a test repository and non-secrets are not detected. (acceptable false positives)

[pburkholder]

Could you elaborate on what sort of testing you'd like to see here? That executing a set of git commands results in an error?

I might be able to help.

P

[LinuxBozo]

@pburkholder yeah, I was capturing these quickly as I was going through things, and planned on actually providing the meat soonish..

[alain-hoang]

Working to resolve dependency on issue #75

[alain-hoang]

This still requires missing dependency on #75 before it can pass tests. I've added pushed a branch here with current WIP for tests.

[alain-hoang]

Missing dependency on #75 has been updated however it appears that git-seekret is not properly applying rulesets on staged files or commits. Created #22 to address this

[rogeruiz]

The test repo can be created manually every time.

git init
touch README.md
echo "SHHHH... Secrets in this file" >> README.md
echo "fb^!uQ2oYEVPqfwSA=VP=6CXY9O8yYeIMcX8FcidX@CMP6O%Jv*9*MI+D+rZj!7a" >> README.md
echo "5c0d8a4d27d90a552aea44b880b8a452864f6e3f" >> README.md
echo "192.168.11.0" >> README.md
git commit # this should trigger the secrets and this is what we want to test in `BATS`.