Merge pull request #729 from ydb-platform/examples-basic-on-ci

asmyasnikov · web-flow · commit 055e78b00d30 · 2023-05-12T17:21:31.000+03:00
ci: run examples/basic on CI
diff --git a/.github/workflows/breaking.yml b/.github/workflows/breaking.yml
@@ -29,19 +29,3 @@ jobs:
           path: changes.txt
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           header: gorelease
-  examples:
-    concurrency:
-      group: examples-${{ github.ref }}
-      cancel-in-progress: true
-    runs-on: ubuntu-latest
-    steps:
-      - name: Install Go
-        uses: actions/setup-go@v3
-        with:
-          go-version: "1.20"
-      - name: Checkout code
-        uses: actions/checkout@v3
-      - name: Build
-        run: |
-          cd examples
-          go build ./...
diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml
@@ -0,0 +1,54 @@
+name: examples
+on:
+  push:
+    branches:
+      - master
+      - release-*
+  pull_request:
+  workflow_dispatch:
+jobs:
+  examples:
+    concurrency:
+      group: examples-${{ github.ref }}-${{ matrix.go-version }}-${{ matrix.ydb-version }}-${{ matrix.driver }}
+      cancel-in-progress: true
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        go-version: [ 1.17.x, 1.18.x, 1.19.x, 1.20.x ]
+        ydb-version: [ 22.5, 23.1 ]
+        driver: [ native, database_sql, gorm ]
+        exclude:
+          - driver: database_sql
+            go-version: 1.17.x
+          - driver: gorm
+            go-version: 1.17.x
+    services:
+      ydb:
+        image: cr.yandex/yc/yandex-docker-local-ydb:${{ matrix.ydb-version }}-slim
+        ports:
+          - 2135:2135
+          - 2136:2136
+          - 8765:8765
+        volumes:
+          - /tmp/ydb_certs:/ydb_certs
+        env:
+          YDB_LOCAL_SURVIVE_RESTART: true
+          YDB_USE_IN_MEMORY_PDISKS: true
+        options: '-h localhost'
+    env:
+      OS: ubuntu-latest
+      GO: ${{ matrix.go-version }}
+      YDB_CONNECTION_STRING: grpc://localhost:2136/local
+      YDB_ANONYMOUS_CREDENTIALS: 1
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Install Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: ${{ matrix.go-version }}
+          cache: true
+      - name: Run examples for ${{ matrix.driver }}
+        working-directory: ./examples/basic/${{ matrix.driver }}
+        run: go run .
diff --git a/examples/basic/database_sql/main.go b/examples/basic/database_sql/main.go
@@ -3,60 +3,40 @@ package main
 import (
 	"context"
 	"database/sql"
-	"flag"
 	"fmt"
 	"os"
+	"path"
 	"time"
 
+	environ "github.com/ydb-platform/ydb-go-sdk-auth-environ"
+
 	"github.com/ydb-platform/ydb-go-sdk/v3"
 	"github.com/ydb-platform/ydb-go-sdk/v3/sugar"
 )
 
