Merge pull request #77 from cisagov/lineage/skeleton

⚠️ CONFLICT! Lineage pull request for: skeleton

Author: jsf9k

.ansible-lint

@@ -1,10 +1,9 @@
 ---
-# See https://ansible-lint.readthedocs.io/en/latest/configuring.html
-# for a list of the configuration elements that can exist in this
-# file.
+# See https://ansible-lint.readthedocs.io/configuring/ for a list of
+# the configuration elements that can exist in this file.
 enable_list:
   # Useful checks that one must opt-into.  See here for more details:
-  # https://ansible-lint.readthedocs.io/en/latest/rules.html
+  # https://ansible-lint.readthedocs.io/rules/
   - fcqn-builtins
   - no-log-password
   - no-same-owner

.github/CODEOWNERS

@@ -3,8 +3,8 @@
 # These owners will be the default owners for everything in the
 # repo. Unless a later match takes precedence, these owners will be
 # requested for review when someone opens a pull request.
-* @dav3r @jsf9k @mcdonnnj
+* @dav3r @jasonodoom @jsf9k @mcdonnnj
 
 # These folks own any files in the .github directory at the root of
 # the repository and any of its subdirectories.
-/.github/ @dav3r @felddy @jsf9k @mcdonnnj
+/.github/ @dav3r @felddy @jasonodoom @jsf9k @mcdonnnj

.github/workflows/build.yml

@@ -47,13 +47,16 @@ jobs:
       - id: setup-python
         uses: actions/setup-python@v4
         with:
-          python-version: "3.10"
+          python-version: "3.11"
       # We need the Go version and Go cache location for the actions/cache step,
       # so the Go installation must happen before that.
       - id: setup-go
-        uses: actions/setup-go@v3
+        uses: actions/setup-go@v4
         with:
-          go-version: "1.19"
+          # There is no expectation for actual Go code so we disable caching as
+          # it relies on the existence of a go.sum file.
+          cache: false
+          go-version: "1.20"
       - name: Lookup Go cache directory
         id: go-cache
         run: |
@@ -113,7 +116,7 @@ jobs:
         run: go install ${PACKAGE_URL}@${PACKAGE_VERSION}
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip
+          python -m pip install --upgrade pip setuptools wheel
           pip install --upgrade --requirement requirements-test.txt
       - name: Set up pre-commit hook environments
         run: pre-commit install-hooks
@@ -303,7 +306,7 @@ jobs:
       - id: setup-python
         uses: actions/setup-python@v4
         with:
-          python-version: "3.10"
+          python-version: "3.11"
       - name: Cache testing environments
         uses: actions/cache@v3
         env:
@@ -318,7 +321,7 @@ jobs:
             ${{ env.BASE_CACHE_KEY }}
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip
+          python -m pip install --upgrade pip setuptools wheel
           pip install --upgrade --requirement requirements-test.txt
       - name: Download docker image artifact
         uses: actions/download-artifact@v3

.pre-commit-config.yaml

@@ -31,35 +31,54 @@ repos:
 
   # Text file hooks
   - repo: https://github.com/igorshubovych/markdownlint-cli
-    rev: v0.33.0
+    rev: v0.34.0
     hooks:
       - id: markdownlint
         args:
           - --config=.mdl_config.yaml
   - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: v3.0.0-alpha.4
+    rev: v3.0.0-alpha.9-for-vscode
     hooks:
       - id: prettier
   - repo: https://github.com/adrienverge/yamllint
-    rev: v1.29.0
+    rev: v1.32.0
     hooks:
       - id: yamllint
         args:
           - --strict
 
   # GitHub Actions hooks
   - repo: https://github.com/python-jsonschema/check-jsonschema
-    rev: 0.21.0
+    rev: 0.23.1
     hooks:
       - id: check-github-actions
       - id: check-github-workflows
 
   # pre-commit hooks
   - repo: https://github.com/pre-commit/pre-commit
