Upgrading k6, applying linting, and adding integration test

Fixes #34 and relates to #5 Signed-off-by: Paul Balogh <[email protected]>
grafana · Apr 6, 2023 · 420500a · 420500a
1 parent 6f1ecf2
commit 420500a
Show file tree

Hide file tree

Showing 11 changed files with 356 additions and 248 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -11,6 +11,10 @@ on:
       - v*
   pull_request:
 
+defaults:
+  run:
+    shell: bash
+
 jobs:
   build-with-xk6:
     runs-on: ubuntu-latest
@@ -20,24 +24,52 @@ jobs:
       - name: Install Go
         uses: actions/setup-go@v3
         with:
-          go-version: 1.17.x
-      - name: Retrieve get module name
-        run: |
-          echo "::set-output name=Module::$(go list -m)"
-        id: module-name
-      - name: Verify builds with xk6
+          go-version: 1.20.x
+      - name: Check build
         run: |
-          go install go.k6.io/xk6/cmd/xk6@latest
-          xk6 build --with ${{ steps.module-name.outputs.Module }}=.
+          go version
+          pwd && ls -l
+          
+          go install go.k6.io/xk6/cmd/xk6@master
+          MODULE_NAME=`go list -m`
+          
+          GOPRIVATE="go.k6.io/k6" xk6 build \
+            --output ./k6ext \
+            --with $MODULE_NAME="."
+          ./k6ext version
 
-  run-unit-tests:
-    runs-on: ubuntu-latest
+  test-go-versions:
+    strategy:
+      fail-fast: false
+      matrix:
+        go-version: [1.19.x, 1.20.x, tip]
+        platform: [ubuntu-latest, windows-latest]
+    runs-on: ${{ matrix.platform }}
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
-      - name: Install Go
+      - name: Install Go ${{ matrix.go-version }}
+        if: matrix.go-version != 'tip'
         uses: actions/setup-go@v3
         with:
-          go-version: 1.17.x
-      - name: Run unit tests
-        run: go test -v -cover -race ./...
+          go-version: ${{ matrix.go-version }}
+      - name: Install Go stable
+        if: matrix.go-version == 'tip'
+        uses: actions/setup-go@v3
+        with:
+          go-version: 1.x
+      - name: Install Go tip
+        shell: bash
+        if: matrix.go-version == 'tip'
+        run: |
+          go install golang.org/dl/gotip@latest
+          gotip download
+          echo "GOROOT=$HOME/sdk/gotip" >> "$GITHUB_ENV"
+          echo "GOPATH=$HOME/go" >> "$GITHUB_ENV"
+          echo "$HOME/go/bin" >> "$GITHUB_PATH"
+          echo "$HOME/sdk/gotip/bin" >> "$GITHUB_PATH"
+      - name: Run tests
+        run: |
+          which go
+          go version
+          go test -race -timeout 800s ./...
diff --git a/.github/workflows/linter.yml b/.github/workflows/linter.yml
@@ -11,29 +11,30 @@ jobs:
       - name: Install Go
         uses: actions/setup-go@v3
         with:
-          go-version: 1.17.x
+          go-version: 1.20.x
       - name: Check module dependencies
         run: |
           go version
           test -z "$(go mod tidy && git status go.* --porcelain)"
           go mod verify
 
-# TODO: Enable linting and address linter errors, https://github.com/grafana/xk6-sql/issues/5
-#  run-golangci:
-#    runs-on: ubuntu-latest
-#    steps:
-#      - name: Checkout code
-#        uses: actions/checkout@v3
-#      - name: Install Go
-#        uses: actions/setup-go@v3
-#        with:
-#          go-version: 1.17.x
-#      - name: Retrieve golangci-lint version
-#        run: |
-#          echo "::set-output name=Version::$(head -n 1 "${GITHUB_WORKSPACE}/.golangci.yml" | tr -d '# ')"
-#        id: version
-#      - name: golangci-lint
-#        uses: golangci/golangci-lint-action@v3
-#        with:
-#          # Required: the version of golangci-lint is required and must be specified without patch version: we always use the latest patch version.
-#          version: ${{ steps.version.outputs.Version }}
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Install Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: 1.20.x
+      - name: Retrieve golangci-lint version
+        run: |
+          echo "Version=$(head -n 1 "${GITHUB_WORKSPACE}/.golangci.yml" | tr -d '# ')" >> $GITHUB_OUTPUT
+        id: version
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v3
+        with:
+          version: ${{ steps.version.outputs.Version }}
+          only-new-issues: true
diff --git a/.gitignore b/.gitignore
@@ -18,3 +18,5 @@ k6
 
 .idea/
 .DS_Store
