circle: Use the latest NuoDB release Docker image

Change the hardcoded 5.1.2 release to use "latest".

Add support for the common-config context, which is needed to obtain the
license info needed for newer instances of NuoDB.

Modify the test configuration to install a license if (a) there is not
already one available in the domain, and (b) we have one provided in the
environment (from the common-config context).

Author: madscientist

.circleci/config.yml

@@ -2,24 +2,21 @@ version: 2.1
 
 commands:
   after_failure:
+    description: "Steps to be run after build or test failure"
     parameters:
       when:
         type: string
     steps:
       - run:
           name: On failure action
           command: |
-            env | sort
-            echo ------
-            cat $HOME/.bashrc $HOME/.profile $HOME/.bash_profile || true
-            echo ------
-            cat $HOME/.nuocmdrc || true
-            echo ------
-            cat /var/log/nuodb/nuoadmin.log* || true
-            echo ------
-            cat /tmp/nuotest.log || true
-            echo ------
-            grep ssl /etc/nuodb/nuoadmin.conf || true
+            env | sort > artifacts/env.out
+            cp -a $HOME/.bashrc artifacts || true
+            cp -a $HOME/.profile artifacts || true
+            cp -a $HOME/.bash_profile artifacts ||
+            cp -a $HOME/.nuocmdrc artifacts || true
+            cp -a /etc/nuodb/nuoadmin.conf artifacts || true
+            cp -a /var/log/nuodb/nuoadmin.log* artifacts || true
           when: <<parameters.when>>
 
       - when:
@@ -30,8 +27,9 @@ commands:
 
 jobs:
   build_n_run:
+    description: "Build the nuodb-python module and run the test suite"
     docker:
-      - image: nuodb/nuodb:5.1.2
+      - image: nuodb/nuodb:latest
         user: root
     resource_class: small
     environment:
@@ -43,31 +41,35 @@ jobs:
     steps:
       - checkout
       - run:
-          command: dnf install make -y
+          name: Make test directories
+          command: mkdir -p artifacts results
+      - run:
           name: Install make
+          command: dnf install make -y
       - run:
-          name : Install python dependencies
+          name: Install Python dependencies
           command: make install
       - run:
-          name : Create test result folder
-          command: mkdir test_results
-      - run:
-          name : Configure and run NuoDB Admin
+          name: Start NuoDB Admin
           command: |
-            sudo -u nuodb "/opt/nuodb/etc/nuoadmin" tls $NUO_SET_TLS
-            sudo -u nuodb "/opt/nuodb/etc/nuoadmin" tls status
-            sudo -u nuodb "/opt/nuodb/etc/nuoadmin" start
+            sudo -u nuodb /opt/nuodb/etc/nuoadmin tls $NUO_SET_TLS
+            sudo -u nuodb /opt/nuodb/etc/nuoadmin tls status
+            sudo -u nuodb /opt/nuodb/etc/nuoadmin start
+            sudo -u nuodb /opt/nuodb/bin/nuocmd --show-json get effective-license
       - run:
           name: Run test
-          command: make fulltest "PYTEST_ARGS=--log-file-level=10 --log-file=/tmp/nuotest.log"
+          command: make fulltest
       - store_artifacts:
-          path: htmlcov
+          path: artifacts
       - store_test_results:
-          path: test_results
+          path: results
       - after_failure:
           when : "on_fail"
 
 workflows:
   build-project:
     jobs:
-      - build_n_run
+      - build_n_run:
+          name: "Build and run regression tests"
+          context:
+            - common-config

.gitignore

@@ -35,8 +35,9 @@ pip-log.txt
 .tox
 .testtemp
 nosetests.xml
-htmlcov/
-test_results/
+.mypy_cache/
+artifacts/
+results/
 
 # Translations
 *.mo

setup.py

@@ -25,7 +25,10 @@
 from setuptools import setup
 
 with open(os.path.join(os.path.dirname(__file__), 'pynuodb', '__init__.py')) as v:
-    VERSION = re.compile(r"^ *__version__ *= *'(.*?)'", re.M).search(v.read()).group(1)
+    m = re.search(r"^ *__version__ *= *'(.*?)'", v.read(), re.M)
+    if m is None:
+        raise RuntimeError("Cannot detect version in pynuodb/__init__.py")
+    VERSION = m.group(1)
 
 readme = os.path.join(os.path.dirname(__file__), 'README.rst')
 

