Merge pull request #63 from cisagov/bugfix/correct-home-dir-name

Correct name of home directory

README.md

@@ -33,7 +33,7 @@ expects the secrets in a different location.
 To run the `cisagov/saver` image via Docker:
 
 ```console
-docker run cisagov/saver:1.3.0
+docker run cisagov/saver:1.3.1
 ```
 
 ### Running with Docker Compose ###
@@ -46,7 +46,7 @@ docker run cisagov/saver:1.3.0
 
     services:
       saver:
-        image: cisagov/saver:1.3.0
+        image: cisagov/saver:1.3.1
         volumes:
           - type: bind
             source: <your_log_dir>
@@ -92,7 +92,7 @@ environment variables.  See the
 
     services:
       trustymail_reporter:
-        image: cisagov/saver:1.3.0
+        image: cisagov/saver:1.3.1
         volumes:
           - type: bind
             source: <your_log_dir>
@@ -129,7 +129,7 @@ environment variables.  See the
 1. Pull the new image:
 
     ```console
-    docker pull cisagov/saver:1.3.0
+    docker pull cisagov/saver:1.3.1
     ```
 
 1. Recreate and run the container by following the [previous instructions](#running-with-docker).
@@ -139,11 +139,11 @@ environment variables.  See the
 The images of this container are tagged with [semantic
 versions](https://semver.org) of the underlying saver project that they
 containerize.  It is recommended that most users use a version tag (e.g.
-`:1.3.0`).
+`:1.3.1`).
 
 | Image:tag | Description |
 |-----------|-------------|
-|`cisagov/saver:1.3.0`| An exact release version. |
+|`cisagov/saver:1.3.1`| An exact release version. |
 |`cisagov/saver:1.3`| The most recent release matching the major and minor version numbers. |
 |`cisagov/saver:1`| The most recent release matching the major version number. |
 |`cisagov/saver:edge` | The most recent image built from a merge into the `develop` branch of this repository. |
@@ -206,8 +206,8 @@ Build the image locally using this git repository as the [build context](https:/
 
 ```console
 docker build \
-  --build-arg VERSION=1.3.0 \
-  --tag cisagov/saver:1.3.0 \
+  --build-arg VERSION=1.3.1 \
+  --tag cisagov/saver:1.3.1 \
   https://github.com/cisagov/saver.git#develop
 ```
 
@@ -237,9 +237,9 @@ Docker:
     docker buildx build \
       --file Dockerfile-x \
       --platform linux/amd64 \
-      --build-arg VERSION=1.3.0 \
+      --build-arg VERSION=1.3.1 \
       --output type=docker \
-      --tag cisagov/saver:1.3.0 .
+      --tag cisagov/saver:1.3.1 .
     ```
 
 ## Contributing ##

src/create_sld_to_agency_name_and_id_mapping.py

@@ -5,17 +5,19 @@
 # Standard Python Libraries
 import csv
 import datetime
+import os
 
 # Third-Party Libraries
 from pymongo import MongoClient
 import yaml
 
 DB_CONFIG_FILE = "/run/secrets/scan_write_creds.yml"
-INCLUDE_DATA_DIR = "/home/saver/include/"
-SHARED_DATA_DIR = "/home/saver/shared/"
+HOME_DIR = os.environ.get("CISA_HOME")
+INCLUDE_DATA_DIR = f"{HOME_DIR}/include"
+SHARED_DATA_DIR = f"{HOME_DIR}/shared"
 
-AGENCIES_FILE = INCLUDE_DATA_DIR + "agencies.csv"
-CURRENT_FEDERAL_FILE = SHARED_DATA_DIR + "artifacts/current-federal_modified.csv"
+AGENCIES_FILE = f"{INCLUDE_DATA_DIR}/agencies.csv"
+CURRENT_FEDERAL_FILE = f"{SHARED_DATA_DIR}/artifacts/current-federal_modified.csv"
 
 
 def db_from_config(config_filename):

src/pshtt_csv2mongo.py

@@ -5,22 +5,24 @@
 # Standard Python Libraries
 import csv
 import datetime
+import os
 import re
 
 # Third-Party Libraries
 from mongo_db_from_config import db_from_config
 
 DB_CONFIG_FILE = "/run/secrets/scan_write_creds.yml"
-INCLUDE_DATA_DIR = "/home/saver/include/"
-SHARED_DATA_DIR = "/home/saver/shared/"
+HOME_DIR = os.environ.get("CISA_HOME")
+INCLUDE_DATA_DIR = f"{HOME_DIR}/include"
+SHARED_DATA_DIR = f"{HOME_DIR}/shared"
 
-AGENCIES_FILE = INCLUDE_DATA_DIR + "agencies.csv"
+AGENCIES_FILE = f"{INCLUDE_DATA_DIR}/agencies.csv"
 
-CURRENT_FEDERAL_FILE = SHARED_DATA_DIR + "artifacts/current-federal_modified.csv"
-UNIQUE_AGENCIES_FILE = SHARED_DATA_DIR + "artifacts/unique-agencies.csv"
-CLEAN_CURRENT_FEDERAL_FILE = SHARED_DATA_DIR + "artifacts/clean-current-federal.csv"
+CURRENT_FEDERAL_FILE = f"{SHARED_DATA_DIR}/artifacts/current-federal_modified.csv"
+UNIQUE_AGENCIES_FILE = f"{SHARED_DATA_DIR}/artifacts/unique-agencies.csv"
+CLEAN_CURRENT_FEDERAL_FILE = f"{SHARED_DATA_DIR}/artifacts/clean-current-federal.csv"
 
-PSHTT_RESULTS_FILE = SHARED_DATA_DIR + "artifacts/results/pshtt.csv"
+PSHTT_RESULTS_FILE = f"{SHARED_DATA_DIR}/artifacts/results/pshtt.csv"
 
 
 class Domainagency:

src/save_to_db.sh

@@ -1,25 +1,25 @@
 #!/bin/sh
 
-SHARED_DIR='/home/saver/shared'
+SHARED_DIR="${CISA_HOME}"/shared
 
 echo 'Waiting for scanner'
 while [ "$(redis-cli -h redis get scanning_complete)" != "true" ]; do
   sleep 5
 done
-echo "Scanner finished"
+echo Scanner finished
 
 # No longer needed
 redis-cli -h redis del scanning_complete
 
 # Process scan results and import them to the database
-echo 'Processing results...'
+echo Processing results...
 ./create_sld_to_agency_name_and_id_mapping.py
 ./pshtt_csv2mongo.py
-rm $SHARED_DIR/artifacts/unique-agencies.csv
-rm $SHARED_DIR/artifacts/clean-current-federal.csv
+rm "${SHARED_DIR}"/artifacts/unique-agencies.csv
+rm "${SHARED_DIR}"/artifacts/clean-current-federal.csv
 ./trustymail_csv2mongo.py
-rm $SHARED_DIR/artifacts/unique-agencies.csv
-rm $SHARED_DIR/artifacts/clean-current-federal.csv
+rm "${SHARED_DIR}"/artifacts/unique-agencies.csv
+rm "${SHARED_DIR}"/artifacts/clean-current-federal.csv
 ./sslyze_csv2mongo.py
 # Leave a copy of unique-agencies.csv and clean-current-federal.csv
 # since the report tool will need it

src/sslyze_csv2mongo.py

@@ -5,22 +5,24 @@
 # Standard Python Libraries
 import csv
 import datetime
+import os
 
 # Third-Party Libraries
 from mongo_db_from_config import db_from_config
 from pytz import timezone
 
 DB_CONFIG_FILE = "/run/secrets/scan_write_creds.yml"
-INCLUDE_DATA_DIR = "/home/saver/include/"
-SHARED_DATA_DIR = "/home/saver/shared/"
+HOME_DIR = os.environ.get("CISA_HOME")
+INCLUDE_DATA_DIR = f"{HOME_DIR}/include"
+SHARED_DATA_DIR = f"{HOME_DIR}/shared"
 
-AGENCIES_FILE = INCLUDE_DATA_DIR + "agencies.csv"
+AGENCIES_FILE = f"{INCLUDE_DATA_DIR}/agencies.csv"
 
-CURRENT_FEDERAL_FILE = SHARED_DATA_DIR + "artifacts/current-federal_modified.csv"
-UNIQUE_AGENCIES_FILE = SHARED_DATA_DIR + "artifacts/unique-agencies.csv"
-CLEAN_CURRENT_FEDERAL_FILE = SHARED_DATA_DIR + "artifacts/clean-current-federal.csv"
+CURRENT_FEDERAL_FILE = f"{SHARED_DATA_DIR}/artifacts/current-federal_modified.csv"
+UNIQUE_AGENCIES_FILE = f"{SHARED_DATA_DIR}/artifacts/unique-agencies.csv"
+CLEAN_CURRENT_FEDERAL_FILE = f"{SHARED_DATA_DIR}/artifacts/clean-current-federal.csv"
 
-SSLYZE_RESULTS_FILE = SHARED_DATA_DIR + "artifacts/results/sslyze.csv"
+SSLYZE_RESULTS_FILE = f"{SHARED_DATA_DIR}/artifacts/results/sslyze.csv"
 
 
 class Domainagency:

src/trustymail_csv2mongo.py

@@ -5,21 +5,23 @@
 # Standard Python Libraries
 import csv
 import datetime
+import os
 
 # Third-Party Libraries
 from mongo_db_from_config import db_from_config
 
 DB_CONFIG_FILE = "/run/secrets/scan_write_creds.yml"
-INCLUDE_DATA_DIR = "/home/saver/include/"
-SHARED_DATA_DIR = "/home/saver/shared/"
+HOME_DIR = os.environ.get("CISA_HOME")
+INCLUDE_DATA_DIR = f"{HOME_DIR}/include"
+SHARED_DATA_DIR = f"{HOME_DIR}/shared"
 
-AGENCIES_FILE = INCLUDE_DATA_DIR + "agencies.csv"
+AGENCIES_FILE = f"{INCLUDE_DATA_DIR}/agencies.csv"
 
-CURRENT_FEDERAL_FILE = SHARED_DATA_DIR + "artifacts/current-federal_modified.csv"
-UNIQUE_AGENCIES_FILE = SHARED_DATA_DIR + "artifacts/unique-agencies.csv"
-CLEAN_CURRENT_FEDERAL_FILE = SHARED_DATA_DIR + "artifacts/clean-current-federal.csv"
+CURRENT_FEDERAL_FILE = f"{SHARED_DATA_DIR}/artifacts/current-federal_modified.csv"
+UNIQUE_AGENCIES_FILE = f"{SHARED_DATA_DIR}/artifacts/unique-agencies.csv"
+CLEAN_CURRENT_FEDERAL_FILE = f"{SHARED_DATA_DIR}/artifacts/clean-current-federal.csv"
 
-TRUSTYMAIL_RESULTS_FILE = SHARED_DATA_DIR + "artifacts/results/trustymail.csv"
+TRUSTYMAIL_RESULTS_FILE = f"{SHARED_DATA_DIR}/artifacts/results/trustymail.csv"
 
 
 class Domainagency:

src/version.txt

@@ -1 +1 @@
-__version__ = "1.3.0"
+__version__ = "1.3.1"