feat(gf/gen/pbentity): add a TablesEx configuration to exclude the specified table names (#4060)

.github/workflows/ci-main.sh

@@ -1,8 +1,5 @@
 #!/usr/bin/env bash
 
-# Define the latest Go version requirement
-LATEST_GO_VERSION="1.23"
-
 coverage=$1
 
 # find all path that contains go.mod.

.github/workflows/ci-main.yml

@@ -28,10 +28,21 @@ concurrency:
 
 env:
   TZ: "Asia/Shanghai"
-
+  # for unit testing cases of some components that only execute on the latest go version.
+  LATEST_GO_VERSION: "1.23"
 
 jobs:
   code-test:
+    strategy:
+      matrix:
+        # 🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥
+        # When adding new go version to the list, make sure:
+        # 1. Update the `LATEST_GO_VERSION` env variable.
+        # 2. Update the `Report Coverage` action.
+        # 🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥
+        go-version: [ "1.20", "1.21", "1.22", "1.23" ]
+        goarch: [ "386", "amd64" ]
+
     runs-on: ubuntu-20.04
 
     # Service containers to run with `code-test`
@@ -185,11 +196,6 @@ jobs:
         ports:
           - 2181:2181
 
-    strategy:
-      matrix:
-        go-version: [ "1.20", "1.21", "1.22", "1.23" ]
-        goarch: [ "386", "amd64" ]
-
     steps:
     # TODO: szenius/set-timezone update to node16
     # sudo ln -sf /usr/share/zoneinfo/Asia/Shanghai /etc/localtime
@@ -256,7 +262,8 @@ jobs:
 
     - name: Report Coverage
       uses: codecov/codecov-action@v4
-      if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
+      # Only report coverage on the latest go version and amd64 arch
+      if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' && matrix.go-version == '1.23' && matrix.goarch == 'amd64' }}
       with:
         flags: go-${{ matrix.go-version }}-${{ matrix.goarch }}
         token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/ci-sub.yml

@@ -29,17 +29,22 @@ concurrency:
 
 env:
   TZ: "Asia/Shanghai"
-
+  # for unit testing cases of some components that only execute on the latest go version.
+  LATEST_GO_VERSION: "1.23"
 
 jobs:
   code-test:
-    runs-on: ubuntu-latest
-
     strategy:
       matrix:
+        # 🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥
+        # When adding new go version to the list, make sure:
+        # 1. Update the `LATEST_GO_VERSION` env variable.
+        # 🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥
         go-version: [ "1.20", "1.21", "1.22", "1.23" ]
         goarch: [ "386", "amd64" ]
 
+    runs-on: ubuntu-latest
+
     steps:
     - name: Setup Timezone
       uses: szenius/set-timezone@v2.0

cmd/gf/go.work

@@ -16,6 +16,5 @@ replace (
 	github.com/gogf/gf/contrib/drivers/oracle/v2 => ../../contrib/drivers/oracle
 	github.com/gogf/gf/contrib/drivers/pgsql/v2 => ../../contrib/drivers/pgsql
 	github.com/gogf/gf/contrib/drivers/sqlite/v2 => ../../contrib/drivers/sqlite
-	github.com/gogf/gf/contrib/drivers/dm/v2 => ../../contrib/drivers/dm
 	github.com/gogf/gf/v2 => ../../
 )

cmd/gf/internal/cmd/cmd_z_unit_gen_pbentity_test.go

@@ -286,3 +286,84 @@ func Test_Issue_3685(t *testing.T) {
 		}
 	})
 }
+
+// https://github.com/gogf/gf/issues/3955
+func Test_Issue_3955(t *testing.T) {
+	gtest.C(t, func(t *gtest.T) {
+		var (
+			err        error
+			db         = testDB
+			table1     = "table_user_a"
+			table2     = "table_user_b"
+			sqlContent = fmt.Sprintf(
+				gtest.DataContent(`genpbentity`, `user.tpl.sql`),
+				table1,
+			)
+			sqlContent2 = fmt.Sprintf(
+				gtest.DataContent(`genpbentity`, `user.tpl.sql`),
+				table2,
+			)
+		)
+		dropTableWithDb(db, table1)
+		dropTableWithDb(db, table2)
+
+		array := gstr.SplitAndTrim(sqlContent, ";")
+		for _, v := range array {
+			if _, err = db.Exec(ctx, v); err != nil {
+				t.AssertNil(err)
+			}
+		}
+
+		array = gstr.SplitAndTrim(sqlContent2, ";")
+		for _, v := range array {
+			if _, err = db.Exec(ctx, v); err != nil {
+				t.AssertNil(err)
+			}
+		}
+
+		defer dropTableWithDb(db, table1)
+		defer dropTableWithDb(db, table2)
+
+		var (
+			path = gfile.Temp(guid.S())
+			in   = genpbentity.CGenPbEntityInput{
+				Path:              path,
+				Package:           "unittest",
+				Link:              link,
+				Tables:            "",
+				Prefix:            "",
+				RemovePrefix:      "",
+				RemoveFieldPrefix: "",
+				NameCase:          "",
+				JsonCase:          "",
+				Option:            "",
+				TablesEx:          "table_user_a",
+			}
+		)
+		err = gutil.FillStructWithDefault(&in)
+		t.AssertNil(err)
+
+		err = gfile.Mkdir(path)
+		t.AssertNil(err)
+		defer gfile.Remove(path)
+
+		_, err = genpbentity.CGenPbEntity{}.PbEntity(ctx, in)
+		t.AssertNil(err)
+
+		files, err := gfile.ScanDir(path, "*.proto", false)
+		t.AssertNil(err)
+
+		t.AssertEQ(len(files), 1)
+
+		t.Assert(files, []string{
+			path + filepath.FromSlash("/table_user_b.proto"),
+		})
+
+		expectFiles := []string{
+			path + filepath.FromSlash("/table_user_b.proto"),
+		}
+		for i := range files {
+			t.Assert(gfile.GetContents(files[i]), gfile.GetContents(expectFiles[i]))
+		}
+	})
+}

