Initialise bash-lib repo

hughsaunders commented 5 years ago

This commit adds the structure of the libraries and a few funcions. Most of the code in this commit is geared towards making sure this repo stays tested and documented in future.

The following things are checked:

All functions are documented
All functions are tested
All scripts are linted

See Readme for a list of the functions that are included, and for more information on testing with BATS.

hughsaunders commented 5 years ago

Review notes:

There isn't much output in Jenkins when all the tests pass, check the tests tab to see the list of tests performed.
Maybe start with the readme.
This is a large PR to an empty repo, I suggest we lean towards LGTM, merge it and iterate. However I'm importing via PR incase anyone has any high level objections.

jvanderhoof commented 5 years ago

This looks great @hughsaunders! I didn't realize (my ignorance) there were decent tools for testing Shell scripts.

hughsaunders commented 5 years ago

Notes for review round 2

Please err on the side of LGTM, then we can merge this and iterate.
This PR now pulls in three subtrees, that code is entirely upstream and should not be reviewed. To only review the original code, view the only non merge commit, currently: 1a441a3.
Subtree related functionality has been pulled, because this was taking too long, and subtree functions don't pass their tests due to an old version of git on the Jenkins executors (git 2.8 required as it includes this commit but 2.7.4 is available). WIP Branch
If you have already reviewed and just want to see differences since the first round of reviews, clone and use git locally. The GitHub UI can't show diffs between un-mergeable commits 😞

15:31 $ git diff --stat review_round_1 review_round_2_no_subtrees
 .gitmodules                                               |   9 ----
 .gittrees                                                 |  13 +++++
 Jenkinsfile                                               |  18 +++----
 README.md                                                 | 135 +++++++++++++++++++++++-----------------------
 filehandling/{lib.sh => lib}                              |   4 +-
 git/lib                                                   |  79 +++++++++++++++++++++++++++
 git/lib.sh                                                |  13 -----
 helpers/lib                                               |  20 +++++++
 helpers/lib.sh                                            |  18 -------
 init.sh => init                                           |  18 +++----
 k8s/Dockerfile                                            |  38 ++++++++-----
 k8s/{lib.sh => lib}                                       |  16 +++---
 k8s/{platform_login.sh => platform_login}                 |   4 ++
 logging/{lib.sh => lib}                                   |   2 +-
 run-tests                                                 |  16 ++++++
 run-tests.sh                                              |  13 -----
 test-utils/bats                                           |   1 -
 test-utils/bats-assert-1                                  |   1 -
 test-utils/bats-support                                   |   1 -
 test-utils/{lib.sh => lib}                                |  25 +++++----
 test-utils/tap2junit/Dockerfile                           |   9 ++--
 test-utils/tap2junit/tap2junit.py                         |  22 ++++----
 tests-for-this-repo/filehandling.bats                     |   6 +--
 tests-for-this-repo/git.bats                              | 138 ++++++++++++++++++++++++++++++++++++++++++------
 tests-for-this-repo/helpers.bats                          |  12 ++---
 tests-for-this-repo/k8s.bats                              |   6 +--
 tests-for-this-repo/lint.bats                             |  81 +++++++++++++---------------
 tests-for-this-repo/logging.bats                          |   6 +--
 tests-for-this-repo/python-lint.sh                        |  18 -------
 tests-for-this-repo/python-lint/Dockerfile                |   9 ++--
 tests-for-this-repo/{run-bats-tests.sh => run-bats-tests} |  41 ++++++++------
 tests-for-this-repo/run-gitleaks                          |  18 +++++++
 tests-for-this-repo/run-python-lint                       |  20 +++++++
 tests-for-this-repo/test-utils.bats                       |  79 ++++++++++++++-------------
 34 files changed, 567 insertions(+), 342 deletions(-)

sgnn7 commented 5 years ago

@dividedmind When you get a chance, can you go through this PR (it's pretty bulky though) and this comment to see what items seem worth addressing in a followup PR from @hughsaunders?

cyberark / bash-lib

Initialise bash-lib repo #1

Notes for review round 2