feat: adds k3s module (#1194)

* adds k3s module Signed-off-by: Mritunjay <mritunjaysharma394@gmail.com> * minor refactors Signed-off-by: Mritunjay <mritunjaysharma394@gmail.com> * refactors in modules Signed-off-by: Mritunjay <mritunjaysharma394@gmail.com> * docs improvement Signed-off-by: Mritunjay <mritunjaysharma394@gmail.com> * minor fixes in docs Signed-off-by: Mritunjay <mritunjaysharma394@gmail.com> * ran go mod tidy for k3s modules Signed-off-by: Mritunjay <mritunjaysharma394@gmail.com> * nit: improved method name Signed-off-by: Mritunjay <mritunjaysharma394@gmail.com> * improvements in docs Signed-off-by: Mritunjay <mritunjaysharma394@gmail.com> --------- Signed-off-by: Mritunjay <mritunjaysharma394@gmail.com>
testcontainers · May 23, 2023 · bfd7304 · bfd7304
1 parent 5d4d8fa
commit bfd7304
Show file tree

Hide file tree

Showing 11 changed files with 1,181 additions and 0 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -84,6 +84,12 @@ updates:
         interval: monthly
       open-pull-requests-limit: 3
       rebase-strategy: disabled
+    - package-ecosystem: gomod
+      directory: /modules/k3s
+      schedule:
+        interval: monthly
+      open-pull-requests-limit: 3
+      rebase-strategy: disabled
     - package-ecosystem: gomod
       directory: /modules/localstack
       schedule:

diff --git a/.github/workflows/module-k3s.yml b/.github/workflows/module-k3s.yml
@@ -0,0 +1,56 @@
+name: K3s module pipeline
+
+on:
+  push:
+    paths-ignore:
+    - 'mkdocs.yml'
+    - 'docs/**'
+    - 'README.md'
+  pull_request:
+    paths-ignore:
+    - 'mkdocs.yml'
+    - 'docs/**'
+    - 'README.md'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.sha }}
+  cancel-in-progress: true
+
+jobs:
+  test-k3s:
+    strategy:
+      matrix:
+        go-version: [1.19.x, 1.x]
+    runs-on: "ubuntu-latest"
+    steps:
+
+      - name: Set up Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: ${{ matrix.go-version }}
+        id: go
+
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v3
+
+      - name: modVerify
+        working-directory: ./modules/k3s
+        run: go mod verify
+
+      - name: modTidy
+        working-directory: ./modules/k3s
+        run: make tools-tidy
+
+      - name: gotestsum
+        working-directory: ./modules/k3s
+        run: make test-unit
+
+      - name: Run checker
+        run: |
+          ./scripts/check_environment.sh
+
+      - name: Test Summary
+        uses: test-summary/action@4ee9ece4bca777a38f05c8fc578ac2007fe266f7
+        with:
+          paths: "**/TEST-k3s*.xml"
+        if: always()
diff --git a/docs/modules/k3s.md b/docs/modules/k3s.md
@@ -0,0 +1,81 @@
+# K3s
+
+Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
+
+## Introduction
+
+The Testcontainers module for K3s.
+
+## Adding this module to your project dependencies
+
+Please run the following command to add the K3s module to your Go dependencies:
+
+```
+go get github.com/testcontainers/testcontainers-go/modules/k3s
+```
+
+## Usage example
+
+<!--codeinclude-->
+[Test for a K3s container](../../modules/k3s/k3s_test.go) inside_block: k3sRunContainer
+<!--/codeinclude-->
+
+## Module reference
+
+The K3s module exposes one entrypoint function to create the K3s container, and this function receives two parameters:
+
+```golang
+func RunContainer(ctx context.Context, opts ...testcontainers.ContainerCustomizer) (*K3sContainer, error)
+```
+
+- `context.Context`, the Go context.
+- `testcontainers.ContainerCustomizer`, a variadic argument for passing options.
+
+
+### Container Ports
+These are the ports used by the K3s container:
+<!--codeinclude-->
+[Container Ports](../../modules/k3s/k3s.go) inside_block:containerPorts
+<!--/codeinclude-->
+
+### Container Options
+
+When starting the K3s container, you can pass options in a variadic way to configure it.
+
+#### Image
+
+If you need to set a different K3s Docker image, you can use `testcontainers.WithImage` with a valid Docker image
+for K3s. E.g. `testcontainers.WithImage("docker.io/rancher/k3s:latest")`.
+
+#### Wait Strategies
+
+If you need to set a different wait strategy for K3s, you can use `testcontainers.WithWaitStrategy` with a valid wait strategy
+for K3s.
+
+!!!info
+    The default deadline for the wait strategy is 60 seconds.
+
+At the same time, it's possible to set a wait strategy and a custom deadline with `testcontainers.WithWaitStrategyAndDeadline`.
+
+#### Docker type modifiers
+
+If you need an advanced configuration for K3s, you can leverage the following Docker type modifiers:
+
+- `testcontainers.WithConfigModifier`
+- `testcontainers.WithHostConfigModifier`
+- `testcontainers.WithEndpointSettingsModifier`
+
+Please read the [Create containers: Advanced Settings](../features/creating_container.md#advanced-settings) documentation for more information.
+
+### Container Methods
+
+The K3s container exposes the following methods:
+
+#### GetKubeConfig
+
+The `GetKubeConfig` method returns the K3s cluster's `kubeconfig`, including the server URL, to be used for connecting
+to the Kubernetes Rest Client API using a Kubernetes client. It'll be returned in the format of `[]bytes`.
+
+<!--codeinclude-->
+[Get KubeConifg](../../modules/k3s/k3s_test.go) inside_block:GetKubeConfig
+<!--/codeinclude-->
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -58,6 +58,7 @@ nav:
     - Modules:
         - modules/index.md
         - modules/couchbase.md
+        - modules/k3s.md
         - modules/localstack.md
         - modules/mysql.md
         - modules/neo4j.md

diff --git a/modules/k3s/Makefile b/modules/k3s/Makefile
@@ -0,0 +1,5 @@
+include ../../commons-test.mk
+
+.PHONY: test
+test:
+	$(MAKE) test-k3s
diff --git a/modules/k3s/go.mod b/modules/k3s/go.mod
@@ -0,0 +1,78 @@
+module github.com/testcontainers/testcontainers-go/modules/k3s
+
+go 1.19
+
+require (
+	github.com/docker/docker v23.0.5+incompatible
+	github.com/docker/go-connections v0.4.0
+	github.com/stretchr/testify v1.8.2
+	github.com/testcontainers/testcontainers-go v0.20.1
+	gopkg.in/yaml.v3 v3.0.1
+	gotest.tools/gotestsum v1.10.0
+	k8s.io/apimachinery v0.22.5
+	k8s.io/client-go v0.22.5
+)
+
+require (
+	github.com/Azure/go-ansiterm v0.0.0-20210617225240-d185dfc1b5a1 // indirect
+	github.com/Microsoft/go-winio v0.5.2 // indirect
+	github.com/cenkalti/backoff/v4 v4.2.0 // indirect
+	github.com/containerd/containerd v1.6.19 // indirect
+	github.com/cpuguy83/dockercfg v0.3.1 // indirect
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/dnephin/pflag v1.0.7 // indirect
+	github.com/docker/distribution v2.8.2+incompatible // indirect
+	github.com/docker/go-units v0.5.0 // indirect
+	github.com/fatih/color v1.13.0 // indirect
+	github.com/fsnotify/fsnotify v1.5.4 // indirect
+	github.com/go-logr/logr v1.2.2 // indirect
+	github.com/gogo/protobuf v1.3.2 // indirect
+	github.com/golang/protobuf v1.5.2 // indirect
+	github.com/google/go-cmp v0.5.9 // indirect
+	github.com/google/gofuzz v1.2.0 // indirect
+	github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510 // indirect
+	github.com/google/uuid v1.3.0 // indirect
+	github.com/googleapis/gnostic v0.5.5 // indirect
+	github.com/imdario/mergo v0.3.12 // indirect
+	github.com/json-iterator/go v1.1.12 // indirect
+	github.com/klauspost/compress v1.15.9 // indirect
+	github.com/magiconair/properties v1.8.7 // indirect
+	github.com/mattn/go-colorable v0.1.12 // indirect
+	github.com/mattn/go-isatty v0.0.16 // indirect
+	github.com/moby/patternmatcher v0.5.0 // indirect
+	github.com/moby/sys/sequential v0.5.0 // indirect
+	github.com/moby/term v0.0.0-20221128092401-c43b287e0e0f // indirect
+	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
+	github.com/modern-go/reflect2 v1.0.2 // indirect
+	github.com/morikuni/aec v1.0.0 // indirect
+	github.com/opencontainers/go-digest v1.0.0 // indirect
+	github.com/opencontainers/image-spec v1.1.0-rc2 // indirect
+	github.com/opencontainers/runc v1.1.5 // indirect
+	github.com/pkg/errors v0.9.1 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/sirupsen/logrus v1.9.0 // indirect
+	github.com/spf13/pflag v1.0.5 // indirect
+	golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4 // indirect
+	golang.org/x/net v0.7.0 // indirect
+	golang.org/x/oauth2 v0.0.0-20210819190943-2bc19b11175f // indirect
+	golang.org/x/sync v0.1.0 // indirect
+	golang.org/x/sys v0.7.0 // indirect
+	golang.org/x/term v0.5.0 // indirect
+	golang.org/x/text v0.7.0 // indirect
+	golang.org/x/time v0.0.0-20220210224613-90d013bbcef8 // indirect
+	golang.org/x/tools v0.1.12 // indirect
+	google.golang.org/appengine v1.6.7 // indirect
+	google.golang.org/genproto v0.0.0-20220617124728-180714bec0ad // indirect
+	google.golang.org/grpc v1.47.0 // indirect
+	google.golang.org/protobuf v1.28.0 // indirect
+	gopkg.in/inf.v0 v0.9.1 // indirect
+	gopkg.in/yaml.v2 v2.4.0 // indirect
+	gotest.tools/v3 v3.4.0 // indirect
+	k8s.io/api v0.22.5 // indirect
+	k8s.io/klog/v2 v2.30.0 // indirect
+	k8s.io/utils v0.0.0-20210930125809-cb0fa318a74b // indirect
+	sigs.k8s.io/structured-merge-diff/v4 v4.1.2 // indirect
+	sigs.k8s.io/yaml v1.2.0 // indirect
+)
+
+replace github.com/testcontainers/testcontainers-go => ../..