-    rev: v3.0.2
+    rev: v3.3.2
     hooks:
       - id: validate_manifest
 
+  # Go hooks
+  - repo: https://github.com/TekWizely/pre-commit-golang
+    rev: v1.0.0-rc.1
+    hooks:
+      # Style Checkers
+      - id: go-critic
+      # StaticCheck
+      - id: go-staticcheck-repo-mod
+      # Go Build
+      - id: go-build-repo-mod
+      # Go Mod Tidy
+      - id: go-mod-tidy-repo
+      # Go Test
+      - id: go-test-repo-mod
+      # Go Vet
+      - id: go-vet-repo-mod
+      # GoSec
+      - id: go-sec-repo-mod
+
   # Shell script hooks
   - repo: https://github.com/cisagov/pre-commit-shfmt
     rev: v0.0.2
@@ -83,7 +102,7 @@ repos:
   # Python hooks
   # Run bandit on the "tests" tree with a configuration
   - repo: https://github.com/PyCQA/bandit
-    rev: 1.7.4
+    rev: 1.7.5
     hooks:
       - id: bandit
         name: bandit (tests tree)
@@ -92,13 +111,13 @@ repos:
           - --config=.bandit.yml
   # Run bandit on everything except the "tests" tree
   - repo: https://github.com/PyCQA/bandit
-    rev: 1.7.4
+    rev: 1.7.5
     hooks:
       - id: bandit
         name: bandit (everything else)
         exclude: tests
   - repo: https://github.com/psf/black
-    rev: 22.12.0
+    rev: 23.3.0
     hooks:
       - id: black
   - repo: https://github.com/PyCQA/flake8
@@ -112,34 +131,34 @@ repos:
     hooks:
       - id: isort
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v0.991
+    rev: v1.3.0
     hooks:
       - id: mypy
         additional_dependencies:
           - types-pytz
           - types-PyYAML
   - repo: https://github.com/asottile/pyupgrade
-    rev: v3.3.1
+    rev: v3.4.0
     hooks:
       - id: pyupgrade
 
   # Ansible hooks
   - repo: https://github.com/ansible-community/ansible-lint
-    rev: v5.4.0
+    rev: v6.17.0
     hooks:
       - id: ansible-lint
       # files: molecule/default/playbook.yml
 
   # Terraform hooks
   - repo: https://github.com/antonbabenko/pre-commit-terraform
-    rev: v1.77.0
+    rev: v1.80.0
     hooks:
       - id: terraform_fmt
       - id: terraform_validate
 
   # Docker hooks
   - repo: https://github.com/IamTheFij/docker-pre-commit
-    rev: v2.1.1
+    rev: v3.0.1
     hooks:
       - id: docker-compose-check
 

requirements-test.txt

@@ -1,4 +1,4 @@
 --requirement requirements.txt
 pre-commit
 pytest
-pytest-dockerc
+python-on-whales

setup-env

@@ -65,7 +65,7 @@ done
 eval set -- "$PARAMS"
 
 # Check to see if pyenv is installed
-if [ -z "$(command -v pyenv)" ] || [ -z "$(command -v pyenv-virtualenv)" ]; then
+if [ -z "$(command -v pyenv)" ] || { [ -z "$(command -v pyenv-virtualenv)" ] && [ ! -f "$(pyenv root)/plugins/pyenv-virtualenv/bin/pyenv-virtualenv" ]; }; then
   echo "pyenv and pyenv-virtualenv are required."
   if [[ "$OSTYPE" == "darwin"* ]]; then
     cat << 'END_OF_LINE'
@@ -189,5 +189,5 @@ else:
 END_OF_LINE
 )"
 
-# Qapla
+# Qapla'
 echo "Success!"

tests/conftest.py

