Merge pull request #317 from ydb-platform/auto-style

auto-format script

Author: asmyasnikov

.github/scripts/check-work-copy-equals-to-committed.sh

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+MESSAGE="$1"
+
+CODE_DIFF="$(git diff)"
+if [ -n "$CODE_DIFF"  ]; then
+  echo "$MESSAGE"
+  echo
+  echo "$CODE_DIFF"
+  exit 1;
+fi

.github/scripts/format-all-go-code.sh

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+
+set -eu
+
+DIR="$1"
+
+cd "$DIR"
+
+export PATH="$(go env GOPATH)/bin:$PATH"
+for FILE in $(find . -name '*.go'); do
+  if [ "YES" == "$(bash ./.github/scripts/is_autogenerated_file.sh "$FILE")" ]; then
+    echo "Skip autogenerated file: $FILE" >&2
+    continue
+  fi
+
+  bash ./.github/scripts/format-go-code.sh "$FILE"
+done

.github/scripts/format-go-code.sh

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+set -eu
+
+FILEPATH="$1"
+
+# https://github.com/rinchsan/gosimports
+gosimports -local github.com/ydb-platform/ydb-go-sdk/v3 -w "$FILEPATH"
+
+# https://github.com/mvdan/gofumpt
+gofumpt -w "$FILEPATH"

.github/scripts/is_autogenerated_file.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+FILEPATH="$1"
+
+grep -q "Code generated by gtrace. DO NOT EDIT." "$FILEPATH" && echo YES && exit 0
+grep -q "Code generated by MockGen. DO NOT EDIT." "$FILEPATH" && echo YES && exit 0
+
+echo NO
+exit 0

.github/workflows/check-codegen.yml

@@ -36,12 +36,5 @@ jobs:
         go generate ./trace
         go generate ./...
 
-    - name: Check generation
-      run: |
-        CODE_DIFF="$(git diff)"
-        if [ -n "$CODE_DIFF"  ]; then
-          echo "code-generation not equal with committed"
-          echo
-          echo "$CODE_DIFF"
-          exit 1;
-        fi
+    - name: Check repository diff
+      run: bash ./.github/scripts/check-work-copy-equals-to-committed.sh "code-generation not equal with committed"

.github/workflows/lint.yml

@@ -21,4 +21,25 @@ jobs:
       - name: golangci-lint
         uses: golangci/golangci-lint-action@v2
         with:
-          version: v1.46.2
+          version: v1.46.2
+  autoformatter:
+    name: autoformat check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: 1.18
+
+      - name: Install utilities
+        run: |
+          go install mvdan.cc/[email protected]
+          go install github.com/rinchsan/gosimports/cmd/[email protected]
+
+      - name: format all files with auto-formatter
+        run: bash ./.github/scripts/format-all-go-code.sh "$PWD"
+
+      - name: Check repository diff
+        run: bash ./.github/scripts/check-work-copy-equals-to-committed.sh "auto-format broken"

balancers/config_test.go

@@ -6,7 +6,6 @@ import (
 	"github.com/stretchr/testify/require"
 
 	balancerConfig "github.com/ydb-platform/ydb-go-sdk/v3/internal/balancer/config"
-
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/conn"
 )
 

config/config.go

@@ -10,10 +10,9 @@ import (
 	"google.golang.org/grpc"
 	grpcCodes "google.golang.org/grpc/codes"
 
-	balancerConfig "github.com/ydb-platform/ydb-go-sdk/v3/internal/balancer/config"
-
 	"github.com/ydb-platform/ydb-go-sdk/v3/balancers"
 	"github.com/ydb-platform/ydb-go-sdk/v3/credentials"
+	balancerConfig "github.com/ydb-platform/ydb-go-sdk/v3/internal/balancer/config"
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/config"
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/meta"
 	builder "github.com/ydb-platform/ydb-go-sdk/v3/internal/xnet"

config/grpc_credentials.go

@@ -4,7 +4,6 @@ import (
 	"crypto/tls"
 
 	"google.golang.org/grpc"
-
 	"google.golang.org/grpc/credentials"
 	"google.golang.org/grpc/credentials/insecure"
 )

connection_e2e_test.go

@@ -11,11 +11,6 @@ import (
 	"testing"
 	"time"
 
-	"google.golang.org/grpc"
-	"google.golang.org/grpc/metadata"
-	"google.golang.org/protobuf/proto"
-	"google.golang.org/protobuf/types/known/durationpb"
-
 	"github.com/ydb-platform/ydb-go-genproto/Ydb_Discovery_V1"
 	"github.com/ydb-platform/ydb-go-genproto/Ydb_Export_V1"
 	"github.com/ydb-platform/ydb-go-genproto/Ydb_Scripting_V1"
@@ -24,6 +19,10 @@ import (
 	"github.com/ydb-platform/ydb-go-genproto/protos/Ydb_Export"
 	"github.com/ydb-platform/ydb-go-genproto/protos/Ydb_Operations"
 	"github.com/ydb-platform/ydb-go-genproto/protos/Ydb_Scripting"
+	"google.golang.org/grpc"
+	"google.golang.org/grpc/metadata"
+	"google.golang.org/protobuf/proto"
+	"google.golang.org/protobuf/types/known/durationpb"
 
 	"github.com/ydb-platform/ydb-go-sdk/v3"
 	"github.com/ydb-platform/ydb-go-sdk/v3/balancers"