-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
lint and check, cleanup idiomatic go issues
- Loading branch information
1 parent
d74041c
commit 97bc4d2
Showing
33 changed files
with
351 additions
and
203 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
// For format details, see https://aka.ms/devcontainer.json. For config options, see the | ||
// README at: https://github.com/devcontainers/templates/tree/main/src/docker-existing-dockerfile | ||
{ | ||
"name": "Existing Dockerfile", | ||
"build": { | ||
// Sets the run context to one level up instead of the .devcontainer folder. | ||
"context": "..", | ||
// Update the 'dockerFile' property if you aren't using the standard 'Dockerfile' filename. | ||
"dockerfile": "../Dockerfile" | ||
}, | ||
"customizations": { | ||
"vscode": { | ||
"extensions": [ | ||
"golang.go" | ||
] | ||
} | ||
} | ||
|
||
// Features to add to the dev container. More info: https://containers.dev/features. | ||
// "features": {}, | ||
|
||
// Use 'forwardPorts' to make a list of ports inside the container available locally. | ||
// "forwardPorts": [], | ||
|
||
// Uncomment the next line to run commands after the container is created. | ||
// "postCreateCommand": "cat /etc/os-release", | ||
|
||
// Configure tool-specific properties. | ||
// "customizations": {}, | ||
|
||
// Uncomment to connect as an existing user other than the container default. More info: https://aka.ms/dev-containers-non-root. | ||
// "remoteUser": "devcontainer" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,11 @@ | ||
.idea | ||
*.sw* | ||
*.terraform | ||
*.terraform* | ||
/bin | ||
/scripts/runLocal | ||
sidecar.db* | ||
*.db* | ||
/sqlite | ||
/sqlite* | ||
go-sidecar |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# To get started with Dependabot version updates, you'll need to specify which | ||
# package ecosystems to update and where the package manifests are located. | ||
# Please see the documentation for more information: | ||
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates | ||
# https://containers.dev/guide/dependabot | ||
|
||
version: 2 | ||
updates: | ||
- package-ecosystem: "devcontainers" | ||
directory: "/" | ||
schedule: | ||
interval: weekly | ||
- package-ecosystem: "docker" | ||
directory: "/" | ||
schedule: | ||
interval: weekly | ||
- package-ecosystem: "go" | ||
directory: "/" | ||
schedule: | ||
interval: weekly |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,3 +8,4 @@ sidecar.db* | |
/*.db* | ||
/sqlite | ||
/sqlite* | ||
go-sidecar |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,82 +1,6 @@ | ||
|
||
run: | ||
timeout: 5m | ||
|
||
linters: | ||
disable-all: true | ||
enable: | ||
- errcheck # checking for unchecked errors, these unchecked errors can be critical bugs in some cases | ||
- govet # reports suspicious constructs, such as Printf calls whose arguments do not align with the format string | ||
- ineffassign # detects when assignments to existing variables are not used | ||
- staticcheck # is a go vet on steroids, applying a ton of static analysis checks | ||
- typecheck # like the front-end of a Go compiler, parses and type-checks Go code | ||
- unused # checks for unused constants, variables, functions and types | ||
## disabled by default | ||
- asasalint # checks for pass []any as any in variadic func(...any) | ||
- asciicheck # checks that your code does not contain non-ASCII identifiers | ||
- bidichk # checks for dangerous unicode character sequences | ||
- bodyclose # checks whether HTTP response body is closed successfully | ||
- canonicalheader # checks whether net/http.Header uses canonical header | ||
- copyloopvar # detects places where loop variables are copied (Go 1.22+) | ||
- dupl # tool for code clone detection | ||
- durationcheck # checks for two durations multiplied together | ||
- errname # checks that sentinel errors are prefixed with the Err and error types are suffixed with the Error | ||
- errorlint # finds code that will cause problems with the error wrapping scheme introduced in Go 1.13 | ||
- fatcontext # detects nested contexts in loops | ||
- gocheckcompilerdirectives # validates go compiler directive comments (//go:) | ||
- gochecknoglobals # checks that no global variables exist | ||
- gochecknoinits # checks that no init functions are present in Go code | ||
- gochecksumtype # checks exhaustiveness on Go "sum types" | ||
- gocognit # computes and checks the cognitive complexity of functions | ||
- goconst # finds repeated strings that could be replaced by a constant | ||
- gocritic # provides diagnostics that check for bugs, performance and style issues | ||
- gocyclo # computes and checks the cyclomatic complexity of functions | ||
- godot # checks if comments end in a period | ||
- goimports # in addition to fixing imports, goimports also formats your code in the same style as gofmt | ||
- gomoddirectives # manages the use of 'replace', 'retract', and 'excludes' directives in go.mod | ||
- gomodguard # allow and block lists linter for direct Go module dependencies. This is different from depguard where there are different block types for example version constraints and module recommendations | ||
- goprintffuncname # checks that printf-like functions are named with f at the end | ||
- gosec # inspects source code for security problems | ||
- intrange # finds places where for loops could make use of an integer range | ||
- loggercheck # checks key value pairs for common logger libraries (kitlog,klog,logr,zap) | ||
- makezero # finds slice declarations with non-zero initial length | ||
- mirror # reports wrong mirror patterns of bytes/strings usage | ||
- mnd # detects magic numbers | ||
- musttag # enforces field tags in (un)marshaled structs | ||
- nakedret # finds naked returns in functions greater than a specified function length | ||
- nilerr # finds the code that returns nil even if it checks that the error is not nil | ||
- nilnil # checks that there is no simultaneous return of nil error and an invalid value | ||
- noctx # finds sending http request without context.Context | ||
- nolintlint # reports ill-formed or insufficient nolint directives | ||
- nonamedreturns # reports all named returns | ||
- nosprintfhostport # checks for misuse of Sprintf to construct a host with port in a URL | ||
- perfsprint # checks that fmt.Sprintf can be replaced with a faster alternative | ||
- predeclared # finds code that shadows one of Go's predeclared identifiers | ||
- promlinter # checks Prometheus metrics naming via promlint | ||
- protogetter # reports direct reads from proto message fields when getters should be used | ||
- reassign # checks that package variables are not reassigned | ||
# - revive # fast, configurable, extensible, flexible, and beautiful linter for Go, drop-in replacement of golint | ||
- rowserrcheck # checks whether Err of rows is checked successfully | ||
- sloglint # ensure consistent code style when using log/slog | ||
- spancheck # checks for mistakes with OpenTelemetry/Census spans | ||
- sqlclosecheck # checks that sql.Rows and sql.Stmt are closed | ||
- stylecheck # is a replacement for golint | ||
- tenv # detects using os.Setenv instead of t.Setenv since Go1.17 | ||
- testableexamples # checks if examples are testable (have an expected output) | ||
- testifylint # checks usage of github.com/stretchr/testify | ||
- tparallel # detects inappropriate usage of t.Parallel() method in your Go test codes | ||
- unconvert # removes unnecessary type conversions | ||
- unparam # reports unused function parameters | ||
- usestdlibvars # detects the possibility to use variables/constants from the Go standard library | ||
- wastedassign # finds wasted assignment statements | ||
- whitespace # detects leading and trailing whitespace | ||
|
||
issues: | ||
exclude-rules: | ||
- source: "(noinspection|TODO)" | ||
linters: [ godot ] | ||
- source: "//noinspection" | ||
linters: [ gocritic ] | ||
|
||
exclude-files: | ||
- ".*_test\\.go" | ||
- govet | ||
- staticcheck | ||
- unused | ||
- errcheck |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,106 @@ | ||
{ | ||
// See https://go.microsoft.com/fwlink/?LinkId=733558 | ||
// for the documentation about the tasks.json format | ||
"version": "2.0.0", | ||
"tasks": [ | ||
{ | ||
"label": "install", | ||
"type": "shell", | ||
"command": "make deps/go", | ||
"options": { | ||
"cwd": "${workspaceFolder}", | ||
}, | ||
"group": { | ||
"kind": "build" | ||
} | ||
}, | ||
{ | ||
"label": "fmt", | ||
"type": "shell", | ||
"command": "gofmt -l .", | ||
"options": { | ||
"cwd": "${workspaceFolder}" | ||
}, | ||
"dependsOn": "install", | ||
"group": { | ||
"kind": "build" | ||
} | ||
}, | ||
{ | ||
"label": "vet", | ||
"type": "shell", | ||
"command": "go vet ./...", | ||
"options": { | ||
"cwd": "${workspaceFolder}" | ||
}, | ||
"dependsOn": "fmtcheck", | ||
"group": { | ||
"kind": "build" | ||
} | ||
}, | ||
{ | ||
"label": "lint", | ||
"type": "shell", | ||
"command": "golangci-lint run -c .golangci.yml", | ||
"options": { | ||
"cwd": "${workspaceFolder}" | ||
}, | ||
"dependsOn": "vet", | ||
"group": { | ||
"kind": "build" | ||
} | ||
}, | ||
{ | ||
"label": "build", | ||
"type": "shell", | ||
"command": "go build ./...", | ||
"options": { | ||
"cwd": "${workspaceFolder}" | ||
}, | ||
"dependsOn": "lint", | ||
"group": { | ||
"kind": "build", | ||
"isDefault": true | ||
} | ||
}, | ||
{ | ||
"label": "clean", | ||
"type": "shell", | ||
"command": "go clean ./...", | ||
"options": { | ||
"cwd": "${workspaceFolder}" | ||
}, | ||
"dependsOn": "build", | ||
"group": { | ||
"kind": "build", | ||
"isDefault": false | ||
} | ||
}, | ||
{ | ||
"label": "test", | ||
"type": "shell", | ||
"command": "go test ./...", | ||
"options": { | ||
"cwd": "${workspaceFolder}" | ||
}, | ||
"dependsOn": "lint", | ||
"group": { | ||
"kind": "test", | ||
"isDefault": true | ||
} | ||
}, | ||
{ | ||
"label": "staticcheck", | ||
"type": "shell", | ||
"command": "staticcheck ./...", | ||
"options": { | ||
"cwd": "${workspaceFolder}" | ||
}, | ||
"dependsOn": "test", | ||
"group": { | ||
"kind": "test", | ||
"isDefault": false | ||
} | ||
}, | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1,31 @@ | ||
FROM golang:1.22-bullseye as build | ||
FROM golang:1.22-bullseye AS build | ||
|
||
RUN apt-get update | ||
RUN apt-get install -y make | ||
|
||
RUN mkdir /build | ||
RUN useradd --create-home -s /bin/bash gobuild | ||
RUN usermod -a -G sudo gobuild | ||
RUN echo '%sudo ALL=(ALL) NOPASSWD:ALL' >> /etc/sudoers | ||
|
||
COPY . /build | ||
|
||
WORKDIR /build | ||
ARG PROJECT=go-sidecar | ||
RUN mkdir -p /workspaces/${PROJECT} | ||
WORKDIR /workspaces/${PROJECT} | ||
COPY --chown=gobuild:gobuild . . | ||
|
||
# system and linux dependencies | ||
RUN make deps-linux | ||
RUN chown -R gobuild:gobuild /go | ||
|
||
RUN make build | ||
|
||
FROM debian:stable-slim as run | ||
# local dependencies | ||
ENV USER=gobuild | ||
ENV GOBIN=/go/bin | ||
ENV PATH=$PATH:${GOBIN} | ||
USER gobuild | ||
|
||
RUN apt-get update | ||
RUN apt-get install -y ca-certificates | ||
RUN git config --global --add safe.directory /workspaces/${PROJECT} | ||
|
||
COPY --from=build /build /build | ||
RUN make yamlfmt | ||
RUN make fmtcheck | ||
RUN make vet | ||
RUN make lint | ||
RUN make test |
Oops, something went wrong.