Container Images, Jenkins, Linting (#3)

Using docker image as base to run tests and linting for consistency. Common Dockerfile used with python version argument

Signed-off-by: Andrew Twydell <[email protected]>

Author: AndrewTwydell

common.Dockerfile

@@ -2,10 +2,10 @@ ARG PYTHON_VERSION
 
 FROM python:${PYTHON_VERSION}
 
+USER root
+
 SHELL [ "/bin/bash", "-c" ]
 
-ENV PYTHON_VERSION_SET=${PYTHON_VERSION}
-RUN echo $PYTHON_VERSION_SET
 RUN apt-get update && apt upgrade -y
 
 COPY ./requirements.txt /ibm_zos_cics/ansible_collections/ibm/ibm_zos_cics/

dev-requirements.txt

@@ -17,7 +17,7 @@ rstcheck==3.3.1; python_version >= '3'
 yamllint==1.28.0; python_version >= '3'
 voluptuous==0.12.1; python_version >= '3'
 ansible-doc-extractor==0.1.6; python_version >= '3'
-ansible-lint==6.9.1; python_version >= '3'
+ansible-lint==6.10.2; python_version >= '3'
 pycodestyle==2.6.0; python_version >= '3'
 Sphinx==3.4.3; python_version >= '3'
 sphinx-rtd-theme==0.5.1; python_version >= '3'

docker-compose.yaml

@@ -1,4 +1,5 @@
-version: '3.9'
+---
+version: "3.9"
 
 services:
   python27:

galaxy.yml

@@ -1,3 +1,4 @@
+---
 # (c) Copyright IBM Corp. 2020,2021
 
 # IBM collection namespace
@@ -19,14 +20,14 @@ authors:
   - Sophie Green
   - Ya Qing Chen
 # Description
-description: The Red Hat Ansible Certified Content for IBM Z CICS collection includes connection plugins, action plugins, modules and sample playbooks to automate tasks for CICS
+description:
+  The Red Hat Ansible Certified Content for IBM Z CICS collection includes connection plugins, action plugins,
+  modules and sample playbooks to automate tasks for CICS
 
 # License
-license: "Apache-2.0"
-
+license: [Apache-2.0]
 # Tags
 tags: [ibm, z, zos, z_os, cics, cmci]
-
 # Collections that this collection requires to be installed for it to be usable.
 # dependencies: {} # This collection depends on no other collections
 

jenkinsfile

@@ -1,16 +1,30 @@
-node {
-  stage("Main") {
-    docker.image('python:3.8').inside("-e PYTHON_VERSION=3.8") {
-      stage("Run tests") {
-        sh "ansible-test units --python 3.8"
-      }
-   }
+pipeline {
+
+  agent {
+    dockerfile {
+        filename 'common.Dockerfile'
+        additionalBuildArgs  '--build-arg PYTHON_VERSION=3.8'
+    }
   }
-}
 
-//     agent {
-//         dockerfile {
-//             filename 'common.Dockerfile'
-//             additionalBuildArgs  '--build-arg PYTHON_VERSION=3.8'
-//         }
-//     }
+  stages {
+    stage('Unit Tests'){
+      steps {
+        sh 'cd  ${WORKSPACE}/ibm_zos_cics/ansible_collections/ibm/ibm_zos_cics && ansible-test units --python 3.8'
+      }
+    }
+
+    stage('disc') {
+      steps {
+        sh 'ls -al && ls -al ${WORKSPACE}/ibm_zos_cics/ansible_collections/ibm'
+      }
+    }
+
+    stage('Integration Tests'){
+      steps {
+        sh 'cd  ${WORKSPACE}/ibm_zos_cics/ansible_collections/ibm/ibm_zos_cics && ansible-test integration cics_cmci --python 3.8'
+      }
+    }
+
+  }
+}

meta/execution-environment.yml

@@ -1,3 +1,4 @@
+---
 dependencies:
   python: requirements.txt
-version: 1
+version: 1

meta/ibm_zos_cics_meta.yml

@@ -1,7 +1,8 @@
+---
 name: ibm_zos_cics
-version: "1.0.3"
+version: 1.0.3
 managed_requirements:
-  - name: "Python"
+  - name: Python
     version: ">=2.7"
-  - name: "CICS TS with CICSplex System Manager"
-    version: ">=4.1"
+  - name: CICS TS with CICSplex System Manager
+    version: ">=4.1"

meta/runtime.yml

@@ -1,3 +1,4 @@
+---
 requires_ansible: ">=2.10.7"
 action_groups:
   cmci:

plugins/module_utils/cmci.py

@@ -436,7 +436,7 @@ def handle_response(self, response_dict):  # type: (Dict) -> None
                 'Could not parse CMCI response: missing node "{0}"'
                 .format(e.args[0])
             )
-    
+
     def get_ok_cpsm_response_codes(self):
         return [1024]
 

plugins/modules/cmci_get.py

@@ -44,7 +44,7 @@
     description:
       - Specifies whether the module should fail if no data is returned by the
         query. If set to true, the module will fail if no data is returned.
-      - Default behaviour is for the module to fail if no data is returned. When 
+      - Default behaviour is for the module to fail if no data is returned. When
         set to false, the module will return OK, just with no records.
     type: bool
     required: false
@@ -534,7 +534,7 @@ def init_argument_spec(self):  # type: () -> Dict
         argument_spec.update({
             _RECORD_COUNT: {
                 'type': 'int'
-            }, 
+            },
             _FAIL_ON_NODATA: {
                 'type': 'bool',
                 'default': True
@@ -553,7 +553,7 @@ def init_url(self):  # type: () -> str
             url = url + '//' + str(self._p.get(_RECORD_COUNT))
 
         return url
-    
+
     def get_ok_cpsm_response_codes(self):
         ok_codes = super(AnsibleCMCIGetModule, self).get_ok_cpsm_response_codes()