JS CI Pipeline Sequence Diagrams

flowchart LR subgraph Stages S1[Prepare WORKSPACE] S2[Install Dependencies] S3[Linting] S4[Unit Testing] S5[Static Analysis] end S1 --> S2 --> S3 --> S4 --> S5 S5 --> Post[Post
always/success/failure/aborted]

sequenceDiagram autonumber participant JF as Jenkinsfile
(Orchestrator) participant GH as generalHelper participant JSH as jsHelper participant Git as Git CLI participant Python as Python Scripts participant BB as Bitbucket API Note over JF: Stage: Prepare WORKSPACE JF->>JF: sh 'env' (print environment variables) JF->>GH: load("generalHelper.groovy") JF->>JSH: load("jsHelper.groovy") JF->>GH: parseJson() Note over GH: Domain: Parsing GH-->>JF: buildResults, stageResults JF->>GH: isBranchUpToDateWithRemote(PR_BRANCH) Note over GH: Domain: Git GH->>Git: git fetch origin GH->>Git: git rev-parse HEAD GH->>Git: git rev-parse origin/{branch} Git-->>GH: commit hashes GH-->>JF: true/false JF->>GH: getFullCommitHash(workspace, PR_COMMIT) Note over GH: Domain: Bitbucket GH->>Python: get_bitbucket_commit_hash.py Python->>BB: GET /commits BB-->>Python: commit hash Python-->>GH: full commit hash GH-->>JF: COMMIT_HASH JF->>GH: initializeEnvironment(workspace, commitHash, prBranch) Note over GH: Mixed: Bitbucket + Parsing GH->>GH: sendBuildStatus('INPROGRESS') GH->>Python: send_bitbucket_build_status.py Python->>BB: POST /statuses/build GH->>GH: parseTicketNumber(prBranch) GH-->>JF: TICKET_NUMBER, FOLDER_NAME JF->>GH: cloneOrUpdateRepo(workspace, projectDir, prBranch) Note over GH: Domain: Git GH->>Git: git clone / git fetch GH->>Git: git checkout GH->>Git: git reset --hard GH->>Git: git clean -fd Git-->>GH: OK GH-->>JF: OK JF->>GH: mergeBranchIfNeeded(prBranch) Note over GH: Domain: Git GH->>GH: getDefaultBranch() GH->>Git: git remote show origin Git-->>GH: default branch GH->>GH: isBranchUpToDateWithMain() GH->>Git: git merge-base --is-ancestor GH->>GH: tryMerge(defaultBranch) GH->>Git: git merge origin/{default} Git-->>GH: OK GH-->>JF: OK JF->>JSH: findTestingDirs(PROJECT_DIR) Note over JSH: Domain: File System JSH-->>JF: TEST_DIRECTORIES

sequenceDiagram autonumber participant JF as Jenkinsfile
(Orchestrator) participant JSH as jsHelper participant NPM as npm CLI Note over JF: Stage: Install Dependencies JF->>JSH: checkNodeVersion() Note over JSH: Domain: Node.js/npm JSH->>NPM: node -v NPM-->>JSH: version JSH->>NPM: npm -v NPM-->>JSH: version JF->>JSH: installNpmInTestingDirs(TEST_DIRECTORIES) Note over JSH: Domain: Node.js/npm loop for each testDir JSH->>NPM: npm audit JSH->>NPM: npm install NPM-->>JSH: OK end JSH-->>JF: OK

sequenceDiagram autonumber participant JF as Jenkinsfile
(Orchestrator) participant FS as File System participant JSH as jsHelper participant NPM as npm CLI Note over JF: Stage: Linting JF->>FS: mkdir -p linting_results JF->>JSH: executeLintingInTestingDirs(TEST_DIRECTORIES, false) Note over JSH: Domain: Node.js/npm loop for each testDir JSH->>NPM: npm run lint NPM-->>JSH: exitCode end JSH-->>JF: OK/FAIL

