From 99bfd151acb810e9b9452f21a76de68d403fc081 Mon Sep 17 00:00:00 2001 From: Alex Collins Date: Thu, 13 May 2021 16:33:19 -0700 Subject: [PATCH] refactor: move api/util to ../shared/ --- .codecov.yml | 2 +- .github/workflows/build.yml | 2 +- Dockerfile | 6 ++++-- Makefile | 12 ++++++------ api/v1alpha1/step_spec.go | 2 +- docs/examples/examples_test.go | 2 +- docs/examples/main.go | 2 +- manager/controllers/bus/installer.go | 2 +- manager/controllers/config.go | 2 +- manager/controllers/pipeline_controller.go | 2 +- manager/controllers/step_controller.go | 2 +- runner/group/group.go | 2 +- runner/init/init.go | 2 +- runner/sidecar/sidecar.go | 2 +- shared/containerkiller/container_killer.go | 2 +- {api => shared}/util/.gitignore | 0 {api => shared}/util/env.go | 0 {api => shared}/util/env_test.go | 0 {api => shared}/util/equal.go | 0 {api => shared}/util/error.go | 0 {api => shared}/util/hash.go | 0 {api => shared}/util/hash_test.go | 0 {api => shared}/util/io.go | 0 {api => shared}/util/json.go | 0 {api => shared}/util/json_test.go | 0 {api => shared}/util/print.go | 0 {api => shared}/util/process.go | 0 {api => shared}/util/resource.go | 0 {api => shared}/util/version.go | 0 29 files changed, 23 insertions(+), 21 deletions(-) rename {api => shared}/util/.gitignore (100%) rename {api => shared}/util/env.go (100%) rename {api => shared}/util/env_test.go (100%) rename {api => shared}/util/equal.go (100%) rename {api => shared}/util/error.go (100%) rename {api => shared}/util/hash.go (100%) rename {api => shared}/util/hash_test.go (100%) rename {api => shared}/util/io.go (100%) rename {api => shared}/util/json.go (100%) rename {api => shared}/util/json_test.go (100%) rename {api => shared}/util/print.go (100%) rename {api => shared}/util/process.go (100%) rename {api => shared}/util/resource.go (100%) rename {api => shared}/util/version.go (100%) diff --git a/.codecov.yml b/.codecov.yml index a07b0e7e..c8d0cc0e 100644 --- a/.codecov.yml +++ b/.codecov.yml @@ -1,6 +1,6 @@ ignore: - .github - - api/util/containerkiller/container_killer.go + - shared/util/containerkiller/container_killer.go - api/v1alpha1/generated.pb.go - api/v1alpha1/zz_generated.deepcopy.go - config diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 4a2742e7..d4e98716 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -27,7 +27,7 @@ jobs: needs: [ test ] steps: - uses: actions/checkout@v2 - - run: touch api/util/message + - run: touch shared/util/message - uses: golangci/golangci-lint-action@v2 with: version: v1.36.0 diff --git a/Dockerfile b/Dockerfile index 7b4fda64..cb0c045d 100644 --- a/Dockerfile +++ b/Dockerfile @@ -13,8 +13,9 @@ RUN --mount=type=cache,target=/go/pkg/mod go mod download FROM builder AS controller-builder COPY .git/ .git/ COPY api/ api/ +COPY shared/ shared/ COPY manager/ manager/ -RUN go generate ./api/util/version.go +RUN go generate ./shared/util/version.go RUN --mount=type=cache,target=/root/.cache/go-build CGO_ENABLED=0 go build -a -o bin/manager ./manager FROM gcr.io/distroless/static:nonroot AS controller @@ -28,8 +29,9 @@ ENTRYPOINT ["/manager"] FROM builder AS runner-builder COPY .git/ .git/ COPY api/ api/ +COPY shared/ shared/ COPY runner/ runner/ -RUN go generate ./api/util/version.go +RUN go generate ./shared/util/version.go RUN --mount=type=cache,target=/root/.cache/go-build CGO_ENABLED=0 go build -a -o bin/runner ./runner COPY kill/ kill/ RUN --mount=type=cache,target=/root/.cache/go-build CGO_ENABLED=0 go build -a -o bin/kill ./kill diff --git a/Makefile b/Makefile index d64cc90e..24e96aaa 100644 --- a/Makefile +++ b/Makefile @@ -20,7 +20,7 @@ build: generate manifests go build ./... # Run tests -test: api/util/message +test: shared/util/message go test -v ./... -coverprofile cover.out pre-commit: codegen test install lint @@ -96,7 +96,7 @@ api/v1alpha1/generated.%: $(shell find api/v1alpha1 -type f -name '*.go' -not -n mv api/v1alpha1/groupversion_info.go.0 api/v1alpha1/groupversion_info.go go mod tidy -lint: api/util/message +lint: shared/util/message go mod tidy golangci-lint run --fix kubectl apply --dry-run=client -f docs/examples @@ -126,7 +126,7 @@ scan-%: changelog: git log --oneline -n10 > changelog -$(GOBIN)/controller-gen: api/util/message +$(GOBIN)/controller-gen: shared/util/message go install sigs.k8s.io/controller-tools/cmd/controller-gen@v0.4.1 version:=2.3.2 @@ -150,11 +150,11 @@ config/nats/single-server-nats.yml: config/stan/single-server-stan.yml: curl -o config/stan/single-server-stan.yml https://raw.githubusercontent.com/nats-io/k8s/v0.7.4/nats-streaming-server/single-server-stan.yml -api/util/message: - touch api/util/message +shared/util/message: + touch shared/util/message .PHONY: test-examples -test-examples: api/util/message +test-examples: shared/util/message go test -timeout 20m -v -tags examples -count 1 ./docs/examples argocli: diff --git a/api/v1alpha1/step_spec.go b/api/v1alpha1/step_spec.go index bdb8e915..80aaaf56 100644 --- a/api/v1alpha1/step_spec.go +++ b/api/v1alpha1/step_spec.go @@ -4,7 +4,7 @@ import ( "strconv" "time" - "github.com/argoproj-labs/argo-dataflow/api/util" + "github.com/argoproj-labs/argo-dataflow/shared/util" corev1 "k8s.io/api/core/v1" "k8s.io/utils/pointer" ) diff --git a/docs/examples/examples_test.go b/docs/examples/examples_test.go index 232964ab..c5d04e63 100644 --- a/docs/examples/examples_test.go +++ b/docs/examples/examples_test.go @@ -7,7 +7,7 @@ import ( "testing" "time" - "github.com/argoproj-labs/argo-dataflow/api/util" + "github.com/argoproj-labs/argo-dataflow/shared/util" dfv1 "github.com/argoproj-labs/argo-dataflow/api/v1alpha1" "github.com/stretchr/testify/assert" metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" diff --git a/docs/examples/main.go b/docs/examples/main.go index 984ce432..c6095e49 100644 --- a/docs/examples/main.go +++ b/docs/examples/main.go @@ -6,7 +6,7 @@ import ( "path/filepath" "strings" - "github.com/argoproj-labs/argo-dataflow/api/util" + "github.com/argoproj-labs/argo-dataflow/shared/util" "sigs.k8s.io/yaml" ) diff --git a/manager/controllers/bus/installer.go b/manager/controllers/bus/installer.go index d297e187..7c32eed1 100644 --- a/manager/controllers/bus/installer.go +++ b/manager/controllers/bus/installer.go @@ -10,7 +10,7 @@ import ( "k8s.io/client-go/rest" - "github.com/argoproj-labs/argo-dataflow/api/util" + "github.com/argoproj-labs/argo-dataflow/shared/util" dfv1 "github.com/argoproj-labs/argo-dataflow/api/v1alpha1" appsv1 "k8s.io/api/apps/v1" diff --git a/manager/controllers/config.go b/manager/controllers/config.go index d62764a5..0f7fc7a8 100644 --- a/manager/controllers/config.go +++ b/manager/controllers/config.go @@ -5,7 +5,7 @@ import ( "os" "time" - "github.com/argoproj-labs/argo-dataflow/api/util" + "github.com/argoproj-labs/argo-dataflow/shared/util" dfv1 "github.com/argoproj-labs/argo-dataflow/api/v1alpha1" corev1 "k8s.io/api/core/v1" diff --git a/manager/controllers/pipeline_controller.go b/manager/controllers/pipeline_controller.go index 6ee83799..3cbecb5b 100644 --- a/manager/controllers/pipeline_controller.go +++ b/manager/controllers/pipeline_controller.go @@ -31,7 +31,7 @@ import ( ctrl "sigs.k8s.io/controller-runtime" "sigs.k8s.io/controller-runtime/pkg/client" - "github.com/argoproj-labs/argo-dataflow/api/util" + "github.com/argoproj-labs/argo-dataflow/shared/util" dfv1 "github.com/argoproj-labs/argo-dataflow/api/v1alpha1" "github.com/argoproj-labs/argo-dataflow/manager/controllers/bus" "github.com/argoproj-labs/argo-dataflow/shared/containerkiller" diff --git a/manager/controllers/step_controller.go b/manager/controllers/step_controller.go index b664729a..d6f390f0 100644 --- a/manager/controllers/step_controller.go +++ b/manager/controllers/step_controller.go @@ -32,7 +32,7 @@ import ( ctrl "sigs.k8s.io/controller-runtime" "sigs.k8s.io/controller-runtime/pkg/client" - "github.com/argoproj-labs/argo-dataflow/api/util" + "github.com/argoproj-labs/argo-dataflow/shared/util" dfv1 "github.com/argoproj-labs/argo-dataflow/api/v1alpha1" "github.com/argoproj-labs/argo-dataflow/shared/containerkiller" ) diff --git a/runner/group/group.go b/runner/group/group.go index 44554020..93c99800 100644 --- a/runner/group/group.go +++ b/runner/group/group.go @@ -9,7 +9,7 @@ import ( "path/filepath" "sort" - util2 "github.com/argoproj-labs/argo-dataflow/api/util" + util2 "github.com/argoproj-labs/argo-dataflow/shared/util" dfv1 "github.com/argoproj-labs/argo-dataflow/api/v1alpha1" "github.com/argoproj-labs/argo-dataflow/runner/util" diff --git a/runner/init/init.go b/runner/init/init.go index 6b9ca79e..128acfc7 100644 --- a/runner/init/init.go +++ b/runner/init/init.go @@ -8,7 +8,7 @@ import ( "path/filepath" "syscall" - util2 "github.com/argoproj-labs/argo-dataflow/api/util" + util2 "github.com/argoproj-labs/argo-dataflow/shared/util" "github.com/go-git/go-git/v5" "github.com/go-git/go-git/v5/plumbing" diff --git a/runner/sidecar/sidecar.go b/runner/sidecar/sidecar.go index 03cd2d80..62568db1 100644 --- a/runner/sidecar/sidecar.go +++ b/runner/sidecar/sidecar.go @@ -25,7 +25,7 @@ import ( ctrl "sigs.k8s.io/controller-runtime" "sigs.k8s.io/controller-runtime/pkg/log/zap" - apiutil "github.com/argoproj-labs/argo-dataflow/api/util" + apiutil "github.com/argoproj-labs/argo-dataflow/shared/util" dfv1 "github.com/argoproj-labs/argo-dataflow/api/v1alpha1" "github.com/argoproj-labs/argo-dataflow/runner/util" ) diff --git a/shared/containerkiller/container_killer.go b/shared/containerkiller/container_killer.go index 429e4ded..3eeddd6f 100644 --- a/shared/containerkiller/container_killer.go +++ b/shared/containerkiller/container_killer.go @@ -10,7 +10,7 @@ import ( "k8s.io/client-go/tools/remotecommand" "sigs.k8s.io/controller-runtime/pkg/log/zap" - "github.com/argoproj-labs/argo-dataflow/api/util" + "github.com/argoproj-labs/argo-dataflow/shared/util" dfv1 "github.com/argoproj-labs/argo-dataflow/api/v1alpha1" ) diff --git a/api/util/.gitignore b/shared/util/.gitignore similarity index 100% rename from api/util/.gitignore rename to shared/util/.gitignore diff --git a/api/util/env.go b/shared/util/env.go similarity index 100% rename from api/util/env.go rename to shared/util/env.go diff --git a/api/util/env_test.go b/shared/util/env_test.go similarity index 100% rename from api/util/env_test.go rename to shared/util/env_test.go diff --git a/api/util/equal.go b/shared/util/equal.go similarity index 100% rename from api/util/equal.go rename to shared/util/equal.go diff --git a/api/util/error.go b/shared/util/error.go similarity index 100% rename from api/util/error.go rename to shared/util/error.go diff --git a/api/util/hash.go b/shared/util/hash.go similarity index 100% rename from api/util/hash.go rename to shared/util/hash.go diff --git a/api/util/hash_test.go b/shared/util/hash_test.go similarity index 100% rename from api/util/hash_test.go rename to shared/util/hash_test.go diff --git a/api/util/io.go b/shared/util/io.go similarity index 100% rename from api/util/io.go rename to shared/util/io.go diff --git a/api/util/json.go b/shared/util/json.go similarity index 100% rename from api/util/json.go rename to shared/util/json.go diff --git a/api/util/json_test.go b/shared/util/json_test.go similarity index 100% rename from api/util/json_test.go rename to shared/util/json_test.go diff --git a/api/util/print.go b/shared/util/print.go similarity index 100% rename from api/util/print.go rename to shared/util/print.go diff --git a/api/util/process.go b/shared/util/process.go similarity index 100% rename from api/util/process.go rename to shared/util/process.go diff --git a/api/util/resource.go b/shared/util/resource.go similarity index 100% rename from api/util/resource.go rename to shared/util/resource.go diff --git a/api/util/version.go b/shared/util/version.go similarity index 100% rename from api/util/version.go rename to shared/util/version.go