+
+*test.db
diff --git a/.golangci.yml b/.golangci.yml
@@ -1,4 +1,4 @@
-# v1.43.0
+# v1.52.2
 # Please don't remove the first line. It is used in CI to determine the golangci version
 run:
   deadline: 5m
@@ -21,55 +21,109 @@ issues:
       linters:
         - cyclop
         - dupl
-        - funlen
-        - gochecknoglobals
         - gocognit
+        - funlen
         - lll
     - linters:
         - paralleltest # false positive: https://github.com/kunwardeep/paralleltest/issues/8.
       text: "does not use range value in test Run"
+    - linters:
+        - forbidigo
+      text: 'use of `os\.(SyscallError|Signal|Interrupt)` forbidden'
 
 linters-settings:
+  nolintlint:
+    # Disable to ensure that nolint directives don't have a leading space. Default is true.
+    allow-leading-space: false
+  exhaustive:
+    default-signifies-exhaustive: true
+  govet:
+    check-shadowing: true
   cyclop:
     max-complexity: 25
+  maligned:
+    suggest-new: true
   dupl:
     threshold: 150
-  exhaustive:
-    default-signifies-exhaustive: true
-  funlen:
-    lines: 80
-    statements: 60
   goconst:
     min-len: 10
     min-occurrences: 4
-  govet:
-    check-shadowing: true
-  maligned:
-    suggest-new: true
+  funlen:
+    lines: 80
+    statements: 60
+  forbidigo:
+    forbid:
+      - '^(fmt\\.Print(|f|ln)|print|println)$'
+      # Forbid everything in os, except os.Signal and os.SyscalError
+      - '^os\.(.*)$(# Using anything except Signal and SyscallError from the os package is forbidden )?'
+      # Forbid everything in syscall except the uppercase constants
+      - '^syscall\.[^A-Z_]+$(# Using anything except constants from the syscall package is forbidden )?'
+      - '^logrus\.Logger$'
 
 linters:
-  enable-all: true
-  disable:
-    - exhaustivestruct
-    - gci
-    - gochecknoinits
-    - gocyclo # replaced by cyclop since it also calculates the package complexity
-    - godot
-    - godox
-    - goerr113 # most of the errors here are meant for humans
-    - goheader
-    - golint # this linter is deprecated
-    - gomnd
-    - gomodguard
-    - interfacer # deprecated
-    - ireturn
-    - maligned # replaced by govet 'fieldalignment'
-    - nlreturn
-    - scopelint # deprecated, replaced by exportloopref
-    - tagliatelle
-    - testpackage
-    - thelper
-    - varnamelen # disabled before the final decision in (https://github.com/grafana/k6/pull/2323)
-    - wrapcheck # a little bit too much for k6, maybe after https://github.com/tomarrell/wrapcheck/issues/2 is fixed
-    - wsl
+  disable-all: true
+  enable:
+    - asasalint
+    - asciicheck
+    - bidichk
+    - bodyclose
+    - contextcheck
+    - cyclop
+    - depguard
+    - dogsled
+    - dupl
+    - durationcheck
+    - errcheck
+    - errchkjson
+    - errname
+    - errorlint
+    - exhaustive
+    - exportloopref
+    - forbidigo
+    - forcetypeassert
+    - funlen
+    - gocheckcompilerdirectives
+    - gochecknoglobals
+    - gocognit
+    - goconst
+    - gocritic
+    - gofmt
+    - gofumpt
+    - goimports
+    - gomoddirectives
+    - goprintffuncname
+    - gosec
+    - gosimple
+    - govet
+    - importas
+    - ineffassign
+    - lll
+    - makezero
+    - misspell
+    - nakedret
+    - nestif
+    - nilerr
+    - nilnil
+    - noctx
+    - nolintlint
+    - nosprintfhostport
+    - paralleltest
+    - prealloc
+    - predeclared
+    - promlinter
+    - revive
+    - reassign
+    - rowserrcheck
+    - sqlclosecheck
+    - staticcheck
+    - stylecheck
+    - tenv
+    - tparallel
+    - typecheck
+    - unconvert
+    - unparam
+    - unused
+    - usestdlibvars
+    - wastedassign
+    - whitespace
   fast: false
diff --git a/Dockerfile b/Dockerfile
@@ -1,5 +1,5 @@
 # Multi-stage build to generate custom k6 with extension
-FROM golang:1.18-alpine as builder
+FROM golang:1.20-alpine as builder
 WORKDIR $GOPATH/src/go.k6.io/k6
 ADD . .
 RUN apk --no-cache add build-base git
