Replace bats embed with bats-core submodule

Signed-off-by: Clarence "Sparr" Risher <[email protected]>

.gitattributes

@@ -4,7 +4,5 @@
 # Force the bash scripts to be checked out with LF line endings.
 git-secrets text eol=lf
 git-secrets.1 text eol=lf
-test/bats/bin/* text eol=lf
-test/bats/libexec/* text eol=lf
 *.bats text eol=lf
 *.bash text eol=lf

.github/workflows/test.yml

@@ -5,11 +5,14 @@ on:
   push:
     branches:
       - 'master'
-  pull_request: {}
+  pull_request:
+  workflow_dispatch:
 
 jobs:
   test:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
+        with:
+          submodules: true
       - run: make test

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "test/bats-core"]
+	path = test/bats-core
+	url = https://github.com/bats-core/bats-core.git

CONTRIBUTING.md

@@ -11,8 +11,7 @@ information to effectively respond to your bug report or contribution.
 
 We welcome you to use the GitHub issue tracker to report bugs or suggest features.
 
-When filing an issue, please check [existing open](https://github.com/awslabs/git-secrets/issues), or [recently closed](https://github.com/awslabs/git-secrets/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already 
-reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
+When filing an issue, please check [existing open](https://github.com/awslabs/git-secrets/issues), or [recently closed](https://github.com/awslabs/git-secrets/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
 
 * A reproducible test case or series of steps
 * The version of our code being used
@@ -21,6 +20,7 @@ reported the issue. Please try to include as much information as you can. Detail
 
 
 ## Contributing via Pull Requests
+
 Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
 
 1. You are working against the latest source on the *master* branch.
@@ -41,16 +41,26 @@ GitHub provides additional document on [forking a repository](https://help.githu
 
 
 ## Finding contributions to work on
+
 Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels ((enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/awslabs/git-secrets/labels/help%20wanted) issues is a great place to start. 
 
 
+## Testing
+
+We use [bats-core](https://github.com/bats-core/bats-core) for testing. It is configured as a submodule of this repository, which will be checked out automatically by `make test` if necessary.
+
+New functionality should include new tests. The existing tests in `test/*.bats` can be used as examples.
+
+
 ## Code of Conduct
+
 This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct). 
 For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact 
 [email protected] with any additional questions or comments.
 
 
 ## Security issue notifications
+
 If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
 
 

Makefile

@@ -7,14 +7,18 @@ help:
 	@echo "  man      to build the man file from README.rst"
 	@echo "  install  to install. Use PREFIX and MANPREFIX to customize."
 
-# We use bats for testing: https://github.com/sstephenson/bats
-test:
-	LANG=C test/bats/bin/bats test/
+# We use bats-core for testing: https://github.com/bats-core/bats-core
+test: test/bats-core/bin/bats
+	@LANG=C test/bats-core/bin/bats test/
+
+test/bats-core/bin/bats:
+	@git submodule init test/bats-core
+	@git submodule update test/bats-core
 
 # The man page is completely derived from README.rst. Edits to
 # README.rst require a rebuild of the man page.
 man:
-	rst2man.py README.rst > git-secrets.1
+	@rst2man.py README.rst > git-secrets.1
 
 install:
 	@mkdir -p ${DESTDIR}${MANPREFIX}

NOTICE.txt

@@ -1,6 +1,2 @@
 git-secrets
 Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
-
-bats
-This product bundles bats, which is available under a "MIT" license.
-For details, see test/bats.