config.yml

version: 2.1

orbs:
  codacy: codacy/base@12.1.2

references:
  circleci_job: &circleci_job
    docker:
      - image: circleci/circleci-cli:0.1.29041
    working_directory: ~/workdir

commands:
  run_coverage_reporting:
    description: "Runs the coverage reporting using the mock-server as API"
    parameters:
      executor:
        type: string
      error_code:
        type: integer
        default: 0
    steps:
      - attach_workspace:
          at: ~/workdir
      - run:
          name: test coverage reporting
          command: |
            set +e
            export CODACY_PROJECT_TOKEN='TEST_CODACY_PROJECT_TOKEN'
            export TEST_CODACY_REPORT_PATH='integration-tests/test_dotcover.xml'
            export CODACY_REPORTER_TMP_FOLDER=".codacy-coverage"
            export CODACY_REPORTER_VERSION=$(cat .version)
            mkdir -p $CODACY_REPORTER_TMP_FOLDER/$CODACY_REPORTER_VERSION
            cp "$HOME/workdir/artifacts/codacy-coverage-reporter-linux" "$CODACY_REPORTER_TMP_FOLDER/$CODACY_REPORTER_VERSION/codacy-coverage-reporter"
            << parameters.executor >> get.sh report --commit-uuid 'e9bef8a69a439bd601c37c0557277572425203a7' -r $TEST_CODACY_REPORT_PATH --codacy-api-base-url http://localhost:1080
            export ERROR_CODE=$?
            if [ $ERROR_CODE -ne << parameters.error_code >> ]; then echo "expected an error code << parameters.error_code >> and got $ERROR_CODE instead"; exit 1; fi
            echo "test completed with the expected error code: << parameters.error_code >>"

