.gitlab-ci.yml

image: $DOCKER_URL/node:20

stages:
  - update
  - commands
  - schema
  - atg-shared-checks
  - test
  - build
  - deploy
  - integration test
  - teardown
  - post build
  - docs

variables:
  BIGIP_IMAGE:
    description: The name of the BIG-IP image to use for integration testing. Names are specific to the deploy environment.
  DO_DOWNLOAD_DIR: do_rpm
  DOCS_BUILD_DIR: "docs/_build/html"
  F5_PERF_TRACING_ENABLED:
    description: Send performance traces to Jaeger
    value: "false"
    options:
      - "true"
      - "false"
  FORCE_INTEGRATION_TEST:
    description: Force a run of integration testing. Otherwise, decision is based on pipeline type.
    value: "false"
    options:
      - "true"
      - "false"
  GIT_DEPTH: "10"
  IMAGE_NAME: f5-as3-container
  RPM_PACKAGE_URL:
    description: URL from which to download the RPM to test. By default use the RPM from the build_rpm job.
  TEST_CODE_VERSION:
    description: AS3 branch/tag from which to get integration tests.
    value: "$CI_COMMIT_REF_NAME"
  REGRESSION_SCHEDULE:
    description: Type of schedule to run for integration tests.
    value: nightly
    options:
      - nightly
      - performance
      - remote
      - smoke
  PARALLEL:
    description: Run integration tests in parallel. Deploy 3 BIGIP instances.
    value: "false"
    options:
      - "true"
      - "false"
  TF_DIRECTORY: test/common/env/terraform
  TF_HTTP_LOCK_METHOD: POST
  TF_HTTP_UNLOCK_METHOD: DELETE
  TF_HTTP_USERNAME: ${CI_REGISTRY_USER}
  TF_HTTP_PASSWORD: ${CI_JOB_TOKEN}
  TF_CLI_ARGS_apply: "-auto-approve"
  TF_CLI_ARGS_destroy: "-auto-approve"
  TF_STATE_URL: "$CI_API_V4_URL/projects/$CI_PROJECT_ID/terraform/state"
  # terraform will try to update state 5(4+1) times every 3 minutes.
  TF_HTTP_RETRY_MAX: 4
  TF_HTTP_RETRY_WAIT_MIN: 3
  TEST_REPORTER_OPTIONS: "--reporter mocha-multi-reporters --reporter-options configFile=test/mochaReporterConfig.json"
  CURL_CONTENT: "Content-Type: application/json"

# This inherits all the jobs defined in the parent template
# Override variables in this project as needed
include:
# adds atg-shared-checks stage and jobs
# adds atg_shared_checks_result job to test stage
  - project: automation-toolchain/atg-shared-templates
    file:
      - compliance/base.gitlab-ci.yml
      - security/base.gitlab-ci.yml

# Override compliance template job
check_copyrights:
  allow_failure: false

# Override compliance template job
lint:
  needs:
    - schema
  allow_failure: false

update_autotool_deps:
  stage: update
  rules:
    - if: '$UPDATE_DEPS =~ /true/i'
  needs: []
  variables:
    UPDATE_BRANCH_NAME: update_autotool_deps
  script:
    - . ./scripts/dev/update-as3-deps.sh
    - >
      if [ "$AUTOTOOL_DIFF" = "true" ]; then
        git push -f origin ${UPDATE_BRANCH_NAME}
        node ./scripts/dev/createMR.js
      fi
  tags: [cm-official-docker-executor]

update_shared_schema:
  stage: update
  rules:
    - if: '$UPDATE_SHARED_SCHEMA =~ /true/i'
  needs: []
  variables:
    UPDATE_BRANCH_NAME: update_shared_schema
  script:
    - . ./scripts/dev/update-shared-schema.sh
    - >
      if [ "$SHARED_SCHEMA_DIFF" = "true" ]; then
        git push -f origin ${UPDATE_BRANCH_NAME}
        node ./scripts/dev/createMR.js
      fi
  tags: [cm-official-docker-executor]