-var dsn string
-
-func init() {
-	required := []string{"ydb"}
-	flagSet := flag.NewFlagSet(os.Args[0], flag.ExitOnError)
-	flagSet.Usage = func() {
-		out := flagSet.Output()
-		_, _ = fmt.Fprintf(out, "Usage:\n%s [options]\n", os.Args[0])
-		_, _ = fmt.Fprintf(out, "\nOptions:\n")
-		flagSet.PrintDefaults()
-	}
-	flagSet.StringVar(&dsn,
-		"ydb", "",
-		"YDB connection string",
-	)
-	if err := flagSet.Parse(os.Args[1:]); err != nil {
-		flagSet.Usage()
-		os.Exit(1)
-	}
-	flagSet.Visit(func(f *flag.Flag) {
-		for i, arg := range required {
-			if arg == f.Name {
-				required = append(required[:i], required[i+1:]...)
-			}
-		}
-	})
-	if len(required) > 0 {
-		fmt.Printf("\nSome required options not defined: %v\n\n", required)
-		flagSet.Usage()
-		os.Exit(1)
-	}
-}
-
 func main() {
 	ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
 	defer cancel()
 
-	cc, err := ydb.Open(ctx, dsn)
+	dsn, exists := os.LookupEnv("YDB_CONNECTION_STRING")
+	if !exists {
+		panic("YDB_CONNECTION_STRING environment variable not defined")
+	}
+
+	cc, err := ydb.Open(ctx,
+		dsn,
+		environ.WithEnvironCredentials(ctx),
+	)
 	if err != nil {
 		panic(fmt.Errorf("connect error: %w", err))
 	}
 	defer func() { _ = cc.Close(ctx) }()
 
+	prefix := path.Join(cc.Name(), "database_sql")
+
 	c, err := ydb.Connector(cc,
 		ydb.WithAutoDeclare(),
+		ydb.WithTablePathPrefix(prefix),
 	)
 	if err != nil {
 		panic(err)
@@ -70,7 +50,7 @@ func main() {
 	db.SetMaxIdleConns(50)
 	db.SetConnMaxIdleTime(time.Second)
 
-	err = sugar.RemoveRecursive(ctx, cc, "")
+	err = sugar.RemoveRecursive(ctx, cc, prefix)
 	if err != nil {
 		panic(fmt.Errorf("remove recursive failed: %w", err))
 	}
diff --git a/examples/basic/gorm/main.go b/examples/basic/gorm/main.go
@@ -1,40 +1,40 @@
 package main
 
 import (
-	"errors"
+	"context"
 	"log"
 	"os"
+	"time"
 
 	ydb "github.com/ydb-platform/gorm-driver"
-	"gorm.io/driver/postgres"
-	"gorm.io/driver/sqlite"
+	environ "github.com/ydb-platform/ydb-go-sdk-auth-environ"
 	"gorm.io/gorm"
 	"gorm.io/gorm/clause"
 	"gorm.io/gorm/logger"
 )
 
-//nolint:lll
-func initDB(cfg *gorm.Config) (*gorm.DB, error) {
-	// docker run -it postgres psql -h 127.0.0.1 -p 5432 -U postgres -d postgres
-	// POSTGRES_CONNECTION_STRING="user=postgres password=mysecretpassword dbname=postgres host=127.0.0.1 port=5432 sslmode=disable"
-	if dsn, has := os.LookupEnv("POSTGRES_CONNECTION_STRING"); has {
-		return gorm.Open(postgres.Open(dsn), cfg)
-	}
-	// SQLITE_CONNECTION_STRING=./test.db
-	if dsn, has := os.LookupEnv("SQLITE_CONNECTION_STRING"); has {
-		return gorm.Open(sqlite.Open(dsn), cfg)
-	}
-	if dsn, has := os.LookupEnv("YDB_CONNECTION_STRING"); has {
-		return gorm.Open(ydb.Open(dsn, ydb.WithTablePathPrefix("gorm")), cfg)
-	}
-	return nil, errors.New("cannot initialize DB")
-}
-
 func main() {
+	ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
+	defer cancel()
+
 	// connect
-	db, err := initDB(&gorm.Config{
-		Logger: logger.Default.LogMode(logger.Info),
-	})
+	dsn, exists := os.LookupEnv("YDB_CONNECTION_STRING")
+	if !exists {
+		panic("YDB_CONNECTION_STRING environment variable not defined")
+	}
+
+	db, err := gorm.Open(
+		ydb.Open(
+			dsn,
+			ydb.WithTablePathPrefix("gorm"),
+			ydb.With(
+				environ.WithEnvironCredentials(ctx),
+			),
+		),
+		&gorm.Config{
+			Logger: logger.Default.LogMode(logger.Error),
+		},
+	)
 	if err != nil {
 		panic(err)
 	}
diff --git a/examples/basic/native/main.go b/examples/basic/native/main.go
@@ -2,81 +2,42 @@ package main
 
 import (
 	"context"
-	"flag"
 	"fmt"
 	"os"
 	"path"
+	"time"
 
 	environ "github.com/ydb-platform/ydb-go-sdk-auth-environ"
 
-	ydb "github.com/ydb-platform/ydb-go-sdk/v3"
+	"github.com/ydb-platform/ydb-go-sdk/v3"
 	"github.com/ydb-platform/ydb-go-sdk/v3/sugar"
 )
 
-var (
-	dsn    string
-	prefix string
-)
+func main() {
+	ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
+	defer cancel()
 
-func init() {
-	required := []string{"ydb"}
-	flagSet := flag.NewFlagSet(os.Args[0], flag.ExitOnError)
-	flagSet.Usage = func() {
-		out := flagSet.Output()
-		_, _ = fmt.Fprintf(out, "Usage:\n%s [options]\n", os.Args[0])
-		_, _ = fmt.Fprintf(out, "\nOptions:\n")
-		flagSet.PrintDefaults()
-	}
-	flagSet.StringVar(&dsn,
-		"ydb", "",
-		"YDB connection string",
-	)
-	flagSet.StringVar(&prefix,
-		"prefix", "",
-		"tables prefix",
-	)
-	if err := flagSet.Parse(os.Args[1:]); err != nil {
-		flagSet.Usage()
-		os.Exit(1)
+	dsn, exists := os.LookupEnv("YDB_CONNECTION_STRING")
+	if !exists {
+		panic("YDB_CONNECTION_STRING environment variable not defined")
 	}
-	flagSet.Visit(func(f *flag.Flag) {
-		for i, arg := range required {
-			if arg == f.Name {
-				required = append(required[:i], required[i+1:]...)
-			}
-		}
-	})
-	if len(required) > 0 {
-		fmt.Printf("\nSome required options not defined: %v\n\n", required)
-		flagSet.Usage()
-		os.Exit(1)
-	}
-}
 
-func main() {
-	ctx, cancel := context.WithCancel(context.Background())
-	defer cancel()
-	opts := []ydb.Option{
+	db, err := ydb.Open(ctx,
+		dsn,
 		environ.WithEnvironCredentials(ctx),
-	}
-	db, err := ydb.Open(ctx, dsn, opts...)
+	)
 	if err != nil {
 		panic(fmt.Errorf("connect error: %w", err))
 	}
 	defer func() { _ = db.Close(ctx) }()
 
-	prefix = path.Join(db.Name(), prefix)
+	prefix := path.Join(db.Name(), "native")
 
 	err = sugar.RemoveRecursive(ctx, db, prefix)
 	if err != nil {
 		panic(err)
 	}
 
-	err = sugar.MakeRecursive(ctx, db, prefix)
-	if err != nil {
-		panic(err)
-	}
-
 	err = describeTableOptions(ctx, db.Table())
 	if err != nil {
 		panic(fmt.Errorf("describe table options error: %w", err))
@@ -87,9 +48,7 @@ func main() {
 		panic(fmt.Errorf("create tables error: %w", err))
 	}
 
-	err = describeTable(ctx, db.Table(), path.Join(
-		prefix, "series",
-	))
+	err = describeTable(ctx, db.Table(), path.Join(prefix, "series"))
 	if err != nil {
 		panic(fmt.Errorf("describe table error: %w", err))
 	}
@@ -109,9 +68,7 @@ func main() {
 		panic(fmt.Errorf("scan query select error: %w", err))
 	}
 
-	err = readTable(ctx, db.Table(), path.Join(
-		prefix, "series",
-	))
+	err = readTable(ctx, db.Table(), path.Join(prefix, "series"))
 	if err != nil {
 		panic(fmt.Errorf("read table error: %w", err))
 	}
diff --git a/examples/go.mod b/examples/go.mod
@@ -14,8 +14,6 @@ require (
 	github.com/ydb-platform/ydb-go-sdk/v3 v3.44.0
 	github.com/ydb-platform/ydb-go-yc v0.10.1
 	google.golang.org/genproto v0.0.0-20220822174746-9e6da59bd2fc
-	gorm.io/driver/postgres v1.4.6
-	gorm.io/driver/sqlite v1.4.4
 	gorm.io/gorm v1.24.5
 )
 
@@ -25,15 +23,11 @@ require (
 	github.com/golang-jwt/jwt v3.2.2+incompatible // indirect
 	github.com/golang-jwt/jwt/v4 v4.4.2 // indirect
 	github.com/golang/protobuf v1.5.2 // indirect
-	github.com/jackc/pgpassfile v1.0.0 // indirect
-	github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a // indirect
-	github.com/jackc/pgx/v5 v5.2.0 // indirect
 	github.com/jinzhu/inflection v1.0.0 // indirect
 	github.com/jinzhu/now v1.1.5 // indirect
 	github.com/jonboulle/clockwork v0.4.0 // indirect
 	github.com/mattn/go-colorable v0.1.13 // indirect
 	github.com/mattn/go-isatty v0.0.16 // indirect
-	github.com/mattn/go-sqlite3 v1.14.15 // indirect
 	github.com/matttproud/golang_protobuf_extensions v1.0.1 // indirect
 	github.com/prometheus/client_model v0.2.0 // indirect
 	github.com/prometheus/common v0.37.0 // indirect
@@ -42,7 +36,6 @@ require (
 	github.com/ydb-platform/ydb-go-genproto v0.0.0-20221215182650-986f9d10542f // indirect
 	github.com/ydb-platform/ydb-go-sdk-metrics v0.16.3 // indirect
 	github.com/ydb-platform/ydb-go-yc-metadata v0.5.4 // indirect
-	golang.org/x/crypto v0.4.0 // indirect
 	golang.org/x/net v0.7.0 // indirect
 	golang.org/x/sync v0.0.0-20220923202941-7f9b1623fab7 // indirect
 	golang.org/x/sys v0.5.0 // indirect
diff --git a/examples/go.sum b/examples/go.sum