@@ -4,15 +4,24 @@
 """
 # Third-Party Libraries
 import pytest
+from python_on_whales import docker
 
 MAIN_SERVICE_NAME = "saver"
 
 
+@pytest.fixture(scope="session")
+def dockerc():
+    """Start up the Docker composition."""
+    docker.compose.up(detach=True)
+    yield docker
+    docker.compose.down()
+
+
 @pytest.fixture(scope="session")
 def main_container(dockerc):
     """Return the main container from the Docker composition."""
     # find the container by name even if it is stopped already
-    return dockerc.containers(service_names=[MAIN_SERVICE_NAME], stopped=True)[0]
+    return dockerc.compose.ps(services=[MAIN_SERVICE_NAME], all=True)[0]
 
 
 # See #60
@@ -23,7 +32,7 @@ def main_container(dockerc):
 #     The version container should just output the version of its underlying contents.
 #     """
 #     # find the container by name even if it is stopped already
-#     return dockerc.containers(service_names=[VERSION_SERVICE_NAME], stopped=True)[0]
+#     return dockerc.compose.ps(services=[VERSION_SERVICE_NAME], all=True)[0]
 
 
 def pytest_addoption(parser):

tests/container_test.py

@@ -8,7 +8,7 @@ def test_container_count(dockerc):
     """Verify the test composition and container."""
     # stopped parameter allows non-running containers in results
     assert (
-        len(dockerc.containers(stopped=True)) == 2
+        len(dockerc.compose.ps(all=True)) == 2
     ), "Wrong number of containers were started."
 
 
@@ -17,7 +17,7 @@ def test_container_count(dockerc):
 #     """Wait for container to be ready."""
 #     TIMEOUT = 10
 #     for i in range(TIMEOUT):
-#         if READY_MESSAGE in main_container.logs().decode("utf-8"):
+#         if READY_MESSAGE in main_container.logs():
 #             break
 #         time.sleep(1)
 #     else:
@@ -28,19 +28,22 @@ def test_container_count(dockerc):
 
 
 # See #60
-# def test_wait_for_exits(main_container, version_container):
+# def test_wait_for_exits(dockerc, main_container, version_container):
 #     """Wait for containers to exit."""
-#     assert main_container.wait() == 0, "Container service (main) did not exit cleanly"
 #     assert (
-#         version_container.wait() == 0
+#         dockerc.wait(main_container.id) == 0
+#     ), "Container service (main) did not exit cleanly"
+#     assert (
+#         dockerc.wait(version_container.id) == 0
 #     ), "Container service (version) did not exit cleanly"
 
 
 # See #60
-# def test_output(main_container):
+# def test_output(dockerc, main_container):
 #     """Verify the container had the correct output."""
-#     main_container.wait()  # make sure container exited if running test isolated
-#     log_output = main_container.logs().decode("utf-8")
+#     # make sure container exited if running test isolated
+#     dockerc.wait(main_container.id)
+#     log_output = main_container.logs()
 #     assert SECRET_QUOTE in log_output, "Secret not found in log output."
 
 
@@ -60,10 +63,11 @@ def test_container_count(dockerc):
 
 
 # See #60
-# def test_log_version(version_container):
+# def test_log_version(dockerc, version_container):
 #     """Verify the container outputs the correct version to the logs."""
-#     version_container.wait()  # make sure container exited if running test isolated
-#     log_output = version_container.logs().decode("utf-8").strip()
+#     # make sure container exited if running test isolated
+#     dockerc.wait(version_container.id)
+#     log_output = version_container.logs().strip()
 #     pkg_vars = {}
 #     with open(VERSION_FILE) as f:
 #         exec(f.read(), pkg_vars)  # nosec
@@ -81,5 +85,6 @@ def test_container_count(dockerc):
 #         exec(f.read(), pkg_vars)  # nosec
 #     project_version = pkg_vars["__version__"]
 #     assert (
-#         version_container.labels["org.opencontainers.image.version"] == project_version
+#         version_container.config.labels["org.opencontainers.image.version"]
+#         == project_version
 #     ), "Dockerfile version label does not match project version"