Merge branch 'main' into license-checker

Author: dmihalcik-virtru

.github/dependabot.yml

@@ -0,0 +1,15 @@
+# dependabot.yml
+#
+# Documentation:
+#   https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: monthly
+  - package-ecosystem: gomod
+    directory: /
+    schedule:
+      interval: weekly

.github/workflows/go-checks.yaml

@@ -18,14 +18,8 @@ jobs:
         uses: golangci/golangci-lint-action@3a919529898de77ec3da873e3063ca4b10e7f5cc
         with:
           version: v1.55
-  vulncheck:
-    name: vulncheck
-    runs-on: ubuntu-22.04
-    steps:
-      - name: govluncheck
-        uses: golang/govulncheck-action@7da72f730e37eeaad891fcff0a532d27ed737cd4
-        with:
-          go-version-file: 'go.mod'
+          # Optional: golangci-lint command line arguments.
+          args: --timeout=10m 
   unit:
     name: unit tests
     runs-on: ubuntu-22.04
@@ -47,7 +41,7 @@ jobs:
           go-version: '1.21'
           cache: false
       - name: Integration Tests with the Go CLI
-        run: go test ./tests -race
+        run: go test ./integration -race
   license:
     name: license check
     runs-on: ubuntu-22.04
@@ -60,4 +54,4 @@ jobs:
       - name: install go-licenses
         run: go install github.com/google/go-licenses@5348b744d0983d85713295ea08a20cca1654a45e
       - name: check licenses
-        run: go-licenses check --disallowed_types=forbidden --include_tests ./...
+        run: go-licenses check --disallowed_types=forbidden --include_tests ./...

.github/workflows/nightly-check.yaml

@@ -0,0 +1,15 @@
+name: "Nightly Checks"
+
+on:
+  schedule:
+    - cron: '0 0 * * *'
+
+jobs:
+  vulncheck:
+    name: vulncheck
+    runs-on: ubuntu-22.04
+    steps:
+      - name: govluncheck
+        uses: golang/govulncheck-action@7da72f730e37eeaad891fcff0a532d27ed737cd4
+        with:
+          go-version-file: 'go.mod'

.github/workflows/proto-checks.yaml

@@ -6,7 +6,7 @@ on:
       - main
 jobs:
   buflint:
-    name: lint
+    name: Buf Lint
     runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11
@@ -27,4 +27,4 @@ jobs:
       - uses: bufbuild/buf-breaking-action@a074e988ee34efcd4927079e79c611f428354c01
         with:
           input: proto
-          against: 'https://github.com/opentdf/opentdf-v2-poc.git#branch=main'
+          against: 'https://github.com/opentdf/opentdf-v2-poc.git#branch=main,subdir=proto'

.gitignore

@@ -18,8 +18,14 @@
 # vendor/
 
 # Go workspace file
-go.work
+#go.work
 
 tmp/
 .DS_Store
-__pycache__
+__pycache__
+
+# GoLand IDE
+.idea/
+
+opentdf.yaml
+.vscode/settings.json

.golangci.yaml

@@ -0,0 +1,12 @@
+issues:
+  # Show only new issues: if there are unstaged changes or untracked files,
+  # only those changes are analyzed, else only changes in HEAD~ are analyzed.
+  # It's a super-useful option for integration of golangci-lint into existing large codebase.
+  # It's not practical to fix all existing issues at the moment of integration:
+  # much better don't allow issues in new code.
+  #
+  # Default: false
+  new: true
+  # Show only new issues created after git revision `REV`.
+  # Default: ""
+  new-from-rev: HEAD

.golangci.yml

@@ -11,7 +11,9 @@ run:
   # Timeout for analysis, e.g. 30s, 5m.
   # Default: 1m
   timeout: 5m
-
+  skip-files:
+    - ".*\\.pb\\.go"
+    - ".*\\.pb\\.gw.go"
 
 # This file contains only configs which differ from defaults.
 # All possible options can be found here https://github.com/golangci/golangci-lint/blob/master/.golangci.reference.yml
@@ -20,6 +22,10 @@ linters-settings:
     allow:
      - auth
      - error
+     - Row
+     - Rows
+     - Leveler
+     - Writer
   cyclop:
     # The maximal code complexity to report.
     # Default: 10
