Tests, ci, docs, Makefile, ...

Signed-off-by: Juraci Paixão Kröhling <[email protected]>

Author: jpkrohling

.ci/script.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+if [ -z ${GOPATH} ]; then
+    export PATH="${HOME}/go/bin:${PATH}"
+else
+    export PATH="${GOPATH}/bin:${PATH}"
+fi
+
+BUILD_IMAGE="quay.io/jpkroehling/opentelemetry-operator" make ci
+RT=$?
+if [ ${RT} != 0 ]; then
+    echo "Failed to build the operator."
+    exit ${RT}
+fi

.codecov.yml

@@ -0,0 +1,3 @@
+ignore:
+  - "./pkg/apis/opentelemetry/v1alpha1/zz_generated.deepcopy.go"
+  - "./pkg/apis/opentelemetry/v1alpha1/zz_generated.openapi.go"

.github/workflows/continuous-integration.yaml

@@ -0,0 +1,14 @@
+name: "Continuous Integration"
+on: [push, pull_request]
+
+jobs:
+  unit-tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: jpkrohling/setup-operator-sdk@v1-release
+      with:
+        operator-sdk-version: v0.10.0
+
+    - name: "basic checks"
+      run: ./.ci/script.sh

CONTRIBUTING.md

@@ -38,7 +38,7 @@ Once minikube has finished starting, get the Operator running:
 make run
 ```
 
-At this point, a Jaeger instance can be installed:
+At this point, an OpenTelemetry Service instance can be installed:
 
 ```
 kubectl apply -f deploy/examples/simplest.yaml
@@ -58,4 +58,4 @@ The Operator SDK generates the `pkg/apis/opentelemetry/v1alpha1//zz_generated.*.
 
 #### Tests
 
-Right now, there are no tests on this repo yet. This will change really soon.
+Right now, there are only unit tests in this repository. They can be executed via `make unit-tests`. End-to-end tests are planned, and should be executed via `make e2e-tests`. All tests, including unit and end-to-end, will be executed when `make test` is called.

Makefile

@@ -13,14 +13,14 @@ OUTPUT_BINARY ?= "$(BIN_DIR)/$(OPERATOR_NAME)"
 VERSION_PKG ?= "github.com/open-telemetry/opentelemetry-operator/version"
 LD_FLAGS ?= "-X=$(VERSION_PKG).Version=$(OPERATOR_VERSION)"
 
-PACKAGES := $(shell go list ./cmd/... ./pkg/...)
+PACKAGES := $(shell go list ./cmd/... ./pkg/... ./version/...)
 
 .DEFAULT_GOAL := build
 
 .PHONY: check
-check:
+check: format ensure-generate-is-noop
 	@echo Checking...
-	@go fmt $(PACKAGES) > $(FMT_LOG)
+	@git diff -s --exit-code . || (echo "Build failed: one or more source files aren't properly formatted. Run 'make format' and update your PR." && exit 1)
 
 .PHONY: ensure-generate-is-noop
 ensure-generate-is-noop: generate
@@ -29,17 +29,12 @@ ensure-generate-is-noop: generate
 .PHONY: format
 format:
 	@echo Formatting code...
-	@go fmt $(PACKAGES)
-
-.PHONY: lint
-lint:
-	@echo Linting...
-	@$(GOPATH)/bin/golint -set_exit_status=1 $(PACKAGES)
+	@goimports -w -local "github.com/open-telemetry/opentelemetry-operator" .
 
 .PHONY: security
 security:
 	@echo Security...
-	@$(GOPATH)/bin/gosec -quiet $(PACKAGES) 2>/dev/null
+	@gosec -quiet $(PACKAGES) 2>/dev/null
 
 .PHONY: build
 build: format
@@ -68,21 +63,21 @@ generate:
 	@operator-sdk generate openapi
 
 .PHONY: test
-test:
-	@echo Running tests...
+test: unit-tests
+
+.PHONY: unit-tests
+unit-tests:
+	@echo Running unit tests...
+	@go test $(PACKAGES) -cover -coverprofile=cover.out
 
 .PHONY: all
-all: check format lint security build test
+all: check format security build test
 
 .PHONY: ci
-ci: ensure-generate-is-noop all
-
-.PHONY: scorecard
-scorecard:
-	@operator-sdk scorecard --cr-manifest deploy/examples/simplest.yaml --csv-path deploy/olm-catalog/jaeger.clusterserviceversion.yaml --init-timeout 30
+ci: install-tools ensure-generate-is-noop all
 
 .PHONY: install-tools
 install-tools:
 	@go get -u \
-		golang.org/x/lint/golint \
-		github.com/securego/gosec/cmd/gosec
+		github.com/securego/gosec/cmd/gosec \
+		golang.org/x/tools/cmd/goimports

cmd/manager/empty_test.go

@@ -0,0 +1,2 @@
+// this file exists to force the coverage tool to count this directory
+package main

deploy/crds/opentelemetry_v1alpha1_opentelemetryservice_crd.yaml

@@ -35,6 +35,10 @@ spec:
           type: object
         spec:
           properties:
+            args:
+              additionalProperties:
+                type: string
+              type: object
             config:
               description: +required
               type: string

go.mod

@@ -2,9 +2,23 @@ module github.com/open-telemetry/opentelemetry-operator
 
 require (
 	github.com/NYTimes/gziphandler v1.0.1 // indirect
+	github.com/go-logr/logr v0.1.0
 	github.com/go-openapi/spec v0.19.0
+	github.com/golang/protobuf v1.3.2 // indirect
+	github.com/kr/pty v1.1.8 // indirect
+	github.com/lib/pq v1.2.0 // indirect
+	github.com/onsi/ginkgo v1.9.0 // indirect
+	github.com/onsi/gomega v1.7.0 // indirect
 	github.com/operator-framework/operator-sdk v0.10.1-0.20190827134739-8e55eb7da610
+	github.com/securego/gosec v0.0.0-20190709033609-4b59c948083c // indirect
 	github.com/spf13/pflag v1.0.3
+	github.com/stretchr/objx v0.2.0 // indirect
+	github.com/stretchr/testify v1.4.0
+	golang.org/x/crypto v0.0.0-20190829043050-9756ffdc2472 // indirect
+	golang.org/x/net v0.0.0-20190827160401-ba9fcec4b297 // indirect
+	golang.org/x/sys v0.0.0-20190826190057-c7b8b68b1456 // indirect
+	golang.org/x/text v0.3.2 // indirect
+	golang.org/x/tools v0.0.0-20190829051458-42f498d34c4d // indirect
 	gopkg.in/yaml.v2 v2.2.2
 	k8s.io/api v0.0.0-20190612125737-db0771252981
 	k8s.io/apimachinery v0.0.0-20190612125636-6a5db36e93ad