Add circleci tests for multiple python versions

- Add matrix jobs to unit and ftp/sftp functional tests for python versions 3.9-3.11 - Update circleci cache keys to be compatible with matrix jobs - Update dependencies to avoid import errors in python versions 3.10 and 3.11 - Fix black version in Pipfile to avoid lint and format clash - Update deprecated moto mock call in conftest.py
octoenergy · Apr 30, 2024 · 3d2cce2 · 3d2cce2
1 parent e6e2a09
commit 3d2cce2
Show file tree

Hide file tree

Showing 4 changed files with 1,259 additions and 724 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -8,8 +8,13 @@ version: 2.1
 
 executors:
   standard:
+    parameters:
+      version:
+        description: "python version"
+        default: "3.9"
+        type: string
     docker:
-      - image: circleci/python:3.9
+      - image: cimg/python:<< parameters.version >>
         environment:
           PIPENV_VENV_IN_PROJECT: true
     working_directory: "~/lib"
@@ -42,54 +47,79 @@ commands:
             - "./.git"
 
   update_virtualenv:
+    parameters:
+      version:
+        description: "python version"
+        default: "3.9"
+        type: string
     steps:
       - restore_cache:
           keys:
-            - virtualenv-{{ .Environment.CACHE_VERSION }}-{{ .Branch }}-{{ checksum "Pipfile.lock" }}
-            - virtualenv-{{ .Environment.CACHE_VERSION }}-{{ .Branch }}-
-            - virtualenv-{{ .Environment.CACHE_VERSION }}-
+            - virtualenv-<< parameters.version >>{{ .Environment.CACHE_VERSION }}-{{ .Branch }}
+            - virtualenv-<< parameters.version >>{{ .Environment.CACHE_VERSION }}
       - configure_github
       - run:
           name: Install Python packages
           command: make sync
       - save_cache:
-          key: virtualenv-{{ .Environment.CACHE_VERSION }}-{{ .Branch }}-{{ checksum "Pipfile.lock" }}
+          key: virtualenv-<< parameters.version >>{{ .Environment.CACHE_VERSION }}-{{ .Branch }}
           paths:
             - "./.venv"
 
 jobs:
   lint:
-    executor: standard
+    parameters:
+      version:
+        description: "python version"
+        default: "3.9"
+        type: string
+    executor:
+      name: standard
+      version: << parameters.version >>
     steps:
       - checkout_source
-      - update_virtualenv
+      - update_virtualenv:
+          version: << parameters.version >>
       - run:
           name: Run Python linter
           command: make lint
 
   unit:
-    executor: standard
+    parameters:
+      version:
+        description: "python version"
+        default: "3.9"
+        type: string
+    executor: 
+      name: standard
+      version: << parameters.version >>
     steps:
       - checkout_source
-      - update_virtualenv
+      - update_virtualenv:
+          version: << parameters.version >>
       - run:
           name: Run Python unit tests
           command: make unit
 
   release:
+    parameters:
+        version:
+          description: "python version"
+          type: string
+          default: "3.9"
     working_directory: ~/lib
 
     docker:
-      - image: circleci/python:3.9
+      - image: cimg/python:<< parameters.version >>
 
     steps:
       - checkout_source
-      - update_virtualenv
+      - update_virtualenv:
+          version: "3.9"
       - restore_cache:
           keys:
-            - pip-cache-{{ .Environment.CACHE_VERSION }}-{{ .Branch }}-{{ checksum "Pipfile.lock" }}
-            - pip-cache-{{ .Environment.CACHE_VERSION }}-{{ .Branch }}-
-            - pip-cache-{{ .Environment.CACHE_VERSION }}-
+            - virtualenv-<< parameters.version >>{{ .Environment.CACHE_VERSION }}-{{ .Branch }}
+            - virtualenv-<< parameters.version >>{{ .Environment.CACHE_VERSION }}
 
       - run:
           name: verify git tag vs. version
