azure-pipelines.yml

# Copyright IBM Corp. All Rights Reserved.
#
# SPDX-License-Identifier: Apache-2.0
#
# fabric-chaincode-node azure pipeline configuration.
#
name: $(SourceBranchName)-$(Date:yyyyMMdd)$(Rev:.rrr)

# Daily build for final quality
# cf https://crontab.guru/#0_23_*_*_*
schedules:
  - cron: "0 10,12,14,16,23 * * *"
    displayName: 'Chaincode Node Nightly Driver'
    branches:
      include:
        - 'release-2.5'

# Trigger on the main branch
# Standard Pull Request and Merge builds
# Any git tag will also trigger a build that should do publishing
trigger:
  branches:
    include:
      - 'release-2.5'
  tags:
    include:
      - '*'


# These are custom defined variables, the pipeline one is currently used for the build scripts
# to know to produce tests results in XML format for Azure to consume, for developers
# this isn't set so command line output is given
#
# Chaincode_Node_Vars is the protected group of keys for publishing
variables:
  - group: Chaincode_Node_Vars
  - name: component
    value: fabric-chaincode-node
  - name: pipeline
    value: ci
  - name: node_version_spec
    value: '16.4.0'
  - name: rewire_node_version_spec # see https://github.com/jhnns/rewire/issues/178
    value: '16.4.0'
  - name: FABRIC_VERSION
    value: 2.5

# Build on Ubuntu
pool:
  vmImage: 'ubuntu-latest'

