Merge branch 'CNT-1330/jenkins-ci' into 'master'

Add Jenkins file for CI build steps

See merge request nvidia/container-toolkit/container-toolkit!28

.gitlab-ci.yml

@@ -1,3 +1,17 @@
+# 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:
@@ -37,42 +51,40 @@ lint:
   <<: *tests-setup
   stage: tests
   script:
-    - go get -u golang.org/x/lint/golint
+    - GO111MODULE=off go get -u golang.org/x/lint/golint
-    - golint -set_exit_status ${PROJECT_GOPATH}/pkg
+    - make lint
 
 vet:
   <<: *tests-setup
   stage: tests
   script:
-    - go vet ${PROJECT_GOPATH}/pkg
+    - make vet
 
 unit_test:
   <<: *tests-setup
   stage: tests
   script:
-    - go test ${PROJECT_GOPATH}/pkg
+    - make test
 
 fmt:
   <<: *tests-setup
   stage: tests
   script:
-    - res=$(gofmt -l pkg/*.go)
+    - make assert-fmt
-    - echo "$res"
-    - test -z "$res"
 
 ineffassign:
   <<: *tests-setup
   stage: tests
   script:
-    - go get -u github.com/gordonklaus/ineffassign
+    - GO111MODULE=off go get -u github.com/gordonklaus/ineffassign
-    - ineffassign pkg/*.go
+    - make ineffassign
 
 misspell:
   <<: *tests-setup
   stage: tests
   script:
-    - go get -u github.com/client9/misspell/cmd/misspell
+    - GO111MODULE=off go get -u github.com/client9/misspell/cmd/misspell
-    - misspell pkg/*.go
+    - make misspell
 
 # build-one jobs build packages for a single OS / ARCH combination.
 #

Jenkinsfile

@@ -0,0 +1,106 @@
+/*
+# Copyright (c) 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.
+*/
+
+podTemplate (cloud:'sw-gpu-cloudnative',
+    containers: [
+    containerTemplate(name: 'docker', image: 'docker:dind', ttyEnabled: true, privileged: true),
+    containerTemplate(name: 'golang', image: 'golang:1.14.2', ttyEnabled: true)
+  ]) {
+    node(POD_LABEL) {
+        stage('checkout') {
+            checkout scm
+        }
+        stage('dependencies') {
+            container('golang') {
+                sh 'GO111MODULE=off go get -u github.com/client9/misspell/cmd/misspell'
+                sh 'GO111MODULE=off go get -u github.com/gordonklaus/ineffassign'
+                sh 'GO111MODULE=off go get -u golang.org/x/lint/golint'
+            }
+            container('docker') {
+                sh 'apk add --no-cache make bash'
+            }
+        }
+        stage('check') {
+            parallel (
+                getGolangStages(["assert-fmt", "lint", "vet", "ineffassign", "misspell"])
+            )
+        }
+        stage('test') {
+            parallel (
+                getGolangStages(["test"])
+            )
+        }
+        stage('build-one') {
+            parallel (
+                getSingleBuildForArchitectures(["amd64", "ppc64le", "arm64"])
+            )
+        }
+        stage('build-all') {
+            parallel (
+                getAllBuildForArchitectures(["amd64", "ppc64le", "arm64", "x86_64", "aarch64"])
+            )
+        }
+    }
+}
+
+def getGolangStages(def targets) {
+    stages = [:]
+
+    for (t in targets) {
+        stages[t] = getLintClosure(t)
+    }
+
+    return stages
+}
+
+def getSingleBuildForArchitectures(def architectures) {
+    return getBuildStagesForArchitectures(architectures, "make", "ubuntu18.04")
+}
+
+def getAllBuildForArchitectures(def architectures) {
+    // TODO: For the time being we only echo the command for the "all" stages
+    return getBuildStagesForArchitectures(architectures, "echo make", "docker")
+}
+
+def getBuildStagesForArchitectures(def architectures, def makeCommand, def makeTargetPrefix) {
+    stages = [:]
+
+    for (a in architectures) {
+        stages[a] = getBuildClosure(a, makeCommand, "${makeTargetPrefix}-${a}")
+    }
+
+    return stages
+}
+
+def getBuildClosure(def architecture, def makeCommand, def makeTarget) {
+    return {
+        container('docker') {
+            stage(architecture) {
+                sh "${makeCommand} ${makeTarget}"
+            }
+        }
+    }
+}
+
+def getLintClosure(def target) {
+    return {
+        container('golang') {
+            stage(target) {
+                sh "make ${target}"
+            }
+        }
+    }
+}

Makefile

@@ -1,4 +1,16 @@
-# Copyright (c) 2017-2020, NVIDIA CORPORATION. All rights reserved.
+# Copyright (c) 2017-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.
 
 DOCKER   ?= docker
 MKDIR    ?= mkdir
@@ -13,7 +25,43 @@ GOLANG_PKG_PATH := github.com/NVIDIA/nvidia-container-toolkit/pkg
 
 # By default run all native docker-based targets
 docker-native:
-include $(CURDIR)/docker.mk
+include $(CURDIR)/docker/docker.mk
 
 binary:
 	go build -ldflags "-s -w" -o "$(LIB_NAME)" $(GOLANG_PKG_PATH)
+
+# Define the check targets for the Golang codebase
+MODULE := .
+.PHONY: check fmt assert-fmt ineffassign lint misspell vet
+check: assert-fmt lint misspell vet
+fmt:
+	go list -f '{{.Dir}}' $(MODULE)/... \
+		| xargs gofmt -s -l -w
+
+assert-fmt:
+	go list -f '{{.Dir}}' $(MODULE)/... \
+		| xargs gofmt -s -l > fmt.out
+	@if [ -s fmt.out ]; then \
+		echo "\nERROR: The following files are not formatted:\n"; \
+		cat fmt.out; \
+		rm fmt.out; \
+		exit 1; \
+	else \
+		rm fmt.out; \
+	fi
+
+ineffassign:
+	ineffassign $(MODULE)/...
+
+lint:
+	# We use `go list -f '{{.Dir}}' $(GOLANG_PKG_PATH)/...` to skip the `vendor` folder.
+	go list -f '{{.Dir}}' $(MODULE)/... | xargs golint -set_exit_status
+
+misspell:
+	misspell $(MODULE)/...
+
+vet:
+	go vet $(MODULE)/...
+
+test:
+	go test $(MODULE)/...

docker/docker.mk

@@ -1,4 +1,16 @@
-# Copyright (c) 2017-2020, NVIDIA CORPORATION. All rights reserved.
+# Copyright (c) 2017-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.
 
 # Supported OSs by architecture
 AMD64_TARGETS := ubuntu20.04 ubuntu18.04 ubuntu16.04 debian10 debian9
@@ -108,7 +120,7 @@ docker-build-%:
 	DOCKER_BUILDKIT=1 \
 	$(DOCKER) build \
 	    --progress=plain \
-	    --build-arg BASEIMAGE=$(BASEIMAGE) \
+	    --build-arg BASEIMAGE="$(BASEIMAGE)" \
 	    --build-arg GOLANG_VERSION="$(GOLANG_VERSION)" \
 	    --build-arg PKG_VERS="$(LIB_VERSION)" \
 	    --build-arg PKG_REV="$(PKG_REV)" \