tests/conftest.py

@@ -13,6 +13,8 @@
 import time
 import socket
 import logging
+import base64
+import shutil
 
 try:
     from typing import Any, Generator, List  # pylint: disable=unused-import
@@ -36,6 +38,8 @@
 DBA_USER      = 'dba'
 DBA_PASSWORD  = 'dba_password'
 
+_CHARS = string.ascii_lowercase + string.digits
+
 # Unfortunately purging the DB also purges the archive so we have to remember
 # this externally from the archive fixture.
 __archive_created = False
@@ -89,24 +93,50 @@ def ap():
     cfg = cvtjson(out)[0]
     localaddr = '%s:%s' % (cfg['properties']['altAddr'], cfg['properties']['agentPort'])
 
-    _log.info("Checking licensing")
-    (ret, out) = nuocmd(['--show-json', 'get', 'effective-license'])
-    if ret != 0:
-        __fatal("Cannot retrieve NuoDB domain license: %s" % (out))
-    lic = cvtjson(out)[0]
     # We'll assume that any license at all is enough to run the minimum
     # database needed by the tests.
-    if not lic or 'decodedLicense' not in lic or 'type' not in lic['decodedLicense']:
-        __fatal("Invalid license: %s" % (out))
-    if lic['decodedLicense']['type'] == 'UNLICENSED':
-        __fatal("NuoDB domain is UNLICENSED")
+    def check_license():
+        # type: () -> Optional[str]
+        (ret, out) = nuocmd(['--show-json', 'get', 'effective-license'])
+        if ret != 0:
+            return "Cannot retrieve NuoDB domain license: %s" % (out)
+        lic = cvtjson(out)[0]
+        if not lic or 'decodedLicense' not in lic or 'type' not in lic['decodedLicense']:
+            return "Invalid license: %s" % (out)
+        if lic['decodedLicense']['type'] == 'UNLICENSED':
+            return "NuoDB domain is UNLICENSED"
+
+        return None
+
+    _log.info("Checking licensing")
+    err = check_license()
+
+    # If we need a license and one exists in the environment, install it
+    if err and os.environ.get('NUODB_LIMITED_LICENSE_CONTENT'):
+        licfile = 'nuodb%s.lic' % (''.join(random.choice(_CHARS) for x in range(10)))
+        licpath = os.path.join(tempfile.gettempdir(), licfile)
+        _log.info("Adding a license provided by the environment")
+        with open(licpath, 'wb') as f:
+            f.write(base64.b64decode(os.environ['NUODB_LIMITED_LICENSE_CONTENT']))
+        (ret, out) = nuocmd(['set', 'license', '--license-file', licpath])
+        try:
+            os.remove(licpath)
+        except Exception:
+            pass
+        if ret != 0:
+            __fatal("Failed to set a license: %s" % (out))
+
+        err = check_license()
+
+    if err:
+        __fatal(err)
 
     yield localap, localaddr
 
 
 @pytest.fixture(scope="session")
-def archive(ap):
-    # type: (AP_FIXTURE) -> Generator[ARCHIVE_FIXTURE, None, None]
+def archive(request, ap):
+    # type: (pytest.FixtureRequest, AP_FIXTURE) -> Generator[ARCHIVE_FIXTURE, None, None]
     """Find or create an archive.
 
     :return path, id
@@ -126,8 +156,7 @@ def archive(ap):
             _log.info("Using existing archive %s: %s" % (ar_id, ar_path))
 
     if not ar_id:
-        ardir = DATABASE_NAME + '-' + ''.join(random.choice(string.ascii_uppercase + string.digits)
-                                              for x in range(20))
+        ardir = DATABASE_NAME + '-' + ''.join(random.choice(_CHARS) for x in range(20))
         ar_path = os.path.join(tempfile.gettempdir(), ardir)
         _log.info("Creating archive %s" % (ar_path))
         (ret, out) = nuocmd(['--show-json', 'create', 'archive',
@@ -146,6 +175,10 @@ def archive(ap):
         (ret, out) = nuocmd(['delete', 'archive', '--archive-id', str(ar_id)])
         assert ret == 0, "Failed to delete archive %s: %s" % (ar_id, out)
 
+    # If nothing failed then delete the archive, else leave it for forensics
+    if request.session.testsfailed == 0:
+        shutil.rmtree(ar_path, ignore_errors=True)
+
 
 @pytest.fixture(scope="session")
 def get_db(archive):