schema:
  image: $DOCKER_URL/node:10
  stage: schema
  needs: []
  tags:
    - cm-official-docker-executor
  script:
    - npm ci --no-optional
    - npm run build-schema
  artifacts:
    name: f5-appsvcs-extension-$CI_COMMIT_SHA
    paths:
      - src/schema/latest/adc-schema.json
      - src/schema/latest/as3-schema.json

coverage:
  image: $DOCKER_URL/node:16
  stage: test
  needs:
    - schema
  tags:
    - cm-official-docker-executor
  script:
    - npm ci
    - npm run coverage
  artifacts:
    paths:
      - coverage
  coverage: /All files[^|]*\|[^|]*\s+([\d\.]+)/

node:6:
  image: $DOCKER_URL/node:12-buster
  stage: test
  needs:
    - schema
  tags:
    - cm-official-docker-executor
  script:
    # npm install fails for some packages on older versions of node, so use a newer
    # version just for the install
    - curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash
    - export NVM_DIR="$HOME/.nvm"
    - source "$NVM_DIR/nvm.sh"
    # add nvm retry
    - n=0
    - until [ "$n" -ge 3 ]; do
    -   nvm install 6 && nvm install --latest-npm 12 && break
    -   n=$((n+1))
    -   sleep 15
    - done
    - nvm use 12
    - npm ci --no-optional
    - npm install mocha@5.2.0
    - nvm use 6
    - npm run test-no-build -- $TEST_REPORTER_OPTIONS
  artifacts:
    when: always
    reports:
      junit: test_report.xml

node:8:
  image: $DOCKER_URL/node:8
  stage: test
  needs:
    - schema
  tags:
    - cm-official-docker-executor
  script:
    - npm ci
    - npm install mocha@7
    - npm run test-no-build -- $TEST_REPORTER_OPTIONS
  artifacts:
    when: always
    reports:
      junit: test_report.xml

build_rpm:
  image: $DOCKER_URL/node:14
  stage: build
  needs:
    - schema
  script:
    # setup node environment
    - apt-get update && apt-get install -y rpm --no-install-recommends
    - npm ci --no-optional
    # build installation package
    - scripts/build/buildRpm.sh "cloud"
  tags:
    - cm-official-docker-executor
  artifacts:
    name: f5-appsvcs-extension-$CI_COMMIT_SHA
    paths:
      - dist
      - src/schema/latest/adc-schema.json
      - src/schema/latest/as3-schema.json

