INSTALL-944: Apply latest enhancements to the CI pipeline (#686)

Update the CI pipeline with the latest enhancements of the shared library

Author: lulivi

Jenkinsfile

@@ -11,32 +11,13 @@
  */
 
 /**
- * Build the examples in the specified build and link modes.
- *
- * @param buildMode The build mode name.
- * @param linkMode The link mode name.
+ * Hold information about the pipeline.
  */
-void runBuildStage(String buildMode, String linkMode) {
-    String cmd = "python3 ${env.WORKSPACE}/resources/ci_cd/linux_build.py"
-    cmd += " --build-mode ${buildMode}"
-    cmd += " --link-mode ${linkMode}"
-    cmd += " --build-dir ${getBuildDirectory(buildMode, linkMode)}"
-    command.run(cmd)
-}
-
-/**
- * Craft the build directory name.
- *
- * @param buildMode The build mode name.
- * @param linkMode The link mode name.
- */
-String getBuildDirectory(String buildMode, String linkMode) {
-    return "build_${buildMode}_${linkMode}"
-}
+Map pipelineInfo = [:]
 
 pipeline {
     agent {
-        label "${nodeManager.labelFromJobName()}"
+        label "${runInsideExecutor.labelFromJobName()}"
     }
 
     options {
@@ -61,29 +42,32 @@ pipeline {
         timeout(time: 2, unit: 'HOURS')
     }
 
-    environment {
-        RTI_INSTALLATION_PATH = "${env.WORKSPACE}"
-        VIRTUAL_ENV = "${env.WORKSPACE}/.venv"
-    }
-
     stages {
-        stage('Download Packages') {
+        stage('Configuration') {
             steps {
                 script {
-                    nodeManager.runInsideExecutor() {
-                        command.run(
-                            'pip3 install -r resources/ci_cd/requirements.txt'
+                    pipelineInfo.dockerDir = "${env.WORKSPACE}/resources/docker/"
+                    pipelineInfo.staticAnalysisDir = "${env.WORKSPACE}/static_analysis_report"
+                    runInsideExecutor(
+                        '',
+                        pipelineInfo.dockerDir,
+                    ) {
+                        pipelineInfo.connextArch = getEnvVar('CONNEXTDDS_ARCH')
+                    }
+                }
+            }
+        }
+        stage('Download Packages') {
+            steps {
+                runInsideExecutor(
+                    '',
+                    pipelineInfo.dockerDir,
+                ) {
+                    script {
+                        pipelineInfo.connextDir = installConnext(
+                            pipelineInfo.connextArch,
+                            env.WORKSPACE,
                         )
-                        withAWSCredentials {
-                            withCredentials([
-                                string(credentialsId: 's3-bucket', variable: 'RTI_AWS_BUCKET'),
-                                string(credentialsId: 's3-path', variable: 'RTI_AWS_PATH'),
-                            ]) {
-                                command.run(
-                                    'python3 resources/ci_cd/linux_install.py -a $CONNEXTDDS_ARCH'
-                                )
-                            }
-                        }
                     }
                 }
             }
@@ -103,11 +87,18 @@ pipeline {
                 stages {
                     stage('Build single mode') {
                         steps {
-                            script{
-                                nodeManager.runInsideExecutor() {
-                                    echo("Build ${buildMode}/${linkMode}")
-                                    runBuildStage(buildMode, linkMode)
-                                }
+                            runInsideExecutor(
+                                '',
+                                pipelineInfo.dockerDir,
+                            ) {
+                                echo("Building ${buildMode}/${linkMode}")
+                                buildExamples(
+                                    pipelineInfo.connextArch,
+                                    pipelineInfo.connextDir,
+                                    buildMode,
+                                    linkMode,
+                                    env.WORKSPACE,
+                                )
                             }
                         }
                     }
@@ -116,14 +107,24 @@ pipeline {
         }
         stage('Static Analysis') {
             steps {
-                script {
-                    nodeManager.runInsideExecutor() {
-                        command.run("""
-                            python3 resources/ci_cd/linux_static_analysis.py \
-                            --build-dir ${getBuildDirectory('release', 'dynamic')}
-                        """)
-                    }
+                runInsideExecutor(
+                    '',
+                    pipelineInfo.dockerDir,
+                ) {
+                    runStaticAnalysis(
+                        buildExamples.getBuildDirectory('release', 'dynamic'),
+                        pipelineInfo.connextDir,
+                        pipelineInfo.staticAnalysisDir,
+                    )
                 }
+                publishHTML(target: [
+                    allowMissing: true,
+                    alwaysLinkToLastBuild: true,
+                    keepAll: true,
+                    reportDir: pipelineInfo.staticAnalysisDir,
+                    reportFiles: 'index.html',
+                    reportName: 'LLVM Scan build static analysis',
+                ])
             }
         }
     }

examples/connext_dds/network_capture/03_security/c/CMakeLists.txt

@@ -24,7 +24,7 @@ find_package(RTIConnextDDS
         security_plugins
 )
 
-if(NOT RTIConnextDDS::security_plugins)
+if(NOT TARGET RTIConnextDDS::security_plugins)
     message(WARNING "RTIConnextDDS::security_plugins component is missing. Skipping example")
     return()
 endif()

examples/connext_dds/network_capture/04_advanced_api/c/CMakeLists.txt

@@ -24,7 +24,7 @@ find_package(RTIConnextDDS
         security_plugins
 )
 
-if(NOT RTIConnextDDS::security_plugins)
+if(NOT TARGET RTIConnextDDS::security_plugins)
     message(WARNING "RTIConnextDDS::security_plugins component is missing. Skipping example")
     return()
 endif()

resources/ci_cd/README.md

@@ -1,32 +1,18 @@
 # Use full automation scripts
 
-The scripts contained in this directory are primarily intended for CI/CD
-services, as Jenkins or GitHub Actions. As a summary, we currently have the
-following files:
+The scripts contained in this directory are primarily intended for GitHub
+Actions CI. As a summary, we currently have the following files:
 
 -   `linux_format.py`: allows to check the linting of various files within the
     repository: Python, Markdown and C/C++ source code files.
 
--   `linux_install.py`: performs an installation of a minimun RTI ConnextDDS
-    package to build and perform static analysis of the examples.
-
--   `linux_build.py`: build all the `C/C++` examples using `CMake`.
-
--   `linux_static_analysis.py`: run static analysis. This should be called
-    after building all the examples.
-
--   `jenkins_output.py`: generate a `Markdown` file from the template located
-    in `resources/markdown_templates/JenkinsTemplate.md` which contains the
-    details text for the GitHub check.
-
 -   `diff_clang_format.sh`: this is a helper script used in `linux_format.py`
     to run diffs between the source code and the `clang-format`'s changes to
     the same source code.
 
 For `linux_format.py` you will also need the [*Black*] Python package,
 [*clang-format*] tool and the [*markdownlint-cli*] utility.
 
-[*scan-build*]: https://pypi.org/project/scan-build/
 [*clang-format*]: https://pypi.org/project/clang-format/9.0.0/
 [*Black*]: https://pypi.org/project/black/
 [*markdownlint-cli*]: https://www.npmjs.com/package/markdownlint-cli/v/0.23.1