Enable SQL integration test and see failures with actual script execution

Author: BrianSipos

.github/workflows/build-test.yaml

@@ -73,40 +73,32 @@ jobs:
         run: python3 -m pytest -v --cov=camp test
 
   test-integration-sql:
-    if: false # FIXME re-enable after SQL updates
     needs: [build]
     runs-on: ubuntu-22.04
-    # Job executes within a container
-    container: ubuntu:22.04
-
-    services:
-      postgres:
-        image: postgres:14
-        env:
-          POSTGRES_DB: runner
-          POSTGRES_USER: postgres      
-          POSTGRES_PASSWORD: postgres
-        options: >-
-          --health-cmd pg_isready
-          --health-interval 10s
-          --health-timeout 5s
-          --health-retries 5
+    strategy:
+      max-parallel: 4
+      matrix:
+        python-version: ["3.10"]
 
     env:
       PGHOST: postgres
-      PGDATABASE: runner
       PGUSER: postgres
       PGPASSWORD: postgres
+      PGDATABASE: runner
     steps:
-      - name: Prep Container OS
-        run: |
-          apt-get update
-          apt-get install -y git postgresql-client-14 python3-pip
-          pip3 install --upgrade pip
       - name: Checkout repository
         uses: actions/checkout@v3
         with:
           submodules: recursive
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y \
+              postgresql-client-14
       - name: Test
         run: ./integration-test/run.sh sql
 
@@ -117,6 +109,7 @@ jobs:
       max-parallel: 4
       matrix:
         python-version: ["3.10"]
+
     steps:
       - name: Checkout repository
         uses: actions/checkout@v3

integration-test/run.sh

@@ -22,21 +22,23 @@ if [[ ! -d ${SELFDIR}/deps/adms ]]
 then
     git clone --branch apl-fy24 https://github.com/JHUAPL-DTNMA/dtnma-adms.git ${SELFDIR}/deps/adms
 fi
+
 if [[ ! -d ${SELFDIR}/deps/dtnma-ace ]]
 then
     git clone --branch apl-fy24 https://github.com/JHUAPL-DTNMA/dtnma-ace.git ${SELFDIR}/deps/dtnma-ace
 fi
 pip3 install ${SELFDIR}/deps/dtnma-ace
 
+if [[ ! -d ${SELFDIR}/deps/dtnma-tools ]]
+then
+    git clone --branch apl-fy24 https://github.com/JHUAPL-DTNMA/dtnma-tools.git ${SELFDIR}/deps/dtnma-tools
+    pushd ${SELFDIR}/deps/dtnma-tools
+    git submodule update --init --recursive
+    popd
+fi
+
 if [[ "$1" = "c" ]]
 then
-    if [[ ! -d ${SELFDIR}/deps/dtnma-tools ]]
-    then
-        git clone --branch apl-fy24 https://github.com/JHUAPL-DTNMA/dtnma-tools.git ${SELFDIR}/deps/dtnma-tools
-        pushd ${SELFDIR}/deps/dtnma-tools
-        git submodule update --init --recursive
-        popd
-    fi
     pushd ${SELFDIR}/deps/dtnma-tools
     git pull
     ./deps.sh
@@ -45,18 +47,38 @@ then
     then
         pushd ${SELFDIR}/deps/dtnma-tools
         ./prep.sh -DTEST_MEMCHECK=OFF -DTEST_COVERAGE=OFF \
-		  -DBUILD_DOCS_API=OFF -DBUILD_DOCS_MAN=OFF
+            -DBUILD_DOCS_API=OFF -DBUILD_DOCS_MAN=OFF
         ./build.sh
         # verification that the initial build is good
         ./build.sh check
         popd
     fi
     PYTEST_ARGS="${SELFDIR}/test_c_integration.py"
+elif [[ "$1" = "sql" ]]
+then
+    DOCKER=${DOCKER:-docker}
+    COMPOSE_ARGS="-f ${SELFDIR}/sql-compose.yml"
+    ${DOCKER} compose ${COMPOSE_ARGS} build
+    ${DOCKER} compose ${COMPOSE_ARGS} up --detach --force-recreate --remove-orphans
+
+    export PGHOST="localhost"
+    # all other PG* test environment is passed through this script
+
+    PYTEST_ARGS="${SELFDIR}/test_sql_integration.py"
 else
     echo "Unknown test type \"$1\"" >/dev/stderr
     exit 1
 fi
 
 echo "Running tests..."
 pip3 install '.[test]'