cmd/gf/internal/cmd/genpbentity/genpbentity.go

@@ -10,6 +10,7 @@ import (
 	"bytes"
 	"context"
 	"fmt"
+	"github.com/gogf/gf/v2/container/gset"
 	"path/filepath"
 	"regexp"
 	"strings"
@@ -43,6 +44,7 @@ type (
 		Prefix            string `name:"prefix"            short:"f"  brief:"{CGenPbEntityBriefPrefix}"`
 		RemovePrefix      string `name:"removePrefix"      short:"r"  brief:"{CGenPbEntityBriefRemovePrefix}"`
 		RemoveFieldPrefix string `name:"removeFieldPrefix" short:"rf" brief:"{CGenPbEntityBriefRemoveFieldPrefix}"`
+		TablesEx          string `name:"tablesEx"          short:"x"  brief:"{CGenDaoBriefTablesEx}"`
 		NameCase          string `name:"nameCase"          short:"n"  brief:"{CGenPbEntityBriefNameCase}" d:"Camel"`
 		JsonCase          string `name:"jsonCase"          short:"j"  brief:"{CGenPbEntityBriefJsonCase}" d:"none"`
 		Option            string `name:"option"            short:"o"  brief:"{CGenPbEntityBriefOption}"`
@@ -115,6 +117,7 @@ CONFIGURATION SUPPORT
 	CGenPbEntityBriefTables            = `generate models only for given tables, multiple table names separated with ','`
 	CGenPbEntityBriefPrefix            = `add specified prefix for all entity names and entity proto files`
 	CGenPbEntityBriefRemovePrefix      = `remove specified prefix of the table, multiple prefix separated with ','`
+	CGenPbEntityBriefTablesEx          = `generate all models exclude the specified tables, multiple prefix separated with ','`
 	CGenPbEntityBriefRemoveFieldPrefix = `remove specified prefix of the field, multiple prefix separated with ','`
 	CGenPbEntityBriefOption            = `extra protobuf options`
 	CGenPbEntityBriefGroup             = `
@@ -240,6 +243,7 @@ func init() {
 		`CGenPbEntityBriefTables`:            CGenPbEntityBriefTables,
 		`CGenPbEntityBriefPrefix`:            CGenPbEntityBriefPrefix,
 		`CGenPbEntityBriefRemovePrefix`:      CGenPbEntityBriefRemovePrefix,
+		`CGenPbEntityBriefTablesEx`:          CGenPbEntityBriefTablesEx,
 		`CGenPbEntityBriefRemoveFieldPrefix`: CGenPbEntityBriefRemoveFieldPrefix,
 		`CGenPbEntityBriefGroup`:             CGenPbEntityBriefGroup,
 		`CGenPbEntityBriefNameCase`:          CGenPbEntityBriefNameCase,
@@ -290,6 +294,9 @@ func doGenPbEntityForArray(ctx context.Context, index int, in CGenPbEntityInput)
 		in.Package = modName + "/" + defaultPackageSuffix
 	}
 	removePrefixArray := gstr.SplitAndTrim(in.RemovePrefix, ",")
+
+	excludeTables := gset.NewStrSetFrom(gstr.SplitAndTrim(in.TablesEx, ","))
+
 	// It uses user passed database configuration.
 	if in.Link != "" {
 		var (
@@ -331,6 +338,9 @@ func doGenPbEntityForArray(ctx context.Context, index int, in CGenPbEntityInput)
 	}
 
 	for _, tableName := range tableNames {
+		if excludeTables.Contains(tableName) {
+			continue
+		}
 		newTableName := tableName
 		for _, v := range removePrefixArray {
 			newTableName = gstr.TrimLeftStr(newTableName, v, 1)