create_source:
  stage: post build
  needs:
    - build_rpm
  script:
    - scripts/build/source-package.sh
  tags:
    - cm-official-docker-executor
  artifacts:
    name: f5-appsvcs-source
    paths:
      - dist/*-source.tar.gz
      - dist/*-examples.tar.gz

build_api_docs:
  stage: build
  needs: []
  script:
    # install packages
    # package-lock ends up with OS specific info during npm install, so
    # make sure it is right for the platform we're on
    - rm package-lock.json
    - npm install
    # generate docs
    - npm run make-api-docs
    - mkdir apidocs && mv redoc-static.html apidocs/index.html
  tags:
    - cm-official-docker-executor
  artifacts:
    name: docs
    paths:
      - apidocs

.deploy_common: &deploy_common
  image: $INTEGRATION_DEPLOY_IMAGE
  tags:
    - as3-test-docker-executor
  stage: deploy
  timeout: 2 hours
  script:
    - apk update
    - apk add npm gettext
    - cd "$TF_ROOT"
    - terraform init
    - if [[ "$SKIP_DEPLOYMENT" != "true" ]]; then
        # $SKIP_DEPLOYMENT may be undefined so we check for true
    -   terraform destroy
    -   terraform apply
    - fi
    - if [[ "$PARALLEL" = "true" ]]; then
    -   BIGIPS_ADDRESSES=($(terraform output --json admin_ip | jq -rc .[]))
    - else
    -   AS3_HOST=$(terraform output --json admin_ip | jq -rc .[0]):8443
    -   if [ "$REGRESSION_SCHEDULE" = "remote" ]; then
    -     TARGET_HOST=$(terraform output --json admin_ip | jq -rc .[1]):8443
    -   fi
    - fi
    - AS3_USERNAME=$(terraform output --json admin_username | jq -rc .)
    - AS3_PASSWORD=$(terraform output --json admin_password | jq -rc .)
    - cd -
    - if [[ -n "$RPM_PACKAGE_URL" ]]; then
    -   echo using RPM "$RPM_PACKAGE_URL" from RPM_PACKAGE_URL env var
    -   export RPM_PACKAGE=$(basename "$RPM_PACKAGE_URL")
    -   curl -o "$RPM_PACKAGE" "$RPM_PACKAGE_URL"
    - elif [[ $CI_PIPELINE_SOURCE == "pipeline" ]]; then
    -   echo using RPM from cross-project pipeline
    -   RPM_PACKAGE=$(ls ${UPSTREAM_RPM_PATH}/*.rpm)
    - else
    -   echo using RPM from our pipeline
    -   RPM_PACKAGE=$(ls ${CI_PROJECT_DIR}/dist/*.rpm)
    - fi
    - if [[ "$SKIP_DEPLOYMENT" != "true" ]]; then
    -   mkdir -p "$DO_DOWNLOAD_DIR"
    -   DO_RPM_FILE=$(scripts/dev/download-latest-do.sh "$DO_DOWNLOAD_DIR" "${DO_INTEGRATION_VERSION}")
    -   npm install --no-optional
    -   if [[ "$PARALLEL" = "true" ]]; then
    -     for IP in "${BIGIPS_ADDRESSES[@]}"; do
    -       echo "Configuring $IP"
    -       source scripts/dev/instance-config.sh "$IP:8443" "$AS3_USERNAME:$AS3_PASSWORD" "$DO_RPM_FILE" "$TF_ROOT/onboard.json" "$RPM_PACKAGE" &
    -     done
    -     for job in $(jobs -p); do
    -       echo "Jobs $(jobs -p)"
    -       echo "Job we're waiting $job"
    -       wait $job
    -       RC=$?
    -       if [[ $RC != 0 ]]; then
    -         exit $RC
    -       fi
    -     done
    -     SERVER_SET_JSON=$(source scripts/dev/build-server-set.sh)
    -     echo "Posting server set to reservation server $RESERVATION_SERVER_HOST:$RESERVATION_SERVER_PORT"
    -     SERVER_SET=$(curl -s --retry 5 --retry-max-time 300 -H "$CURL_CONTENT" -d "$SERVER_SET_JSON" -X POST http://$RESERVATION_SERVER_HOST:$RESERVATION_SERVER_PORT/reservations/api/server-sets | jq .id | tr -d '"')
    -     echo "Server set id is $SERVER_SET"
    -     echo "SERVER_SET=$SERVER_SET" >> deploy.env
    -   else
    -     echo "Configuring host $AS3_HOST"
    -     echo "AS3_HOST=$AS3_HOST" >> deploy.env
    -     echo "AS3_USERNAME=$AS3_USERNAME" >> deploy.env
    -     echo "AS3_PASSWORD=$AS3_PASSWORD" >> deploy.env
    -     source scripts/dev/instance-config.sh "$AS3_HOST" "$AS3_USERNAME:$AS3_PASSWORD" "$DO_RPM_FILE" "$TF_ROOT/onboard.json" "$RPM_PACKAGE" &
    -     if [ "$REGRESSION_SCHEDULE" = "remote" ]; then
    -       echo "Configuring target host $TARGET_HOST"
    -       echo "TARGET_HOST=$TARGET_HOST" >> deploy.env
    -       source scripts/dev/instance-config.sh "$TARGET_HOST" "$AS3_USERNAME:$AS3_PASSWORD" "$DO_RPM_FILE" "$TF_ROOT/onboard.json" "$RPM_PACKAGE" &
    -     fi
    -     wait
    -   fi
    - else
    -   echo "skipping DO install due to SKIP_DEPLOYMENT"
    - fi
  artifacts:
    when: always
    reports:
      dotenv: deploy.env
    expire_in: 1 day
  retry:
    max: 2
    when: always

deploy_to_azure:
  rules:
    - if: '$TEST_IN_AZURE =~ /true/i'
  needs:
    - job: build_rpm
      artifacts: true
    - job: schema
      artifacts: true
  variables:
    F5_DISABLE_CERT_VERIFY: 'true'
    TF_VAR_f5_cidr_blocks: "${F5_CIDR_BLOCKS}"
    TF_ROOT: "$TF_DIRECTORY/plans/azure"
    REGKEY: "$BIGIP_LICENSE_AZURE"
  before_script:
    - export TF_VAR_bigip_version="${BIGIP_IMAGE}"
    # terraform doesn't support '.' in backend address.
    - export TRIM_VERSION="$(echo ${BIGIP_IMAGE} | cut -d '-' -f 2 | tr '.' -)"
    - if [[ "$PARALLEL" = "true" ]]; then
    -   export TF_VAR_bigip_count=3
    -   export TF_HTTP_ADDRESS="$TF_STATE_URL/parallel-azure-$TRIM_VERSION"
    - else
    -   export TF_HTTP_ADDRESS="$TF_STATE_URL/azure-$TRIM_VERSION"
    - fi
    - export TF_HTTP_LOCK_ADDRESS="$TF_HTTP_ADDRESS/lock"
    - export TF_HTTP_UNLOCK_ADDRESS=$TF_HTTP_LOCK_ADDRESS
  <<: *deploy_common

deploy_for_this_project:
  rules:
    - if: '$TEST_IN_AZURE =~ /true/i'
      when: never
    - if: '$TRIGGER_INTEGRATION_TEST =~ /true/i'
      when: never
    - if: '$UPDATE_DEPS =~ /true/i'
      when: never
      # Don't run deploy in case of scheduled shared schema run
    - if: '$UPDATE_SHARED_SCHEMA =~ /true/i'
      when: never
      # In case of update_shared_schema branch we would like to have an integration
      #  testing run, so enable it here
    - if: '$CI_COMMIT_BRANCH == "update_shared_schema"'
    - if: '$CI_PIPELINE_SOURCE == "schedule"'
    - if: '$FORCE_INTEGRATION_TEST =~ /true/i'
  needs:
    - job: build_rpm
      artifacts: true
    - job: schema
      artifacts: true
  variables:
    TF_ROOT: "$TF_DIRECTORY/plans/openstack"
    REGKEY: "$BIGIP_LICENSE"
  before_script:
    # In case of update_shared_schema run we need to provide some extra vars
    - if [[ "$CI_COMMIT_BRANCH" == "update_shared_schema" ]]; then
    -   export BIGIP_IMAGE="${BIGIP_IMAGE_DEFAULT}"
    -   export PARALLEL=true
    - fi
    - export TF_VAR_bigip_version="${BIGIP_IMAGE}"
    # terraform doesn't support '.' in backend address.
    - export TRIM_VERSION="$(echo ${BIGIP_IMAGE} | cut -d '-' -f 2 | tr '.' -)"
    - if [[ "$PARALLEL" = "true" ]]; then
    -   export TF_VAR_bigip_count=3
    -   export TF_HTTP_ADDRESS="$TF_STATE_URL/parallel-openstack-$TRIM_VERSION"
    - elif [ "$REGRESSION_SCHEDULE" = "remote" ]; then
    -   export TF_VAR_bigip_count=2
    -   export TF_HTTP_ADDRESS="$TF_STATE_URL/remote-openstack-$TRIM_VERSION"
    - elif [ "$REGRESSION_SCHEDULE" = "performance" ]; then
    -   export TF_VAR_performance_test=true
    -   export TF_HTTP_ADDRESS="$TF_STATE_URL/performance-openstack-$TRIM_VERSION"
    - else
    -   export TF_HTTP_ADDRESS="$TF_STATE_URL/openstack-$TRIM_VERSION"
    - fi
    - export TF_HTTP_LOCK_ADDRESS="$TF_HTTP_ADDRESS/lock"
    - export TF_HTTP_UNLOCK_ADDRESS=$TF_HTTP_LOCK_ADDRESS
  <<: *deploy_common

deploy_for_other_project:
  rules:
    - if: '$TRIGGER_INTEGRATION_TEST =~ /true/i'
  needs:
    - project: "$UPSTREAM_PROJECT_PATH"
      job: "$UPSTREAM_JOB"
      ref: "$UPSTREAM_REF"
      artifacts: true
  variables:
    TF_ROOT: "$TF_DIRECTORY/plans/openstack"
    REGKEY: "$BIGIP_LICENSE"
  before_script:
    - if [ -n "$UPSTREAM_RPM_PATH" ]; then
    -   export RPM_PACKAGE=$(ls ${UPSTREAM_RPM_PATH}/*.rpm)
    - fi
    - export BIGIP_IMAGE="${BIGIP_IMAGE_DEFAULT}"
    - export TF_VAR_bigip_version="${BIGIP_IMAGE}"
    # terraform doesn't support '.' in backend address.
    - export TRIM_VERSION="$(echo ${BIGIP_IMAGE} | cut -d '-' -f 2 | tr '.' -)"
    - export TF_HTTP_ADDRESS="$TF_STATE_URL/atg-build-openstack-$TRIM_VERSION"
    - export TF_HTTP_LOCK_ADDRESS="$TF_HTTP_ADDRESS/lock"
    - export TF_HTTP_UNLOCK_ADDRESS=$TF_HTTP_LOCK_ADDRESS
  <<: *deploy_common

.test_rpms_common: &test_rpms_common
  image: $DOCKER_URL/node:12-buster
  stage: integration test
  tags:
    - as3-test-docker-executor
  script:
    - apt-get update && apt-get install -y jq --no-install-recommends
    - npm ci --no-optional
    - npm install --no-optional
    - REPO=f5-appsvcs-extension
    - if [[ "$TEST_CODE_VERSION" != $"CI_COMMIT_REF_NAME" ]]; then
    -   echo running test code from "$TEST_CODE_VERSION"
    -   if [[ "$TEST_CODE_VERSION" =~ ^v ]]; then
    -     if [[ "$TEST_CODE_VERSION" < v3.42.0 ]]; then
    -       REPO=f5-appsvcs
    -     fi
    -   fi
    -   TOP_DIR=$(pwd)
    -   TEST_CODE_DIR=test_code_repo/f5-appsvcs-extension
    -   git clone --branch "$TEST_CODE_VERSION" --single-branch https://gitlab-ci-token:${CI_JOB_TOKEN}@${CI_SERVER_HOST}/automation-toolchain/${REPO}.git "$TEST_CODE_DIR"
    -   cd "$TEST_CODE_DIR"
    -   node scripts/build/schema-build.js
    -   cd "$TOP_DIR"
    - else
    -   echo running test code from current branch
    -   TEST_CODE_DIR=.
    - fi
    - MOCHA_OPTS=$TEST_REPORTER_OPTIONS
    - if [[ -f ${TEST_CODE_DIR}/test/integration/bigip/property/mochaHooks.js ]]; then
    -   MOCHA_OPTS="${MOCHA_OPTS} --require ${TEST_CODE_DIR}/test/integration/bigip/property/mochaHooks.js"
    - fi
    - if [[ "$PARALLEL" = "true" ]]; then
    -   MOCHA_OPTS="${MOCHA_OPTS} --parallel"
    - fi
    - echo "TESTING WITH IMAGE ${BIGIP_IMAGE}"
    - if [ "$SMOKE_TEST" = "true" ]; then
    -   export REGRESSION_SCHEDULE="smoke"
    - fi
    - export FILE_VERBOSITY=verbose
    - if [ "$REGRESSION_SCHEDULE" = "nightly" ]; then
    -   npx mocha ${TEST_CODE_DIR}/test/integration/bigip/property ${TEST_CODE_DIR}/test/integration/bigip/misc $MOCHA_OPTS --exit
    - elif [ "$REGRESSION_SCHEDULE" = "remote" ]; then
    -   npm run property -- $MOCHA_OPTS --exit
    - elif [ "$REGRESSION_SCHEDULE" = "smoke" ]; then
    -   npm run smoke -- $MOCHA_OPTS
    - elif [ "$REGRESSION_SCHEDULE" = "performance" ]; then
    -   ./scripts/dev/enable-perf-tracing.sh "$AS3_HOST" ${AS3_USERNAME}:${AS3_PASSWORD} "$JAEGER_ENDPOINT"
    -   npx mocha ${TEST_CODE_DIR}/test/integration/bigip/property $MOCHA_OPTS --exit
    - else
    -   npm run misc -- $MOCHA_OPTS --exit
    - fi

test_rpms_in_azure:
  timeout: 12 hours
  rules:
    - if: '$SKIP_TEST_IN_AZURE =~ /true/i'
      when: never
    - if: '$TEST_IN_AZURE =~ /true/i'
  variables:
    TEST_RESOURCES_URL: "$TEST_RESOURCES_URL_AZURE"
  <<: *test_rpms_common
  artifacts:
    name: f5-appsvcs-extension-$CI_COMMIT_SHA
    when: always
    paths:
      - test/logs
    reports:
      junit: test_report.xml
  needs:
    - job: schema
      artifacts: true
    - job: build_rpm
      artifacts: true
    - job: deploy_to_azure
      artifacts: true

test_rpms_for_this_project:
  timeout: 12 hours
  rules:
    - if: '$TEST_IN_AZURE =~ /true/i'
      when: never
    - if: '$UPDATE_DEPS =~ /true/i'
      when: never
      # Don't run test in case of scheduled shared schema run
    - if: '$UPDATE_SHARED_SCHEMA =~ /true/i'
      when: never
      # In case of update_shared_schema branch we would like to have an integration
      #  testing run, so enable it here
    - if: '$CI_COMMIT_BRANCH == "update_shared_schema"'
    - if: '$CI_PIPELINE_SOURCE == "schedule"'
    - if: '$FORCE_INTEGRATION_TEST =~ /true/i'
  before_script:
    # In case of update_shared_schema run we need to provide some extra vars
    - if [[ "$CI_COMMIT_BRANCH" == "update_shared_schema" ]]; then
    -   export BIGIP_IMAGE="${BIGIP_IMAGE_DEFAULT}"
    -   export PARALLEL=true
    -   export REGRESSION_SCHEDULE=nightly
    - fi
  <<: *test_rpms_common
  artifacts:
    name: f5-appsvcs-extension-$CI_COMMIT_SHA
    when: always
    paths:
      - test/logs
    reports:
      junit: test_report.xml
  needs:
    - job: schema
      artifacts: true
    - job: deploy_for_this_project
      artifacts: true
    - job: build_rpm
      artifacts: true

test_rpms_for_other_project:
  timeout: 12 hours
  rules:
    - if: '$TEST_IN_AZURE =~ /true/i'
      when: never
    - if: '$TRIGGER_INTEGRATION_TEST =~ /true/i'
  <<: *test_rpms_common
  artifacts:
    name: f5-appsvcs-extension-$CI_COMMIT_SHA
    when: always
    paths:
      - test/logs
    reports:
      junit: test_report.xml
  needs:
    - job: schema
      artifacts: true
    - job: deploy_for_other_project
      artifacts: true
    - project: "$UPSTREAM_PROJECT_PATH"
      job: "$UPSTREAM_JOB"
      ref: "$UPSTREAM_REF"
      artifacts: true

.teardown_common: &teardown_common
  image: $INTEGRATION_DEPLOY_IMAGE
  tags:
      - as3-test-docker-executor
  stage: teardown
  script:
      - cd "$TF_ROOT"
      - terraform init
      - terraform destroy --var bigip_version="${BIGIP_IMAGE}"
      - if [[ "$PARALLEL" = "true" ]]; then
      -   echo "Delete server-set $SERVER_SET from $RESERVATION_SERVER_HOST:$RESERVATION_SERVER_PORT"
      -   curl -s --retry 5 --retry-max-time 300 -X DELETE http://$RESERVATION_SERVER_HOST:$RESERVATION_SERVER_PORT/reservations/api/server-sets/id/$SERVER_SET
      - fi
  retry:
    max: 1
    when: script_failure

teardown_azure:
  rules:
    - if: '$SKIP_TEARDOWN =~ /true/i'
      when: never
    - if: '$TEST_IN_AZURE =~ /true/i'
      when: always
  variables:
    F5_DISABLE_CERT_VERIFY: 'true'
    TF_VAR_f5_cidr_blocks: "${F5_CIDR_BLOCKS}"
    TF_ROOT: "$TF_DIRECTORY/plans/azure"
  before_script:
    # terraform doesn't support '.' in backend address.
    - export TRIM_VERSION="$(echo ${BIGIP_IMAGE} | cut -d '-' -f 2 | tr '.' -)"
    - if [[ "$PARALLEL" = "true" ]]; then
    -   export TF_HTTP_ADDRESS="$TF_STATE_URL/parallel-azure-$TRIM_VERSION"
    - else
    -   export TF_HTTP_ADDRESS="$TF_STATE_URL/azure-$TRIM_VERSION"
    - fi
  <<: *teardown_common

teardown_openstack:
  rules:
    - if: '$SKIP_TEARDOWN =~ /true/i'
      when: never
    - if: '$TEST_IN_AZURE =~ /true/i'
      when: never
    - if: '$UPDATE_DEPS =~ /true/i'
      when: never
      # Don't run test in case of scheduled shared schema run
    - if: '$UPDATE_SHARED_SCHEMA =~ /true/i'
      when: never
      # In case of update_shared_schema branch we would like to have an integration
      #  testing run, so enable it here
    - if: '$CI_COMMIT_BRANCH == "update_shared_schema"'
      when: always
    - if: '$CI_PIPELINE_SOURCE == "schedule"'
      when: always
    - if: '$TRIGGER_INTEGRATION_TEST =~ /true/i'
      when: always
    - if: '$FORCE_INTEGRATION_TEST =~ /true/i'
      when: always
  variables:
    TF_ROOT: "$TF_DIRECTORY/plans/openstack"
  before_script:
    # In case of update_shared_schema run we need to provide some extra vars
    - if [[ "$CI_COMMIT_BRANCH" == "update_shared_schema" ]]; then
    -   export BIGIP_IMAGE="${BIGIP_IMAGE_DEFAULT}"
    -   export PARALLEL=true
    - fi
    # terraform doesn't support '.' in backend address.
    - export TRIM_VERSION="$(echo ${BIGIP_IMAGE} | cut -d '-' -f 2 | tr '.' -)"
    - if [[ "$PARALLEL" = "true" ]]; then
    -   export TF_HTTP_ADDRESS="$TF_STATE_URL/parallel-openstack-$TRIM_VERSION"
    - elif [ "$REGRESSION_SCHEDULE" = "remote" ]; then
    -   export TF_VAR_bigip_count=2
    -   export TF_HTTP_ADDRESS="$TF_STATE_URL/remote-openstack-$TRIM_VERSION"
    - elif [ "$REGRESSION_SCHEDULE" = "performance" ]; then
    -   export TF_VAR_performance_test=true
    -   export TF_HTTP_ADDRESS="$TF_STATE_URL/performance-openstack-$TRIM_VERSION"
    - elif [ "$TRIGGER_INTEGRATION_TEST" = "true" ]; then
    -   export BIGIP_IMAGE="${BIGIP_IMAGE_DEFAULT}"
    -   export TRIM_VERSION="$(echo ${BIGIP_IMAGE} | cut -d '-' -f 2 | tr '.' -)"
    -   export TF_HTTP_ADDRESS="$TF_STATE_URL/atg-build-openstack-$TRIM_VERSION"
    - else
    -   export TF_HTTP_ADDRESS="$TF_STATE_URL/openstack-$TRIM_VERSION"
    - fi
  <<: *teardown_common

# DOCS
create_docs:
  image: ${CONTAINTHEDOCS_IMAGE}
  stage: post build
  allow_failure: true
  needs:
    - build_api_docs
  script:
    - npm ci --no-optional
    - npm run build-schema
    - node scripts/build/schema-to-rst.js
    - node scripts/build/create-examples-collection.js
    - if [ "$CI_COMMIT_REF_NAME" = "docs-staging" ] || [ "$CI_COMMIT_REF_NAME" = "docs-0.0" ] || [ "$CI_COMMIT_REF_NAME" = "docs-latest" ] || [ "$CI_COMMIT_REF_NAME" = "docs-3.13.1" ] || [ "$CI_COMMIT_REF_NAME" = "docs-3.5.1" ]; then
    -   rm -rf docs/_templates
    - fi
    - npm install mocha@10.2
    - make html
    - API_DOCS_INDEX=${DOCS_BUILD_DIR}/refguide/apidocs.html
    - cp apidocs/index.html ${API_DOCS_INDEX}

    - echo "Checking grammar and style"
    # Runs the grammar check on everything except the /docs/drafts directory
    - vale --glob='*.rst' .
    - echo "Checking links"
    - make linkcheck

    # build developer documentation (optional)
    - if [ "$CI_COMMIT_REF_NAME" = "main" ]; then
    -   npm install --registry $NPM_REGISTRY_URL -g jsdoc
    -   jsdoc src/nodejs/* -d contributing
    - fi
  tags:
    - cm-official-docker-executor
  artifacts:
    expire_in: 1 week
    name: sphinx-docs_$CI_COMMIT_SHA
    paths:
      - docs/_build/html
      - contributing
      - examples/as3.examples.collection.json

# Deploy docs to Pages for review
pages:
  stage: docs
  allow_failure: true
  environment:
    name: staging
    url: https://${CI_PROJECT_NAMESPACE}.${PAGES_DOMAIN}/${CI_PROJECT_NAME}/
  tags:
    - cm-official-docker-executor
  needs:
    - create_docs
    - coverage
  script:
    - PUBLIC_DIR='./public'
    - PUBLIC_DOCS=${PUBLIC_DIR}/public-docs
    - COVERAGE_DOCS=${PUBLIC_DIR}/coverage-docs
    - mkdir -p ${PUBLIC_DIR}
    - mkdir -p ${PUBLIC_DOCS}
    - mkdir -p ${COVERAGE_DOCS}
    - cp docs/index.html ${PUBLIC_DIR}/index.html
    - cp -R docs/_build/html/* ${PUBLIC_DOCS}
    - cp -R coverage/* ${COVERAGE_DOCS}
  artifacts:
    paths:
      - public
  only:
    - develop
    - doc-release-branch
    - joes-as3-wip
    - /^atgs-.*$/i

# Publish docs to clouddocs.f5.com
docs_to_production:
  image: ${CONTAINTHEDOCS_IMAGE}
  stage: docs
  environment:
    name: production
    url: https://clouddocs.f5.com/products/extensions/f5-appsvcs-extension/latest
  only:
  # Currently will only deploy to clouddocs.f5.com on commits to docs-latest
  # fill in desired release branch name and uncomment to add deployment from a branch
    - docs-latest
  tags:
    - cm-official-docker-executor
  needs:
    - create_docs
  script:
  # Uncomment and set to create desired version format
    - aws s3 sync docs/_build/html s3://clouddocs.f5.com/products/extensions/f5-appsvcs-extension/latest
    - aws s3 cp versions.json s3://clouddocs.f5.com/products/extensions/f5-appsvcs-extension/versions.json
    # create invalidation to clear cloudfront cache
    # - aws cloudfront create-invalidation --distribution-id $AWS_DIST --paths /products/extensions/f5-appsvcs-extension/latest