# Copyright (c) 2019-2021, NVIDIA CORPORATION.  All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# Build packages for all supported OS / ARCH combinations

stages:
  - tests
  - build-one
  - build-all

.tests-setup: &tests-setup
  image: golang:1.14.4

  rules:
    - when: always

  variables:
    GITHUB_ROOT: "github.com/NVIDIA"
    PROJECT_GOPATH: "${GITHUB_ROOT}/nvidia-container-toolkit"

  before_script:
    - mkdir -p ${GOPATH}/src/${GITHUB_ROOT}
    - ln -s ${CI_PROJECT_DIR} ${GOPATH}/src/${PROJECT_GOPATH}

.build-setup: &build-setup
  image: docker:19.03.8

  services:
    - name: docker:19.03.8-dind
      command: ["--experimental"]

  before_script:
  - apk update
  - apk upgrade
  - apk add coreutils build-base sed git bash make
  - docker run --rm --privileged multiarch/qemu-user-static --reset -p yes -c yes

# Run a series of sanity-check tests over the code
lint:
  <<: *tests-setup
  stage: tests
  script:
    - GO111MODULE=off go get -u golang.org/x/lint/golint
    - make lint

vet:
  <<: *tests-setup
  stage: tests
  script:
    - make vet

unit_test:
  <<: *tests-setup
  stage: tests
  script:
    - make test

coverage:
  <<: *tests-setup
  stage: tests
  script:
    - make coverage

fmt:
  <<: *tests-setup
  stage: tests
  script:
    - make assert-fmt

ineffassign:
  <<: *tests-setup
  stage: tests
  script:
    - GO111MODULE=off go get -u github.com/gordonklaus/ineffassign
    - make ineffassign

misspell:
  <<: *tests-setup
  stage: tests
  script:
    - GO111MODULE=off go get -u github.com/client9/misspell/cmd/misspell
    - make misspell

# build-one jobs build packages for a single OS / ARCH combination.
#
# They are run during the first stage of the pipeline as a smoke test to ensure
# that we can successfully build packages on all of our architectures for a
# single OS. They are triggered on any change to an MR. No artifacts are
# produced as part of build-one jobs.
.build-one-setup: &build-one-setup
  <<: *build-setup
  stage: build-one
  only:
    - merge_requests

# build-all jobs build packages for every OS / ARCH combination we support.
#
# They are run under two conditions:
# 1) Automatically whenever a new tag is pushed to the repo (e.g. v1.1.0)
# 2) Manually by a reviewer just before merging a MR.
#
# Unlike build-one jobs, it takes a long time to build the full suite
# OS / ARCH combinations, so this is optimized to only run once per MR
# (assuming it all passes). A full set of artifacts including the packages
# built for each OS / ARCH are produced as a result of these jobs.
.build-all-setup: &build-all-setup
  <<: *build-setup
  stage: build-all
  timeout: 2h 30m
  rules:
    - if: $CI_COMMIT_TAG
      when: always
    - if: $CI_MERGE_REQUEST_ID
      when: always

  variables:
    ARTIFACTS_NAME: "${CI_PROJECT_NAME}-${CI_COMMIT_REF_SLUG}-${CI_JOB_NAME}-artifacts-${CI_PIPELINE_ID}"
    ARTIFACTS_DIR: "${CI_PROJECT_NAME}-${CI_COMMIT_REF_SLUG}-artifacts-${CI_PIPELINE_ID}"
    DIST_DIR: "${CI_PROJECT_DIR}/${ARTIFACTS_DIR}"

  artifacts:
    name: ${ARTIFACTS_NAME}
    paths:
      - ${ARTIFACTS_DIR}

# The full set of build-one jobs organizes to build
# ubuntu18.04 in parallel on each of our supported ARCHs.
build-one-amd64:
  <<: *build-one-setup
  script:
    - make ubuntu18.04-amd64

build-one-ppc64le:
  <<: *build-one-setup
  script:
    - make ubuntu18.04-ppc64le

build-one-arm64:
  <<: *build-one-setup
  script:
    - make ubuntu18.04-arm64

# The full set of build-all jobs organized to
# have builds for each ARCH run in parallel.
build-all-amd64:
  <<: *build-all-setup
  script:
    - make docker-amd64

build-all-x86_64:
  <<: *build-all-setup
  script:
    - make docker-x86_64

build-all-ppc64le:
  <<: *build-all-setup
  script:
    - make docker-ppc64le

build-all-arm64:
  <<: *build-all-setup
  script:
    - make docker-arm64

build-all-aarch64:
  <<: *build-all-setup
  script:
    - make docker-aarch64