@@ -42,36 +48,6 @@ linters-settings:
       - switch
       - map
 
-  exhaustruct:
-    # List of regular expressions to exclude struct packages and names from check.
-    # Default: []
-    exclude:
-      # std libs
-      - "^net/http.Client$"
-      - "^net/http.Cookie$"
-      - "^net/http.Request$"
-      - "^net/http.Response$"
-      - "^net/http.Server$"
-      - "^net/http.Transport$"
-      - "^net/url.URL$"
-      - "^os/exec.Cmd$"
-      - "^reflect.StructField$"
-      - "^crypto/tls.Config$"
-      # public libs
-      - "^github.com/Shopify/sarama.Config$"
-      - "^github.com/Shopify/sarama.ProducerMessage$"
-      - "^github.com/mitchellh/mapstructure.DecoderConfig$"
-      - "^github.com/prometheus/client_golang/.+Opts$"
-      - "^github.com/spf13/cobra.Command$"
-      - "^github.com/spf13/cobra.CompletionOptions$"
-      - "^github.com/stretchr/testify/mock.Mock$"
-      - "^github.com/testcontainers/testcontainers-go.+Request$"
-      - "^github.com/testcontainers/testcontainers-go.FromDockerfile$"
-      - "^golang.org/x/tools/go/analysis.Analyzer$"
-      - "^google.golang.org/protobuf/.+Options$"
-      - "^gopkg.in/yaml.v3.Node$"
-      - "^github.com/redis/go-redis/v9.Options$"
-
   funlen:
     # Checks the number of lines in a function.
     # If lower than 0, disable the check.
@@ -172,15 +148,29 @@ linters-settings:
     # database/sql is always checked
     # Default: []
     packages:
-      - github.com/jmoiron/sqlx
+      - github.com/jackc/pgx/v5
 
   tenv:
     # The option `all` will run against whole test files (`_test.go`) regardless of method/function signatures.
     # Otherwise, only methods that take `*testing.T`, `*testing.B`, and `testing.TB` as arguments are checked.
     # Default: false
     all: true
 
-
+  lll:
+    line-length: 120
+  
+  wrapcheck:
+    ignoreSigs:
+      - "status.Error("
+      - ".Errorf("
+      - "errors.New("
+      - "errors.Unwrap("
+      - "errors.Join("
+      - ".Wrap("
+      - ".Wrapf("
+      - ".WithMessage("
+      - ".WithMessagef("
+      - ".WithStack("
 linters:
   disable-all: true
   enable:
@@ -252,7 +242,6 @@ linters:
 
     ## you may want to enable
     #- decorder # checks declaration order and count of types, constants, variables and functions
-    #- exhaustruct # [highly recommend to enable] checks if all structure fields are initialized
     #- gci # controls golang package import order and makes it always deterministic
     #- ginkgolinter # [if you use ginkgo/gomega] enforces standards of using ginkgo and gomega
     - godox # detects FIXME, TODO and other comment keywords
@@ -325,7 +314,6 @@ issues:
         - gosec
         - noctx
         - wrapcheck
-        - exhaustruct
         - lll
     - text: 'shadow: declaration of "(err)" shadows declaration at'
       linters: [ govet ]

CODEOWNERS

@@ -0,0 +1,3 @@
+# CODEOWNERS
+
+*  @opentdf/developers

LICENSE

@@ -14,6 +14,6 @@ provided that the following conditions are met:
 NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
-EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR 
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
 BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE

Makefile

@@ -18,7 +18,14 @@ V_GOLANGCILINT=golangci-lint run
 
 .PHONY: all lint buf-lint buf-generate golangci-lint test clean build docker-build
 
-all: lint test build
+all: pre-build lint test build
+
+pre-build:
+	@echo "Checking for required tools..."
+	@which buf > /dev/null || (echo "buf not found, please install it from https://docs.buf.build/installation" && exit 1)
+	@which golangci-lint > /dev/null || (echo "golangci-lint not found, please install it from https://golangci-lint.run/usage/install/" && exit 1)
+	@which protoc-gen-doc > /dev/null || (echo "protoc-gen-doc not found, please 'go install' it https://github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc" && exit 1)
+	@golangci-lint --version | grep "version 1.55" > /dev/null || (echo "golangci-lint version must be v1.55" && exit 1)
 
 lint: buf-lint golangci-lint