@@ -9,7 +9,7 @@ RUN CGO_ENABLED=1 xk6 build \
     --output /tmp/k6
 
 # Create image for running your customized k6
-FROM alpine:3.15
+FROM alpine:3.17
 RUN apk add --no-cache ca-certificates \
     && adduser -D -u 12345 -g 12345 k6
 COPY --from=builder /tmp/k6 /usr/bin/k6

diff --git a/Makefile b/Makefile
@@ -15,6 +15,7 @@ help:
 ## clean: Removes any previously created build artifacts.
 clean:
 	rm -f ./k6
+	rm -f ./intg_test.db
 
 ## build: Builds a custom 'k6' with the local extension. 
 build:

diff --git a/docker-run.sh b/docker-run.sh
@@ -2,13 +2,13 @@
 
 set -e
 
-if [ $# -ne 1 ]; then
-    echo "Usage: ./docker-run.sh <SCRIPT_NAME>"
+if [ $# -lt 1 ]; then
+    echo "Usage: ./docker-run.sh <SCRIPT_NAME> [additional k6 args]"
     exit 1
 fi
 
 # By default, we're assuming you created the extended k6 image as "grafana/k6-for-sql:latest".
 # If not, override the name on the command-line with `IMAGE_NAME=...`.
 IMAGE_NAME=${IMAGE_NAME:="grafana/k6-for-sql:latest"}
 
-docker run -v $PWD:/scripts -it --rm $IMAGE_NAME run /scripts/$1
+docker run -v $PWD:/scripts -it --rm $IMAGE_NAME run /scripts/$1 ${@:2}
diff --git a/go.mod b/go.mod
@@ -1,35 +1,41 @@
 module github.com/grafana/xk6-sql
 
-go 1.17
+go 1.19
 
 require (
 	github.com/denisenkom/go-mssqldb v0.12.0
 	github.com/go-sql-driver/mysql v1.6.0
 	github.com/lib/pq v1.10.4
 	github.com/mattn/go-sqlite3 v1.14.12
-	go.k6.io/k6 v0.38.0
+	github.com/sirupsen/logrus v1.9.0
+	github.com/stretchr/testify v1.8.0
+	go.k6.io/k6 v0.43.1
 )
 
-require github.com/dop251/goja v0.0.0-20220405120441-9037c2b61cbf // indirect
+require github.com/dop251/goja v0.0.0-20230128084908-78b980256d04
 
 require (
-	github.com/dlclark/regexp2 v1.4.1-0.20201116162257-a2a8dda75c91 // indirect
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/dlclark/regexp2 v1.7.0 // indirect
 	github.com/fatih/color v1.13.0 // indirect
 	github.com/go-sourcemap/sourcemap v2.1.4-0.20211119122758-180fcef48034+incompatible // indirect
 	github.com/golang-sql/civil v0.0.0-20190719163853-cb61b32ac6fe // indirect
 	github.com/golang-sql/sqlexp v0.0.0-20170517235910-f1bb20e5a188 // indirect
+	github.com/josharian/intern v1.0.0 // indirect
 	github.com/mailru/easyjson v0.7.7 // indirect
-	github.com/mattn/go-colorable v0.1.12 // indirect
-	github.com/mattn/go-isatty v0.0.14 // indirect
-	github.com/nxadm/tail v1.4.8 // indirect
+	github.com/mattn/go-colorable v0.1.13 // indirect
+	github.com/mattn/go-isatty v0.0.16 // indirect
+	github.com/mstoykov/atlas v0.0.0-20220808085829-90340e9998bd // indirect
+	github.com/onsi/ginkgo v1.16.5 // indirect
+	github.com/onsi/gomega v1.27.6 // indirect
 	github.com/oxtoacart/bpool v0.0.0-20190530202638-03653db5a59c // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/serenize/snaker v0.0.0-20201027110005-a7ad2135616e // indirect
-	github.com/sirupsen/logrus v1.8.1 // indirect
 	github.com/spf13/afero v1.1.2 // indirect
-	golang.org/x/crypto v0.0.0-20220315160706-3147a52a75dd // indirect
-	golang.org/x/sys v0.0.0-20211216021012-1d35b9e2eb4e // indirect
-	golang.org/x/text v0.3.7 // indirect
-	golang.org/x/time v0.0.0-20220224211638-0e9765cccd65 // indirect
-	golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect
+	golang.org/x/crypto v0.0.0-20220926161630-eccd6366d1be // indirect
+	golang.org/x/sys v0.6.0 // indirect
+	golang.org/x/text v0.8.0 // indirect
+	golang.org/x/time v0.0.0-20220922220347-f3bd1da661af // indirect
 	gopkg.in/guregu/null.v3 v3.3.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
 )