Merge branch 'main' into kafka-module

* main: chore: always generate the examples including a explicit image (testcontainers#1611) chore: support linting all modules locally (testcontainers#1609)
mdelapenya · Sep 12, 2023 · 7de1787 · 7de1787
2 parents c03bfcc + b25ee5a
commit 7de1787
Show file tree

Hide file tree

Showing 8 changed files with 33 additions and 14 deletions.
diff --git a/commons-test.mk b/commons-test.mk
@@ -1,8 +1,14 @@
+ROOT_DIR:=$(shell dirname $(realpath $(lastword $(MAKEFILE_LIST))))
+
 .PHONY: dependencies-scan
 dependencies-scan:
  @echo ">> Scanning dependencies in $(CURDIR)..."
  go list -json -m all | docker run --rm -i sonatypecommunity/nancy:latest sleuth --skip-update-check
 
+.PHONY: lint
+lint:
+ golangci-lint run --out-format=github-actions --path-prefix=. --verbose -c $(ROOT_DIR)/.golangci.yml --fix
+
 .PHONY: test-%
 test-%:
  @echo "Running $* tests..."

diff --git a/examples/Makefile b/examples/Makefile
@@ -4,6 +4,10 @@ include ../commons-test.mk
 dependencies-scan-examples:
  @find . -type f -name Makefile -execdir make dependencies-scan \;
 
+.PHONY: lint-examples
+lint-examples:
+ @find . -type f -name Makefile -execdir make lint \;
+
 .PHONY: tidy-examples
 tidy-examples:
  @find . -type f -name Makefile -execdir make tools-tidy \;
diff --git a/modulegen/_template/examples_test.go.tmpl b/modulegen/_template/examples_test.go.tmpl
@@ -1,17 +1,18 @@
-{{ $entrypoint := Entrypoint }}{{ $lower := ToLower }}{{ $title := Title }}package {{ $lower }}_test
+{{ $entrypoint := Entrypoint }}{{ $image := Image }}{{ $lower := ToLower }}{{ $title := Title }}package {{ $lower }}_test
 
 import (
  "context"
  "fmt"
 
+ "github.com/testcontainers/testcontainers-go"
  "github.com/testcontainers/testcontainers-go/modules/{{ $lower }}"
 )
 
 func Example{{ $entrypoint }}() {
  // run{{ $title }}Container {
  ctx := context.Background()
 
- {{ $lower }}Container, err := {{ $lower }}.{{ $entrypoint }}(ctx)
+ {{ $lower }}Container, err := {{ $lower }}.{{ $entrypoint }}(ctx, testcontainers.WithImage("{{ $image }}"))
  if err != nil {
  panic(err)
  }

diff --git a/modulegen/_template/module_test.go.tmpl b/modulegen/_template/module_test.go.tmpl
@@ -1,14 +1,16 @@
-{{ $entrypoint := Entrypoint }}{{ $lower := ToLower }}{{ $title := Title }}package {{ $lower }}
+{{ $entrypoint := Entrypoint }}{{ $image := Image }}{{ $lower := ToLower }}{{ $title := Title }}package {{ $lower }}
 
 import (
  "context"
  "testing"
+
+ "github.com/testcontainers/testcontainers-go"
 )
 
 func Test{{ $title }}(t *testing.T) {
  ctx := context.Background()
 
- container, err := {{ $entrypoint }}(ctx)
+ container, err := {{ $entrypoint }}(ctx, testcontainers.WithImage("{{ $image }}"))
  if err != nil {
  t.Fatal(err)
  }

diff --git a/modulegen/internal/module/main.go b/modulegen/internal/module/main.go
@@ -28,6 +28,7 @@ func generateGoFiles(moduleDir string, tcModule context.TestcontainersModule) er
  funcMap := template.FuncMap{
  "Entrypoint": tcModule.Entrypoint,
  "ContainerName": tcModule.ContainerName,
+ "Image": func() string { return tcModule.Image },
  "ParentDir": tcModule.ParentDir,
  "ToLower": tcModule.Lower,
  "Title": tcModule.Title,

diff --git a/modulegen/main_test.go b/modulegen/main_test.go
@@ -430,13 +430,14 @@ func assertExamplesTestContent(t *testing.T, module context.TestcontainersModule
 
  data := sanitiseContent(content)
  assert.Equal(t, data[0], "package "+lower+"_test")
- assert.Equal(t, data[6], "\t\"github.com/testcontainers/testcontainers-go/modules/"+lower+"\"")
- assert.Equal(t, data[9], "func Example"+entrypoint+"() {")
- assert.Equal(t, data[10], "\t// run"+title+"Container {")
- assert.Equal(t, data[13], "\t"+lower+"Container, err := "+lower+"."+entrypoint+"(ctx)")
- assert.Equal(t, data[31], "\tfmt.Println(state.Running)")
- assert.Equal(t, data[33], "\t// Output:")
- assert.Equal(t, data[34], "\t// true")
+ assert.Equal(t, data[6], "\t\"github.com/testcontainers/testcontainers-go\"")
+ assert.Equal(t, data[7], "\t\"github.com/testcontainers/testcontainers-go/modules/"+lower+"\"")
+ assert.Equal(t, data[10], "func Example"+entrypoint+"() {")
+ assert.Equal(t, data[11], "\t// run"+title+"Container {")
+ assert.Equal(t, data[14], "\t"+lower+"Container, err := "+lower+"."+entrypoint+"(ctx, testcontainers.WithImage(\""+module.Image+"\"))")
+ assert.Equal(t, data[32], "\tfmt.Println(state.Running)")
+ assert.Equal(t, data[34], "\t// Output:")
+ assert.Equal(t, data[35], "\t// true")
 }
 
 // assert content module test
@@ -446,8 +447,8 @@ func assertModuleTestContent(t *testing.T, module context.TestcontainersModule,
 
  data := sanitiseContent(content)
  assert.Equal(t, data[0], "package "+module.Lower())
- assert.Equal(t, data[7], "func Test"+module.Title()+"(t *testing.T) {")
- assert.Equal(t, data[10], "\tcontainer, err := "+module.Entrypoint()+"(ctx)")
+ assert.Equal(t, data[9], "func Test"+module.Title()+"(t *testing.T) {")
+ assert.Equal(t, data[12], "\tcontainer, err := "+module.Entrypoint()+"(ctx, testcontainers.WithImage(\""+module.Image+"\"))")
 }
 
 // assert content module

diff --git a/modules/Makefile b/modules/Makefile
@@ -4,6 +4,10 @@ include ../commons-test.mk
 dependencies-scan-modules:
  @find . -type f -name Makefile -execdir make dependencies-scan \;
 
+.PHONY: lint-modules
+lint-modules:
+ @find . -type f -name Makefile -execdir make lint \;
+
 .PHONY: tidy-modules
 tidy-modules:
  @find . -type f -name Makefile -execdir make tools-tidy \;
diff --git a/modules/compose/compose_local.go b/modules/compose/compose_local.go
@@ -138,7 +138,7 @@ func (dc *LocalDockerCompose) applyStrategyToRunningContainer() error {
  containerListOptions := types.ContainerListOptions{Filters: f, All: true}
  containers, err := cli.ContainerList(context.Background(), containerListOptions)
  if err != nil {
- return fmt.Errorf("error %w occured while filtering the service %s: %d by name and published port", err, k.service, k.publishedPort)
+ return fmt.Errorf("error %w occurred while filtering the service %s: %d by name and published port", err, k.service, k.publishedPort)
  }
 
  if len(containers) == 0 {