-python3 -m pytest -v --cov=camp ${PYTEST_ARGS}
+TESTEXIT=0
+python3 -m pytest -v --cov=camp --log-level=info ${PYTEST_ARGS} || TESTEXIT=$?
+
+if [[ "$1" = "sql" ]]
+then
+    ${DOCKER} compose ${COMPOSE_ARGS} down --rmi local --volumes
+    ${DOCKER} compose ${COMPOSE_ARGS} rm --force --volumes
+fi
+
+exit ${TESTEXIT}

integration-test/sql-compose.yml

@@ -0,0 +1,19 @@
+volumes:
+  postgres-data:
+    # temporary storage
+
+services:
+  postgres:
+    build:
+      context: deps/dtnma-tools/refdb-sql
+      dockerfile: Containerfile
+    hostname: postgres
+    restart: no
+    environment:
+      POSTGRES_USER: ${PGUSER}
+      POSTGRES_PASSWORD: ${PGPASSWORD}
+      POSTGRES_DB: ${PGDATABASE}
+    volumes:
+      - "postgres-data:/var/lib/postgresql/data"
+    ports:
+      - "5432:5432/tcp"

integration-test/test_c_integration.py

@@ -1,9 +1,9 @@
-import pytest
 import logging
 import os
-import ace
+import pytest
 import shutil
 import subprocess
+import ace
 from camp.generators.lib.campch import yang_to_c
 from .util import ADMS_DIR, DTNMA_TOOLS_DIR, adm_files, run_camp
 
@@ -42,9 +42,9 @@ def test_adms(adm):
     adm_set = ace.AdmSet()
     # generates a new file
     norm_name = adm_set.load_from_file(filepath).norm_name
-    impl = f"{yang_to_c(norm_name)}.c"
-    LOGGER.info('Looking for implementation source %s', impl)
-    outdir = _find_dir(impl, OUT_DIR)
+    filename = f"{yang_to_c(norm_name)}.c"
+    LOGGER.info('Looking for implementation source %s', filename)
+    outdir = _find_dir(filename, OUT_DIR)
     if outdir is None:
         pytest.skip('No existing source')
     LOGGER.info('Found at %s', outdir)

integration-test/test_sql_integration.py

@@ -1,10 +1,13 @@
-import psycopg2
+import logging
 import os
-import ace
+import psycopg2
 import pytest
-
+import tempfile
+import ace
+from camp.generators.lib.campch import yang_to_sql
 from .util import ADMS_DIR, adm_files, run_camp
-from camp.generators.create_sql import yang_to_sql
+
+LOGGER = logging.getLogger(__name__)
 
 
 @pytest.fixture(scope="session", autouse=True)
@@ -27,10 +30,9 @@ def setup():
     cursor = conn.cursor()
 
     # reusable objects that the tests will need
-    yield cursor,
+    yield conn,
 
     # teardown: close connections
-    cursor.close()
     conn.close()
 
 
@@ -41,22 +43,31 @@ def test_adms(setup, adm):
     Resulting sql files will be placed in ADMS_DIR/amp-sql/Agent_Scripts and executed in the anms library.
     """
 
-    if adm == 'ietf-amm.yang':  # doesn't have unique enum
-        pytest.xfail("ADM with known issue")
-
-    cursor = setup[0]
+    conn = setup[0]
 
     # input file full filepath
     filepath = os.path.join(ADMS_DIR, adm)
 
+    # output to temporary
+    adm_set = ace.AdmSet()
+    norm_name = adm_set.load_from_file(filepath).norm_name
+    filename = f"{yang_to_sql(norm_name)}.sql"
+    LOGGER.info('Expecting SQL source %s', filename)
+
+    outdir = tempfile.TemporaryDirectory()
+
     # run camp
-    exitcode = run_camp(filepath, ADMS_DIR, only_sql=True, only_ch=False)
+    exitcode = run_camp(filepath, outdir.name, only_sql=True, only_ch=False)
     assert 0 == exitcode
 
-    # execute sql
-    adm_set = ace.AdmSet()
-    norm_name = yang_to_sql(adm_set.load_from_file(filepath).norm_name)
-    sql_file = os.path.join(ADMS_DIR, "amp-sql", "Agent_Scripts", 'adm_{name}.sql'.format(name=norm_name))
-    with open(sql_file, "r") as f:
-        cursor.execute(f.read())
-        cursor.execute("rollback")
+    # verify the generated source executes
+    file_path = os.path.join(outdir.name, filename)
+    with open(file_path, "r") as srcfile:
+        script = srcfile.read()
+        LOGGER.info('Generated script:\n%s', script)
+
+        try:
+            with conn.cursor() as curs:
+                curs.execute(script)
+        finally:
+            conn.rollback()