Merge pull request #126 from cisagov/improvement/update_skeleton-pyth…

…on-library_version

Bump version from `0.0.1` to `0.1.0`

Dockerfile

@@ -38,4 +38,4 @@ USER cisa
 EXPOSE 8080/TCP
 VOLUME ["/var/log"]
 ENTRYPOINT ["example"]
-CMD ["--log-level", "DEBUG"]
+CMD ["--log-level", "DEBUG", "4", "2"]

README.md

@@ -24,7 +24,7 @@ appropriate for Docker containers and the major languages that we use.
 To run the `cisagov/example` image via Docker:
 
 ```console
-docker run cisagov/example:0.0.1
+docker run cisagov/example:0.1.0
 ```
 
 ### Running with Docker Compose ###
@@ -37,7 +37,7 @@ docker run cisagov/example:0.0.1
 
     services:
       example:
-        image: cisagov/example:0.0.1
+        image: cisagov/example:0.1.0
         volumes:
           - type: bind
             source: <your_log_dir>
@@ -82,7 +82,7 @@ environment variables.  See the
 
     services:
       example:
-        image: cisagov/example:0.0.1
+        image: cisagov/example:0.1.0
         volumes:
           - type: bind
             source: <your_log_dir>
@@ -125,7 +125,7 @@ environment variables.  See the
 1. Pull the new image:
 
     ```console
-    docker pull cisagov/example:0.0.1
+    docker pull cisagov/example:0.1.0
     ```
 
 1. Recreate and run the container by following the [previous instructions](#running-with-docker).
@@ -135,13 +135,13 @@ environment variables.  See the
 The images of this container are tagged with [semantic
 versions](https://semver.org) of the underlying example project that they
 containerize.  It is recommended that most users use a version tag (e.g.
-`:0.0.1`).
+`:0.1.0`).
 
 | Image:tag | Description |
 |-----------|-------------|
-|`cisagov/example:1.2.3`| An exact release version. |
-|`cisagov/example:1.2`| The most recent release matching the major and minor version numbers. |
-|`cisagov/example:1`| The most recent release matching the major version number. |
+|`cisagov/example:0.1.0`| An exact release version. |
+|`cisagov/example:0.1`| The most recent release matching the major and minor version numbers. |
+|`cisagov/example:0`| The most recent release matching the major version number. |
 |`cisagov/example:edge` | The most recent image built from a merge into the `develop` branch of this repository. |
 |`cisagov/example:nightly` | A nightly build of the `develop` branch of this repository. |
 |`cisagov/example:latest`| The most recent release image pushed to a container registry.  Pulling an image using the `:latest` tag [should be avoided.](https://vsupalov.com/docker-latest-tag/) |
@@ -196,8 +196,8 @@ Build the image locally using this git repository as the [build context](https:/
 
 ```console
 docker build \
-  --build-arg VERSION=0.0.1 \
-  --tag cisagov/example:0.0.1 \
+  --build-arg VERSION=0.1.0 \
+  --tag cisagov/example:0.1.0 \
   https://github.com/cisagov/example.git#develop
 ```
 
@@ -227,9 +227,9 @@ Docker:
     docker buildx build \
       --file Dockerfile-x \
       --platform linux/amd64 \
-      --build-arg VERSION=0.0.1 \
+      --build-arg VERSION=0.1.0 \
       --output type=docker \
-      --tag cisagov/example:0.0.1 .
+      --tag cisagov/example:0.1.0 .
     ```
 
 ## New repositories from a skeleton ##

docker-compose.yml

@@ -12,7 +12,7 @@ services:
     # Run the container normally
     build:
       # VERSION must be specified on the command line:
-      # e.g., --build-arg VERSION=0.0.1
+      # e.g., --build-arg VERSION=0.1.0
       context: .
       dockerfile: Dockerfile
     image: cisagov/example

src/version.txt

@@ -1 +1 @@
-__version__ = "0.0.1"
+__version__ = "0.1.0"

tests/container_test.py

@@ -10,6 +10,7 @@
 
 ENV_VAR = "ECHO_MESSAGE"
 ENV_VAR_VAL = "Hello World from docker compose!"
+DIVISION_RESULT = "4 / 2 == 2.000000"
 READY_MESSAGE = "This is a debug message"
 SECRET_QUOTE = (
     "There are no secrets better kept than the secrets everybody guesses."  # nosec
@@ -52,6 +53,10 @@ def test_output(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")
+    assert DIVISION_RESULT in log_output, "Division result not found in log output."
+    assert (
+        ENV_VAR_VAL in log_output
+    ), "Environment variable value not found in log output."
     assert SECRET_QUOTE in log_output, "Secret not found in log output."