sequenceDiagram autonumber participant JF as Jenkinsfile
(Orchestrator) participant GH as generalHelper participant JSH as jsHelper participant NPM as npm CLI participant Python as Python Scripts participant BB as Bitbucket API participant WS as Web Server
(SSH/SCP) Note over JF: Stage: Unit Testing JF->>JSH: runUnitTestsInTestingDirs(TEST_DIRECTORIES, false) Note over JSH: Domain: Node.js/npm loop for each testDir JSH->>NPM: npm test NPM-->>JSH: coverage-summary.json, test-results.json end JSH-->>JF: OK/FAIL Note over JF,WS: Publish coverage HTML to Web Server JF->>GH: publishTestResultsHtmlToWebServer(FOLDER_NAME, TICKET_NUMBER, lcov-report, 'server') Note over GH: Domain: Web Server GH->>WS: ssh mkdir -p /var/www/html/{folder}/{ticket}/server GH->>WS: scp -r lcov-report/* WS-->>GH: OK JF->>GH: publishTestResultsHtmlToWebServer(FOLDER_NAME, TICKET_NUMBER, lcov-report, 'client') GH->>WS: ssh mkdir -p /var/www/html/{folder}/{ticket}/client GH->>WS: scp -r lcov-report/* WS-->>GH: OK Note over JF,BB: Send coverage reports to Bitbucket alt params.SERVER_SOURCE_FOLDER exists JF->>JSH: retrieveReportSummaryDirs(serverDir) Note over JSH: Domain: File System JSH-->>JF: coverageSummaryDir, testSummaryDir JF->>Python: create_bitbucket_coverage_report.py --server Note over JF: Jenkinsfile Direct: Bitbucket (Python) Python->>BB: POST /reports BB-->>Python: OK end alt params.CLIENT_SOURCE_FOLDER exists JF->>JSH: retrieveReportSummaryDirs(clientDir) JSH-->>JF: coverageSummaryDir, testSummaryDir JF->>Python: create_bitbucket_coverage_report.py --client Python->>BB: POST /reports BB-->>Python: OK end

sequenceDiagram autonumber participant JF as Jenkinsfile
(Orchestrator) participant GH as generalHelper participant SQ as SonarQube Note over JF: Stage: Static Analysis JF->>SQ: sonar-scanner -Dsonar.projectKey={key} -Dsonar.sources=. Note over JF: Jenkinsfile Direct: SonarQube SQ-->>JF: analysis queued JF->>GH: checkQualityGateStatus(SONAR_PROJECT_KEY, token) Note over GH: Domain: SonarQube loop retry (max 5) GH->>SQ: GET /api/ce/component SQ-->>GH: queue status alt queue not empty GH->>GH: sleep(10) else queue empty GH->>SQ: GET /api/qualitygates/project_status SQ-->>GH: entireCodeStatus, newCodeStatus end end GH-->>JF: PASSED/FAILED alt status != OK Note over JF: catchError - stage FAILURE end

sequenceDiagram autonumber participant JF as Jenkinsfile
(Orchestrator) participant GH as generalHelper participant Git as Git CLI participant Python as Python Scripts participant BB as Bitbucket API Note over JF: Post: always/success/failure/aborted Note over JF,GH: always block JF->>JF: currentBuild.description = PR_BRANCH JF->>GH: checkoutBranch(PROJECT_DIR, DESTINATION_BRANCH) Note over GH: Domain: Git GH->>Git: git reset --hard GH->>Git: git clean -fd GH->>Git: git checkout {destination} GH->>Git: git reset --hard origin/{destination} Git-->>GH: OK GH-->>JF: OK Note over JF,GH: success/failure/aborted alt success JF->>GH: sendBuildStatus(workspace, 'SUCCESSFUL', commitHash, false) else failure JF->>GH: sendBuildStatus(workspace, 'FAILED', commitHash, false) else aborted JF->>GH: sendBuildStatus(workspace, 'STOPPED', commitHash, false) end Note over GH: Domain: Bitbucket GH->>Python: send_bitbucket_build_status.py Python->>BB: POST /statuses/build BB-->>Python: OK GH-->>JF: OK