jobs:
  publish_circleci_artifacts:
    machine: 
      image: ubuntu-2004:current
    working_directory: ~/workdir
    steps:
      - attach_workspace:
          at: ~/
      - store_artifacts:
          path: ~/workdir/artifacts/

  pack_and_validate_orb:
    <<: *circleci_job
    steps:
      - attach_workspace:
          at: ~/workdir
      - run:
          name: Pack orb
          command: |
            echo "" >> orbs/examples/codacy-coverage-report.yml
            echo "  orbs:" >> orbs/examples/codacy-coverage-report.yml
            echo "    coverage-reporter: codacy/coverage-reporter@$(cat .version)" >> orbs/examples/codacy-coverage-report.yml
            circleci config pack orbs > orb.yml
      - run:
          name: Validate orb
          command: circleci orb validate orb.yml
      - persist_to_workspace:
          root: ~/workdir
          paths:
            - "orb.yml"

  publish_dev:
    <<: *circleci_job
    steps:
      - attach_workspace:
          at: ~/workdir
      - run:
          name: Publish orb as dev (deleted after 90 days)
          command: circleci orb publish orb.yml codacy/coverage-reporter@dev:$(cat .version) --token $CIRCLE_TOKEN

  publish_prod:
    <<: *circleci_job
    steps:
      - attach_workspace:
          at: ~/workdir
      - run:
          name: Publish final orb
          command: circleci orb publish orb.yml codacy/coverage-reporter@$(cat .version) --token $CIRCLE_TOKEN

  package_artifacts:
    docker:
      - image: alpine:3.18
    working_directory: ~/workdir
    steps:
      - run: apk add upx
      - attach_workspace:
          at: ~/workdir
      - run: |
          mkdir -p ~/workdir/artifacts/
          mv ~/workdir/tmp-artifacts/codacy-coverage-reporter-assembly.jar ~/workdir/artifacts/codacy-coverage-reporter-assembly.jar
          upx --lzma -o ~/workdir/artifacts/codacy-coverage-reporter-linux ~/workdir/tmp-artifacts/codacy-coverage-reporter-linux
          mv ~/workdir/tmp-artifacts/codacy-coverage-reporter-linux-arm-assembly.jar ~/workdir/artifacts/codacy-coverage-reporter-linux-arm-assembly.jar
          upx --lzma -o ~/workdir/artifacts/codacy-coverage-reporter-linux-arm ~/workdir/tmp-artifacts/codacy-coverage-reporter-linux-arm
          # upx binaries don't work on Mac OS Big Sur https://github.com/upx/upx/issues/424
          # use upx again once the bug is fixed
          # upx --lzma -o ~/workdir/artifacts/codacy-coverage-reporter-darwin ~/workdir/tmp-artifacts/codacy-coverage-reporter-darwin
          cp ~/workdir/tmp-artifacts/codacy-coverage-reporter-darwin ~/workdir/artifacts/codacy-coverage-reporter-darwin
      - persist_to_workspace:
          root: ~/workdir
          paths:
            - artifacts/*

  it_coverage_script_alpine:
    docker:
      - image: alpine:3.18
      - image: mockserver/mockserver
    working_directory: ~/workdir
    steps:
      - run:
          name: install glibc
          command: |
            apk --no-cache add openssl wget
            wget -q -O /etc/apk/keys/sgerrand.rsa.pub https://alpine-pkgs.sgerrand.com/sgerrand.rsa.pub
            wget https://github.com/sgerrand/alpine-pkg-glibc/releases/download/2.35-r1/glibc-2.35-r1.apk
            apk add glibc-2.35-r1.apk
      - attach_workspace:
          at: ~/workdir
      - run:
          name: wait for mockserver
          command: wget --retry-connrefused --method=PUT http://localhost:1080/mockserver/status
      - run:
          name: configure mock server
          command: wget --method=PUT --body-data="$(cat integration-tests/mock-server-config.json)" http://localhost:1080/mockserver/expectation
      - run_coverage_reporting:
          executor: sh
          error_code: 0

  it_coverage_script_ubuntu:
    docker:
      - image: cimg/base:2023.10 # ubuntu based image
      - image: mockserver/mockserver
    working_directory: ~/workdir
    parameters:
      error_code:
        type: integer
      config_path:
        type: string
    steps:
      - attach_workspace:
          at: ~/workdir
      - run:
          name: wait for mockserver
          command: timeout 60 bash -c 'while [[ "$(curl -X PUT -o /dev/null -w ''%{http_code}'' localhost:1080/mockserver/status)" != "200" ]]; do sleep 2; done' || false
      - run:
          name: configure mock server
          command: curl -v -X PUT localhost:1080/mockserver/expectation -d "$(cat << parameters.config_path >>)"
      - run_coverage_reporting:
          executor: bash
          error_code: << parameters.error_code >>

  it_coverage_script_macosx:
    executor: codacy/osx
    working_directory: ~/workdir
    steps:
      - attach_workspace:
          at: ~/workdir
      - run:
          name: prepare the environment
          command: |
            brew install mockserver coreutils
            sudo rm -rf /Library/Developer/CommandLineTools
            sudo xcode-select --install
            export CODACY_REPORTER_TMP_FOLDER=".codacy-coverage"
            version=$(cat .version)
            mkdir -p $CODACY_REPORTER_TMP_FOLDER/$version
            cp $HOME/workdir/artifacts/codacy-coverage-reporter-darwin $CODACY_REPORTER_TMP_FOLDER/$version/codacy-coverage-reporter
      - run:
          name: test on osx
          command: |
            echo "Start and provision the mockserver"
            nohup mockserver -logLevel INFO -serverPort 1080 &
            gtimeout 60 bash -c 'while [[ "$(curl -X PUT -o /dev/null -w ''%{http_code}'' localhost:1080/mockserver/status)" != "200" ]]; do sleep 2; done' || false
            curl -X PUT -d "$(cat integration-tests/mock-server-config.json)" http://localhost:1080/mockserver/expectation

            echo "Run the test"
            set +e

            export CODACY_REPORTER_VERSION=$(cat .version)
            export CODACY_PROJECT_TOKEN='TEST_CODACY_PROJECT_TOKEN'
            export TEST_CODACY_REPORT_PATH='integration-tests/test_dotcover.xml'
            export CODACY_REPORTER_TMP_FOLDER=".codacy-coverage"
            sh get.sh report --commit-uuid 'e9bef8a69a439bd601c37c0557277572425203a7' -r $TEST_CODACY_REPORT_PATH --codacy-api-base-url http://localhost:1080
            export ERROR_CODE=$?
            if [ $ERROR_CODE -ne 0 ]; then echo "expected an error code 0 and got $ERROR_CODE instead"; exit 1; fi
            echo "test completed with the expected error code: 0"



  it_coverage_script_ubuntu_linux_arm:
    resource_class: arm.medium
    docker:
      - image: cimg/base:2023.10 # ubuntu based image
      - image: mockserver/mockserver:5.15.0
    working_directory: ~/workdir
    steps:
      - attach_workspace:
          at: ~/workdir
  create_artifacts_linux_arm:
    description: Default sbt job
    environment:
      AWS_DEFAULT_REGION: << parameters.region >>
      AWS_PROFILE: << parameters.aws_profile >>
    machine:
      image: ubuntu-2204:current
    resource_class: arm.medium
    parameters:
      aws_profile:
        default: default
        description: The AWS profile to be used
        type: string
      cache_prefix:
        default: sbt-cache-032020
        description: The prefix of cache to be used
        type: string
      cmd:
        default: ''
        description: SBT command to run
        type: string
      credentials_file_content:
        default: >
          [default]

          aws_access_key_id=$ACCESS_KEY_ID

          aws_secret_access_key=$SECRET_ACCESS_KEY

          [maven]

          source_profile = default

          role_arn =
          arn:aws:iam::$AWS_ACCOUNT_ID_PRODUCTION:role/$MAVEN_PUBLISHER_ROLE
        description: AWS credentials file contents to grant access for the step
        type: string
      docker_scout_version:
        default: 0.13.1
        description: Version of the docker scout plugin to use
        type: string
      install_sbt_version:
        default: ''
        description: >-
          Version of SBT to install. Ensure compatibility with openjdk_version. If
          empty, the system one will be used
        type: string
      no_output_timeout:
        default: 15m
        description: The time to wait for the command without output
        type: string
      openjdk_version:
        default: '11'
        description: >-
          OpenJDK major version to install. Ensure compatibility with
          install_sbt_version. If empty, the system one will be used
        type: string
      persist_to_workspace:
        default: true
        description: Whether to persist the workspace or not at the end of the job
        type: boolean
      region:
        default: eu-west-1
        description: The AWS region for the deployment
        type: string
      save_cache:
        default: true
        description: Whether to save the cache or not at the end of the job
        type: boolean
      setup_docker_scout:
        default: false
        description: >-
          Install and setup docker scout plugin to scan for docker image
          vulnerabilities
        type: boolean
      steps:
        default: [ ]
        description: Steps to run
        type: steps
      steps_before_sbt:
        default: [ ]
        description: Steps to run before sbt starts
        type: steps
      store_test_results:
        default: false
        description: Whether to upload the test results back to CircleCI
        type: boolean
      use_sbt_native_client:
        default: false
        description: Use the sbt thin client
        type: boolean
    steps:
      - checkout
      - attach_workspace:
          at: ~/workdir
      - when:
          condition: << parameters.openjdk_version >>
          steps:
            - run:
                command: >
                  sudo apt update

                  sudo apt install openjdk-${OJDK_VERSION}-jre

                  sudo update-alternatives --set java
                  /usr/lib/jvm/java-${OJDK_VERSION}-openjdk-arm64/bin/java
                environment:
                  OJDK_VERSION: << parameters.openjdk_version >>
                name: Install openjdk << parameters.openjdk_version >>
      - when:
          condition: << parameters.install_sbt_version >>
          steps:
            - run:
                command: >
                  # remove pre-installed sbt

                  sudo rm -rf /opt/sbt/

                  wget https://repo.scala-sbt.org/scalasbt/debian/sbt-<<
                  parameters.install_sbt_version >>.deb

                  sudo dpkg -i sbt-<< parameters.install_sbt_version >>.deb

                  rm -f sbt-<< parameters.install_sbt_version >>.deb
                name: Install sbt << parameters.install_sbt_version >>
      - when:
          condition: << parameters.setup_docker_scout >>
          steps:
            - run:
                command: >
                  curl -L https://github.com/docker/scout-cli/releases/download/v<<
                  parameters.docker_scout_version >>/docker-scout_<<
                  parameters.docker_scout_version  >>_linux_amd64.tar.gz -o
                  docker-scout.tar.gz

                  mkdir -p $HOME/.docker/cli-plugins

                  tar -xvzf docker-scout.tar.gz -C $HOME/.docker/cli-plugins

                  chmod +x $HOME/.docker/cli-plugins/docker-scout
                name: >-
                  Download and install docker scout <<
                  parameters.docker_scout_version >>
      - run:
          command: |
            mkdir -p ~/.aws && touch ~/.aws/credentials
            cat >> ~/.aws/credentials \<< EOF
            << parameters.credentials_file_content >>
            EOF
          name: Setup AWS Credentials
      - run:
          command: |
            if [[ -f "targets.tar.gz" ]]; then
              echo "unpacking persisted workspace" && tar -xf targets.tar.gz
            else
              echo "no persisted workspace found"
            fi
          name: Uncompress local targets
      - run:
          command: |
            ARCH="arm" graalvm/build-deps.sh
            export PATH=$HOME/.musl/arm-linux-musleabi-native/bin:$PATH
            sbt "assembly;nativeImage"
            mkdir -p ~/workdir/tmp-artifacts
            mv target/native-image/codacy-coverage-reporter ~/workdir/tmp-artifacts/codacy-coverage-reporter-linux-arm
            ls -al target
            mv target/codacy-coverage-reporter-assembly-0.1.0-SNAPSHOT.jar ~/workdir/tmp-artifacts/codacy-coverage-reporter-linux-arm-assembly.jar
            ls -al ~/workdir/tmp-artifacts
          name: Generate binaries for Linux ARM
      - when:
          condition: << parameters.persist_to_workspace >>
          steps:
            - run:
                command: >
                  find -name target -type d -exec tar -zcf targets.tar.gz -H posix
                  {} + | true

                  find -name target -type d -exec rm -rf {} + | true
                name: Compressing targets
            - persist_to_workspace:
                paths:
                  - 'tmp-artifacts'
                root: ~/workdir

workflows:
  compile_test_deploy:
    jobs:
      - codacy/wait_for_workflows:
          context: ExternalSystems
      - codacy/checkout_and_version:
          write_sbt_version: true
          requires:
            - codacy/wait_for_workflows
      - pack_and_validate_orb:
          context: CodacyCircleCI
          requires:
            - codacy/checkout_and_version
      - codacy/sbt:
          name: compile_and_test
          persist_to_workspace: true
          steps_before_sbt:
            - run:
                name: Enable coverage
                command: echo "ThisBuild / coverageEnabled := true" > coverage.sbt
          steps:
            - run:
                name: Check formatting Sbt files
                command: sbt scalafmtSbtCheck
            - run:
                name: Check formatting Scala files
                command: sbt scalafmtCheckAll
            - run:
                name: Test compile
                command: sbt test:compile
            - run:
                name: It compile
                command: sbt it:compile
            - run:
                name: Unit testing
                command: sbt test
            - run:
               name: Aggregate coverage reports
               command: sbt coverageAggregate
            - run:
                name: Send coverage report to Codacy
                # We send the report using the current revision of the reporter. This allows hotfixes to be deployed
                # when the coverage-reporter is not working in production
                #
                # Specify only scala coverage reports, because coverage reporter is detecting coverage reports
                # for other languages that are not valid and are used on tests
                command: |
                  sbt "run report -l Scala -r \"**/cobertura*.xml\""
            - run:
                 name: Clean coverage.sbt from cache
                 command: rm coverage.sbt
          requires:
            - codacy/checkout_and_version
      - codacy/sbt:
          name: create_artifacts
          cmd: |
            graalvm/build-deps.sh
            export PATH=$HOME/.musl/x86_64-linux-musl-native/bin:$PATH
            sbt "assembly;nativeImage"
            mkdir -p ~/workdir/tmp-artifacts
            mv target/native-image/codacy-coverage-reporter ~/workdir/tmp-artifacts/codacy-coverage-reporter-linux
            mv target/codacy-coverage-reporter-assembly-$(cat .version).jar ~/workdir/tmp-artifacts/codacy-coverage-reporter-assembly.jar
          persist_to_workspace: true
          save_cache: true
          requires:
            - compile_and_test
      - codacy/sbt_osx:
          name: create_artifacts_for_osx
          openjdk_version: '11'
          cmd: |
            sbt nativeImage
            mkdir -p  ~/workdir/tmp-artifacts
            mv $HOME/workdir/target/native-image/codacy-coverage-reporter $HOME/workdir/tmp-artifacts/codacy-coverage-reporter-darwin
          persist_to_workspace: true
          persist_to_workspace_path: "tmp-artifacts/codacy-coverage-reporter-darwin"
          requires:
            - compile_and_test
      - create_artifacts_linux_arm:
          requires:
            - compile_and_test
      - package_artifacts:
          requires:
            - create_artifacts
            - create_artifacts_for_osx
            - create_artifacts_linux_arm
      - codacy/shell:
          name: generate_checksums
          cmd: |
            cd ~/workdir/artifacts/
            for binary_name in codacy-coverage-reporter-linux codacy-coverage-reporter-assembly.jar codacy-coverage-reporter-darwin
            do
              sha512sum "$binary_name" > "$binary_name.SHA512SUM"
              sha512sum -c "$binary_name.SHA512SUM"
            done
          persist_to_workspace: true
          requires:
            - package_artifacts
      - it_coverage_script_macosx:
          requires:
            - package_artifacts
      - it_coverage_script_ubuntu_linux_arm:
          name: it_coverage_script_ubuntu_linux_arm
          requires:
            - package_artifacts
      - it_coverage_script_alpine:
          requires:
            - package_artifacts
      - it_coverage_script_ubuntu:
          name: it_coverage_script_ubuntu_success
          error_code: 0
          config_path: integration-tests/mock-server-config.json
          requires:
            - package_artifacts
      - it_coverage_script_ubuntu:
          name: it_coverage_script_ubuntu_failure
          error_code: 1
          config_path: integration-tests/mock-server-error-config.json
          requires:
            - package_artifacts
      - codacy/shell:
          name: build_docker_image
          context: CodacyDocker
          cmd: |
            docker build --build-arg nativeImageLocation=artifacts/codacy-coverage-reporter-linux -t $CIRCLE_PROJECT_REPONAME:latest .
            docker save --output docker-image.tar $CIRCLE_PROJECT_REPONAME:latest
          persist_to_workspace: true
          requires:
            - generate_checksums
            - it_coverage_script_macosx
            - it_coverage_script_alpine
            - it_coverage_script_ubuntu_success
            - it_coverage_script_ubuntu_failure
      - codacy/publish_docker:
          name: publish_docker_image
          context: CodacyDocker
          requires:
            - build_docker_image
          filters:
            branches:
              only:
                - master
      - publish_circleci_artifacts:
          requires:
            - generate_checksums
            - it_coverage_script_macosx
            - it_coverage_script_alpine
            - it_coverage_script_ubuntu_success
            - it_coverage_script_ubuntu_failure
          filters:
            branches:
              only:
                - master
      - codacy/publish_ghr:
          name: publish_ghr
          path: ~/workdir/artifacts/
          context: CodacyGitHub
          filters:
            branches:
              only:
                - master
          requires:
            - generate_checksums
            - it_coverage_script_macosx
            - it_coverage_script_alpine
            - it_coverage_script_ubuntu_success
            - it_coverage_script_ubuntu_failure
      - codacy/publish_s3:
          name: publish_s3
          path: bin/codacy-coverage-reporter
          files: artifacts/codacy-coverage-reporter-linux artifacts/codacy-coverage-reporter-darwin artifacts/codacy-coverage-reporter-assembly.jar
          filters:
            branches:
              only:
                - master
          context: CodacyAWS
          requires:
            - publish_ghr
      - publish_dev:
          context: CodacyCircleCI
          requires:
            - publish_s3
            - pack_and_validate_orb
          filters:
            branches:
              ignore:
                - master
      - publish_prod:
          context: CodacyCircleCI
          requires:
            - publish_s3
            - pack_and_validate_orb
          filters:
            branches:
              only:
                - master