Jenkinsfile

@Library('xmos_jenkins_shared_library@v0.43.1') _

def runningOn(machine) {
  println "Stage running on:"
  println machine
}

getApproval()
pipeline {
  agent none
  environment {
    REPO = 'lib_camera'
    REPO_NAME = "lib_camera"
  } // environment
  parameters {
    string(
      name: 'TOOLS_VERSION',
      defaultValue: '15.3.1',
      description: 'The XTC tools version'
    )
    string(
      name: 'XMOSDOC_VERSION',
      defaultValue: 'v7.3.0',
      description: 'The xmosdoc version'
    )
    string(
      name: 'INFR_APPS_VERSION',
      defaultValue: 'v3.1.1',
      description: 'The infr_apps version'
    )
  } // parameters
  options {
    skipDefaultCheckout()
    timestamps()
    buildDiscarder(xmosDiscardBuildSettings(onlyArtifacts=false))
  } // options

  stages{
  stage('CI') {
    parallel {
      stage ('Build & Test') {
        agent {label 'xcore.ai'}
        post {cleanup {xcoreCleanSandbox()}}
        stages {
          stage('Checkout') {
            steps {
              runningOn(env.NODE_NAME)
              dir(REPO)
              {
                checkoutScmShallow()
                createVenv(reqFile: "requirements.txt")
              }
            } // steps
          } // Checkout

          stage('Examples build') {
            steps{
              dir("${REPO}/examples") {
                withVenv {
                  xcoreBuild()
                }
              }
            }
          } // Examples build

          stage('Tests build') {
            steps{
              dir("${REPO}/tests") {
                withVenv {
                  xcoreBuild()
                }
              }
            }
          } // Tests build

          stage("Repo checks"){ // Needs to be placed after build stage for dependancies to be built
            steps {
              dir("${REPO}") {
                withVenv {
                  runRepoChecks("${WORKSPACE}/${REPO}")
                }
              }
            }
          } // Lib checks


          stage('Unit tests') {
            steps {
              dir("${REPO}/tests/unit_tests") {
                withTools(params.TOOLS_VERSION) {
                  sh 'xsim bin/unit_tests.xe'
                }
              }
            }
          } // Unit tests

          stage('ISP tests') {
            steps {
              dir('lib_camera/tests/isp') {
                withVenv {
                  withTools(params.TOOLS_VERSION) {
                    sh 'pytest -n auto'
                  } // withTools
                  archiveArtifacts artifacts: "test_results.csv"
                  archiveArtifacts artifacts: "imgs/images.zip"
                }
              }
            }
          } // ISP tests 
        
          stage("Archive sandbox"){
            steps {
              archiveSandbox(REPO_NAME)
            }
          } // Archive sandbox
        } // stages
        
      } // Build & Test
      
      stage('Documentation') {
        agent {label 'documentation'}
        post {cleanup {xcoreCleanSandbox()}}
        steps{
          runningOn(env.NODE_NAME)
          dir("${REPO}") {
            checkoutScmShallow()
            createVenv(reqFile: "requirements.txt")
            withVenv {
              buildDocs()
            }
          } 
        }
      } // Documentation


    } // parallel
  } // CI

  stage('🚀 Release') {
    when {
      expression {triggerRelease.isReleasable() }
    }
    steps {
      triggerRelease()
    }
  } // Release

  } // stages
  
} // pipeline