#
# Publish to NPM on release builds (they are the github tagged releases)
# Publish to NPM on nightly builds when there is something to build
# the ids will be of the format 2.5.0.{commitid}
#
stages:

    # Primary stage of building, linting and unit tests
    - stage: Build_and_Test
      jobs:
        # output some basic information for reference
        - job: displayenv
          steps:
            - template: templates/build-data.yaml
        - job: main
          dependsOn: displayenv
          displayName: 'Build, lint, UT'
          variables:
            VERSION: $[ dependencies.displayenv.outputs['BuildData.PACKAGE_VERSION'] ]
            BUILD_DATE: $[ dependencies.displayenv.outputs['BuildData.BUILD_DATE'] ]
          steps:
            - task: NodeTool@0
              inputs:
                versionSpec: $(rewire_node_version_spec)
            - template: templates/nightly-version-update.yaml
            - script: |
                set -ev
                node common/scripts/install-run-rush.js install
              displayName: 'Setup the rush environment'
            - script: |
                set -ev
                node common/scripts/install-run-rush.js rebuild
              displayName: 'Full rebuild'
            - script: |
                npx cobertura-merge -o merged_coverage.xml shim=./libraries/fabric-shim/coverage/cobertura-coverage.xml contractapi=./apis/fabric-contract-api/coverage/cobertura-coverage.xml -p
              condition: or(succeeded(), failed())
            - task: PublishTestResults@2
              condition: or(succeeded(), failed())   # publish either way
              inputs:
                testResultsFiles: '**/test-results.xml'
                artifactName: 'Unit Test results'
                testRunTitle: 'Unit Test results'
            - task: PublishCodeCoverageResults@1
              condition: or(succeeded(), failed())   # publish either way
              inputs:
                codeCoverageTool: 'cobertura'
                summaryFileLocation: 'merged_coverage.xml'
                artifactName: 'Unit Test Coverage'
            - script: |
                mkdir -p $(Build.ArtifactStagingDirectory)/logs
                find . \( -type d -name 'node_modules' \) -prune -o -name '*.build*.log' -exec cp {} $(Build.ArtifactStagingDirectory)/logs \;
              displayName: 'Copy build logs'
              condition: or(succeeded(), failed())   # publish either way
            - task: PublishBuildArtifacts@1
              condition: or(succeeded(), failed())   # publish either way
              inputs:
                pathToPublish:  $(Build.ArtifactStagingDirectory)/logs
                artifactName: 'Build logs'
              displayName: 'Publish build logs'

            # Copy the built artifacts to the staging directory, tgz, and the docker image
            - script: |
                set -ev
                node common/scripts/install-run-rush.js publish --include-all --pack --release-folder $(Build.ArtifactStagingDirectory)/tgz --publish
                docker image save hyperledger/fabric-nodeenv | gzip > $(Build.ArtifactStagingDirectory)/fabric-nodeenv.tar.gz
            - task: PublishBuildArtifacts@1
              inputs:
                pathToPublish:  $(Build.ArtifactStagingDirectory)/tgz
                artifactName: node-tgz
            - task: PublishBuildArtifacts@1
              inputs:
                pathToPublish:  $(Build.ArtifactStagingDirectory)/fabric-nodeenv.tar.gz
                artifactName: nodeenv-docker-image

        # Run the FV tests but using the built material
        - job: fvt
          displayName: 'FV Tests'
          dependsOn: [main,displayenv]
          variables:
            VERSION: $[ dependencies.displayenv.outputs['BuildData.PACKAGE_VERSION'] ]
            BUILD_DATE: $[ dependencies.displayenv.outputs['BuildData.BUILD_DATE'] ]
          steps:
            - task: NodeTool@0
              inputs:
                versionSpec: $(node_version_spec)
            - template: templates/nightly-version-update.yaml
            - task: DownloadPipelineArtifact@2
              inputs:
                artifact: nodeenv-docker-image
                path: $(Build.SourcesDirectory)/build
            - task: DownloadPipelineArtifact@2
              inputs:
                artifact: node-tgz
                path: $(Build.SourcesDirectory)/build
            - script: |
                set -ev
                ./tools/getEdgeDocker.sh                                # essential to get main docker images of peer etc.
                docker image load --input build/fabric-nodeenv.tar.gz         # gets the build image of nodeenv
                docker tag hyperledger/fabric-nodeenv:latest hyperledger/fabric-nodeenv:$(FABRIC_VERSION)
                docker images
                node common/scripts/install-run-rush.js install
                node common/scripts/install-run-rush.js update          # should the tests need 'building' this will need to go here
              displayName: 'Get the latest main docker images'
            - script: |
                set -ev
                export TLS=true
                node common/scripts/install-run-rush.js start-fabric
                node common/scripts/install-run-rush.js start-verdaccio # script will check for the ci variable and use built images
                docker images | grep hyperledger && docker ps -a
                node common/scripts/install-run-rush.js test:fv --verbose
                node common/scripts/install-run-rush.js test:e2e --verbose
              displayName: 'FV Tests'

            - task: PublishTestResults@2
              condition: or(succeeded(), failed())   # publish either way
              inputs:
                testResultsFiles: '**/test-results.xml'
                testRunTitle: 'FV Test results'
            - task: CopyFiles@2
              condition: or(succeeded(), failed())   # publish either way
              inputs:
                sourceFolder: $(Build.SourcesDirectory)/test
                contents: |
                  **/*.build*.log
                  !**/node_modules/**
                targetFolder: $(Build.ArtifactStagingDirectory)/testlogs
            - script: |
                mkdir -p $(Build.ArtifactStagingDirectory)/testlogs
                find . \( -type d -name 'node_modules' \) -prune -o -name '*.build*.log' -exec cp {} $(Build.ArtifactStagingDirectory)/testlogs \;
              condition: or(succeeded(), failed())
              displayName: 'Copy test logs'
            - task: PublishBuildArtifacts@1
              condition: or(succeeded(), failed())   # publish either way
              inputs:
                pathToPublish:  $(Build.ArtifactStagingDirectory)/testlogs
                artifactName: 'Test logs'
              displayName: 'Publish test logs'


        # Job to handle the auditing of the code
        # NPM audit is run on a 'fake' installation of the libraries
        # Pulling in all the dependencies it will be able to run NPM AUDIT, and if that returns a
        # error code the job will fail.
        - job: src_audit
          displayName: 'Node Module Auditing'
          dependsOn: [main,displayenv]
          variables:
            VERSION: $[ dependencies.displayenv.outputs['BuildData.PACKAGE_VERSION'] ]
            BUILD_DATE: $[ dependencies.displayenv.outputs['BuildData.BUILD_DATE'] ]
          steps:
            - task: NodeTool@0
              inputs:
                versionSpec: $(node_version_spec)
            - task: DownloadPipelineArtifact@2
              inputs:
                artifact: node-tgz
                path: $(Build.SourcesDirectory)/build
            - template: templates/nightly-version-update.yaml
            - script: |
                node common/scripts/install-run-rush.js install
                node common/scripts/install-run-rush.js start-verdaccio # script will check for the ci variable and use built images
                mkdir -p $(Build.SourcesDirectory)/audit && cd $(Build.SourcesDirectory)/audit && npm init -y
                npm install --registry http://localhost:4873 fabric-shim fabric-shim-api fabric-contract-api --save
                npm audit --audit-level=moderate
              displayName: 'Run npm audit'

        # Build and publish API docs on every merge build
        - job: jsdoc
          dependsOn: displayenv
          condition: and(succeeded(),eq(variables['Build.Reason'], 'IndividualCI'))
          variables:
            ${{ if eq(variables['Build.SourceBranch'], 'refs/heads/main') }}:
              jsdoc_release: main
            ${{ if ne(variables['Build.SourceBranch'], 'refs/heads/main') }}:
              jsdoc_release: $[format('release-{0}',dependencies.displayenv.outputs['BuildData.MINOR_PACKAGE_VERSION'])]
          steps:
            - task: NodeTool@0
              inputs:
                versionSpec: $(node_version_spec)
            - script: |
                set -ev
                node common/scripts/install-run-rush.js install
              displayName: 'Setup the rush environment'
            - script: |
                set -ev
                node common/scripts/install-run-rush.js rebuild --to fabric-shim-docs
              displayName: 'Build JSDoc'
            - task: CopyFiles@2
              inputs:
                contents: |
                  gen/**
                sourceFolder: '$(Build.SourcesDirectory)/docs'
                targetFolder: $(Build.ArtifactStagingDirectory)/jsdoc
                cleanTargetFolder: true
              displayName: 'Copy JSDoc'
            - task: CopyFiles@2
              condition: eq(variables['Build.SourceBranch'], 'refs/heads/main')
              inputs:
                contents: |
                  _config.yml
                  **/?(*.md|*.html)
                  !_jsdoc.json
                  !_jsdoc/**
                  !gen/**
                  !node_modules/**
                sourceFolder: '$(Build.SourcesDirectory)/docs'
                targetFolder: $(Build.ArtifactStagingDirectory)/gh-pages
                cleanTargetFolder: true
              displayName: 'Copy gh-pages doc (main branch only)'
            - script: |
                git reset --hard HEAD
                git clean -xdf
                git fetch origin
                git checkout -b gh-pages origin/gh-pages
                git clean -xdf

                mkdir -p $(jsdoc_release)/api
                rm -rf $(jsdoc_release)/api/*
                cp -r $(Build.ArtifactStagingDirectory)/jsdoc/gen/* $(jsdoc_release)/api
                if [ -d $(Build.ArtifactStagingDirectory)/gh-pages ]; then
                  find . -maxdepth 1 ! \( -name [.]* -o -name 'gh-pages' -o -name 'main' -o -name 'release-*' \) -exec rm -rf {} \;
                  cp -r $(Build.ArtifactStagingDirectory)/gh-pages/* .
                fi
              displayName: 'Update gh-pages branch'
            - script: |
                git config --global user.email "hlfdev.azp@gmail.com"
                git config --global user.name "Hyperledger Bot"
                git add -A
                git commit -m "Publishing GitHub Pages"
                git push https://$(GITHUB-PAT)@github.com/hyperledger/fabric-chaincode-node.git gh-pages
              displayName: 'Commit gh-pages changes'
              continueOnError: true # Need to fix jsdoc publishing after release

    # Publish a new version, triggered by a git tag
    - stage: Publish_tag
      dependsOn: Build_and_Test
      condition: and(succeeded('Build_and_Test'), startsWith(variables['Build.SourceBranch'], 'refs/tags'))
      jobs:
        - job: npm_publish
          displayName: 'npm publish'
          steps:
            - task: NodeTool@0
              inputs:
                versionSpec: $(node_version_spec)
            - download: current
              artifact: node-tgz
            - script: |
                touch $(Agent.TempDirectory)/.npmrc
                echo '##vso[task.setvariable variable=NPM_CONFIG_USERCONFIG]$(Agent.TempDirectory)/.npmrc'
              displayName: 'create user .npmrc file'
            - script: |
                npm config set registry https://registry.npmjs.org/
                npm config ls
              displayName: 'set npmjs registry'
            - task: npmAuthenticate@0
              inputs:
                workingFile: '$(Agent.TempDirectory)/.npmrc'
                customEndpoint: 'fabric-chainode-node-npm'
            - script: |
                find $(Pipeline.Workspace)/node-tgz/ -maxdepth 1 -type f -name 'fabric-*.tgz' -exec npm publish {} --tag beta \;
              displayName: 'npm publish'
        - job: dockerhub_publish
          steps:
            - template: templates/build-data.yaml
            - task: DownloadPipelineArtifact@2
              inputs:
                artifact: nodeenv-docker-image
                path: $(Build.SourcesDirectory)/build

            - script: |
                wget -qO "$PWD/manifest-tool" https://github.com/estesp/manifest-tool/releases/download/v1.0.0/manifest-tool-linux-amd64
                chmod +x ./manifest-tool

                docker image load --input build/fabric-nodeenv.tar.gz
                docker images
                docker login ${DOCKER_REGISTRY_URL} --username=${DOCKER_REGISTRY_USERNAME} --password=${DOCKER_REGISTRY_PASSWORD}
                echo "Logged in to docker registry"
                # tag nodeenv image to PACKAGE_VERSION
                docker tag hyperledger/fabric-nodeenv hyperledger/fabric-nodeenv:amd64-$(BuildData.PACKAGE_VERSION)
                # push nodeenv to repository
                docker push hyperledger/fabric-nodeenv:amd64-$(BuildData.PACKAGE_VERSION)
                # publish patch version (3-digit) image
                ./manifest-tool push from-args --platforms linux/amd64 --template "hyperledger/fabric-nodeenv:amd64-$(BuildData.PACKAGE_VERSION)" --target "hyperledger/fabric-nodeenv:$(BuildData.PACKAGE_VERSION)"
                # publish minor version (2-digit) image
                ./manifest-tool push from-args --platforms linux/amd64 --template "hyperledger/fabric-nodeenv:amd64-$(BuildData.PACKAGE_VERSION)" --target "hyperledger/fabric-nodeenv:$(BuildData.MINOR_PACKAGE_VERSION)"
              env:
                DOCKER_REGISTRY_USERNAME: $(DockerHub-Username)
                DOCKER_REGISTRY_PASSWORD: $(DockerHub-Password)

    # Stage to publish the nightly drivers
    - stage: Publish_tag_nightly
      dependsOn: Build_and_Test
      condition: and(succeeded('Build_and_Test'), eq(variables['Build.Reason'], 'Schedule'))  # only run on the scheduled builds
      jobs:
        - job: npm_publish
          displayName: 'npm publish'
          steps:
            - task: NodeTool@0
              inputs:
                versionSpec: $(node_version_spec)
            - download: current
              artifact: node-tgz
            - script: |
                touch $(Agent.TempDirectory)/.npmrc
                echo '##vso[task.setvariable variable=NPM_CONFIG_USERCONFIG]$(Agent.TempDirectory)/.npmrc'
              displayName: 'create user .npmrc file'
            - script: |
                npm config set registry https://registry.npmjs.org/
                npm config ls
              displayName: 'set npmjs registry'
            - task: npmAuthenticate@0
              inputs:
                workingFile: '$(Agent.TempDirectory)/.npmrc'
                customEndpoint: 'fabric-chainode-node-npm'
            - script: |
                find $(Pipeline.Workspace)/node-tgz/ -maxdepth 1 -type f -name 'fabric-*.tgz' -exec npm publish {} --tag beta \;
              displayName: 'npm publish'