@@ -111,10 +141,15 @@ jobs:
 
 
   functional-ftp:
+    parameters:
+      version:
+        description: "python version"
+        type: string
+        default: "3.9"
     working_directory: ~/lib
 
     docker:
-      - image: circleci/python:3.9
+      - image: cimg/python:<< parameters.version >>
         environment:
           TENTACLIO__CONN__FTP_TEST: ftp://octopus:tentacle@localhost
 
@@ -128,18 +163,29 @@ jobs:
 
       - restore_cache:
           keys:
-            - pip-cache-{{ .Environment.CACHE_VERSION }}-{{ .Branch }}-{{ checksum "Pipfile.lock" }}
+            - virtualenv-<< parameters.version >>{{ .Environment.CACHE_VERSION }}-{{ .Branch }}
+            - virtualenv-<< parameters.version >>{{ .Environment.CACHE_VERSION }}
 
       - run:
           name: Install Python packages
           command: make sync
 
+      - run:
+          name: Run ftp functional tests
+          command: make functional-ftp
+
+
 
   functional-sftp:
+    parameters:
+      version:
+        description: "python version"
+        type: string
+        default: "3.9"
     working_directory: ~/lib
 
     docker:
-      - image: circleci/python:3.9
+      - image: cimg/python:<< parameters.version >>
         environment:
           TENTACLIO__CONN__SFTP_TEST: sftp://octopus:tentacle@localhost:22
 
@@ -151,7 +197,8 @@ jobs:
 
       - restore_cache:
           keys:
-            - pip-cache-{{ .Environment.CACHE_VERSION }}-{{ .Branch }}-{{ checksum "Pipfile.lock" }}
+            - virtualenv-<< parameters.version >>{{ .Environment.CACHE_VERSION }}-{{ .Branch }}
+            - virtualenv-<< parameters.version >>{{ .Environment.CACHE_VERSION }}
 
       - run:
           name: Install Python packages
@@ -163,7 +210,6 @@ jobs:
 
 
 workflows:
-  version: 2
 
   test-build-deploy:
     jobs:
@@ -173,23 +219,35 @@ workflows:
             only: /.*/
 
       - unit:
-          filters:
-            tags:
-              only: /.*/
+          name: unit-<< matrix.version >>
+          matrix:
+            parameters:
+              version: ["3.9","3.10","3.11"]
+            filters:
+              tags:
+                only: /.*/
       - functional-ftp:
-          filters:
-            tags:
-              only: /.*/
+          name: functional-ftp-<< matrix.version >>
+          matrix:
+            parameters:
+              version: ["3.9","3.10","3.11"]
+            filters:
+              tags:
+                only: /.*/
           requires:
             - lint
-            - unit
+            - unit-<< matrix.version >>
       - functional-sftp:
-          filters:
-            tags:
-              only: /.*/
+          name: functional-sftp-<< matrix.version >>
+          matrix:
+            parameters:
+              version: ["3.9","3.10","3.11"]
+            filters:
+              tags:
+                only: /.*/
           requires:
             - lint
-            - unit
+            - unit-<< matrix.version >>
       - release:
           requires:
             - functional-ftp

diff --git a/Pipfile b/Pipfile
@@ -3,14 +3,11 @@ url = "https://pypi.org/simple"
 verify_ssl = true
 name = "pypi"
 
-[requires]
-python_version = "3.9"
-
 [dev-packages]
 # Symlink to project root
 tentaclio = {editable = true,path = "."}
 # Linting
-black = "*"
+black = "==23.9.1"
 isort = "*"
 flake8 = "*"
 mypy = "*"
@@ -19,10 +16,10 @@ types-paramiko = "*"
 types-pyyaml = "*"
 types-requests = "*"
 # Testing
-moto = "*"
 pytest = "*"
 pytest-cov = "*"
 pytest-mock = "*"
 # Releasing
 twine = "*"
 secretstorage = "*"
+moto = "*"