Restructure (2): Consolidate packages and move to `microcluster` #552

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

roosterfish merged 25 commits into canonical:v3 from roosterfish:consolidate_all_packages

Dec 2, 2025

Makefile

-Original file line number
+Diff line change
@@ Expand Up / @@ -59,12 +59,3 @@ update-gomod: @@
     	# Use the bundled toolchain that meets the minimum go version
     	go get toolchain@none
-    # Update lxd-generate generated database helpers.
-    .PHONY: update-schema
-    update-schema:
-    	go generate ./cluster/...
-    	gofmt -s -w ./cluster/
-    	goimports -w ./cluster/
-    	@echo "Code generation completed"

client/client.go

-Original file line number
+Diff line change
@@ Expand Up / @@ -8,7 +8,7 @@ import ( @@
     	"github.com/gorilla/websocket"
     	"github.com/canonical/microcluster/v3/internal/rest/client"
-    	"github.com/canonical/microcluster/v3/rest/types"
+    	"github.com/canonical/microcluster/v3/microcluster/types"
     )
     // Client is a rest client for the microcluster daemon.
@@ Expand Down @@

cluster/schema.go

This file was deleted.

example/Makefile

-Original file line number
+Diff line change
@@ Expand Up / @@ -50,12 +50,3 @@ endif @@
     update-gomod:
     	go get -u ./...
     	go mod tidy
-    # Update lxd-generate generated database helpers.
-    .PHONY: update-schema
-    update-schema:
-    	go generate ./...
-    	gofmt -s -w ./database/
-    	goimports -w ./database/
-    	@echo "Code generation completed"

example/api/extended.go

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -13,9 +13,9 @@ import (
  
    	"github.com/canonical/microcluster/v3/client"

    	extendedTypes "github.com/canonical/microcluster/v3/example/api/types"

    	extendedClient "github.com/canonical/microcluster/v3/example/client"

    	"github.com/canonical/microcluster/v3/rest"

    	"github.com/canonical/microcluster/v3/rest/response"

    	"github.com/canonical/microcluster/v3/rest/types"

    	"github.com/canonical/microcluster/v3/microcluster/rest"

    	"github.com/canonical/microcluster/v3/microcluster/rest/response"

    	"github.com/canonical/microcluster/v3/microcluster/types"

    	"github.com/canonical/microcluster/v3/state"

    )

example/api/servers.go

-Original file line number
+Diff line change
@@ Expand Up / @@ -3,7 +3,7 @@ package api @@
     import (
     	"github.com/canonical/microcluster/v3/example/api/types"
-    	"github.com/canonical/microcluster/v3/rest"
+    	"github.com/canonical/microcluster/v3/microcluster/rest"
     )
     // Servers represents the list of listeners that the daemon will start
@@ Expand Down @@

example/api/types/extended.go

-Original file line number
+Diff line change
@@ -1,7 +1,7 @@
     // Package types provides shared types and structs.
     package types
-    import "github.com/canonical/microcluster/v3/rest/types"
+    import "github.com/canonical/microcluster/v3/microcluster/types"
     // ExtendedType is an example of an API type usable by MicroCluster but defined by this example project.
     type ExtendedType struct {
@@ Expand Down @@

example/api/types/server.go

-Original file line number
+Diff line change
@@ -1,6 +1,6 @@
     package types
-    import "github.com/canonical/microcluster/v3/rest/types"
+    import "github.com/canonical/microcluster/v3/microcluster/types"
     const (
     	// ExtendedPathPrefix is the path prefix that will be used for the extended endpoints.
@@ Expand Down @@

example/cmd/microctl/cluster_members.go

-Original file line number
+Diff line change
@@ Expand Up / @@ -18,8 +18,8 @@ import ( @@
     	"gopkg.in/yaml.v3"
     	"github.com/canonical/microcluster/v3/client"
-    	"github.com/canonical/microcluster/v3/cluster"
     	"github.com/canonical/microcluster/v3/microcluster"
+    	"github.com/canonical/microcluster/v3/microcluster/types"
     )
     const recoveryConfirmation = `You should only run this command if:
@@ Expand Down Expand Up @@
     		}
     	}
-    	newMembers := []cluster.DqliteMember{}
+    	newMembers := []types.DqliteMember{}
     	err = yaml.Unmarshal(content, &newMembers)
     	if err != nil {
     		return err
@@ Expand Down @@

example/cmd/microd/main.go

-Original file line number
+Diff line change
@@ Expand Up / @@ -14,7 +14,7 @@ import ( @@
     	"github.com/canonical/microcluster/v3/example/database"
     	"github.com/canonical/microcluster/v3/example/version"
     	"github.com/canonical/microcluster/v3/microcluster"
-    	"github.com/canonical/microcluster/v3/rest/types"
+    	"github.com/canonical/microcluster/v3/microcluster/types"
     	"github.com/canonical/microcluster/v3/state"
     )
@@ Expand Down @@

example/database/extended.mapper.go

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -10,47 +10,45 @@ import (
  
    	"github.com/canonical/lxd/shared/api"

    	"github.com/canonical/microcluster/v3/cluster"

    	"github.com/canonical/microcluster/v3/cluster/db"

    	"github.com/canonical/microcluster/v3/microcluster/db"

    )

    var _ = api.ServerEnvironment{}

    var extendedTableObjects = cluster.RegisterStmt(`

    var extendedTableObjects = db.RegisterStmt(`

    SELECT extended_table.id, extended_table.key, extended_table.value

      FROM extended_table

      ORDER BY extended_table.key

    `)

    var extendedTableObjectsByKey = cluster.RegisterStmt(`

    var extendedTableObjectsByKey = db.RegisterStmt(`

    SELECT extended_table.id, extended_table.key, extended_table.value

      FROM extended_table

      WHERE ( extended_table.key = ? )

      ORDER BY extended_table.key

    `)

    var extendedTableID = cluster.RegisterStmt(`

    var extendedTableID = db.RegisterStmt(`

    SELECT extended_table.id FROM extended_table

      WHERE extended_table.key = ?

    `)

    var extendedTableCreate = cluster.RegisterStmt(`

    var extendedTableCreate = db.RegisterStmt(`

    INSERT INTO extended_table (key, value)

      VALUES (?, ?)

    `)

    var extendedTableDeleteByKey = cluster.RegisterStmt(`

    var extendedTableDeleteByKey = db.RegisterStmt(`

    DELETE FROM extended_table WHERE key = ?

    `)

    var extendedTableUpdate = cluster.RegisterStmt(`

    var extendedTableUpdate = db.RegisterStmt(`

    UPDATE extended_table

      SET key = ?, value = ?

     WHERE id = ?

    `)

    // GetExtendedTables returns all available extended_tables.

    // generator: extended_table GetMany

    func GetExtendedTables(ctx context.Context, tx *sql.Tx, filters ...ExtendedTableFilter) ([]ExtendedTable, error) {

    	var err error

    @@ -63,7 +61,7 @@ func GetExtendedTables(ctx context.Context, tx *sql.Tx, filters ...ExtendedTable
  
    	queryParts := [2]string{}

    	if len(filters) == 0 {

    		sqlStmt, err = cluster.Stmt(tx, extendedTableObjects)

    		sqlStmt, err = db.Stmt(tx, extendedTableObjects)

    		if err != nil {

    			return nil, fmt.Errorf("Failed to get \"extendedTableObjects\" prepared statement: %w", err)

    		}

    @@ -73,15 +71,15 @@ func GetExtendedTables(ctx context.Context, tx *sql.Tx, filters ...ExtendedTable
  
    		if filter.Key != nil {

    			args = append(args, []any{filter.Key}...)

    			if len(filters) == 1 {

    				sqlStmt, err = cluster.Stmt(tx, extendedTableObjectsByKey)

    				sqlStmt, err = db.Stmt(tx, extendedTableObjectsByKey)

    				if err != nil {

    					return nil, fmt.Errorf("Failed to get \"extendedTableObjectsByKey\" prepared statement: %w", err)

    				}

    				break

    			}

    			query, err := cluster.StmtString(extendedTableObjectsByKey)

    			query, err := db.StmtString(extendedTableObjectsByKey)

    			if err != nil {

    				return nil, fmt.Errorf("Failed to get \"extendedTableObjects\" prepared statement: %w", err)

    			}

    @@ -130,7 +128,6 @@ func GetExtendedTables(ctx context.Context, tx *sql.Tx, filters ...ExtendedTable
  
    }

    // GetExtendedTable returns the extended_table with the given key.

    // generator: extended_table GetOne

    func GetExtendedTable(ctx context.Context, tx *sql.Tx, key string) (*ExtendedTable, error) {

    	filter := ExtendedTableFilter{}

    	filter.Key = &key

    @@ -151,9 +148,8 @@ func GetExtendedTable(ctx context.Context, tx *sql.Tx, key string) (*ExtendedTab
  
    }

    // GetExtendedTableID return the ID of the extended_table with the given key.

    // generator: extended_table ID

    func GetExtendedTableID(ctx context.Context, tx *sql.Tx, key string) (int64, error) {

    	stmt, err := cluster.Stmt(tx, extendedTableID)

    	stmt, err := db.Stmt(tx, extendedTableID)

    	if err != nil {

    		return -1, fmt.Errorf("Failed to get \"extendedTableID\" prepared statement: %w", err)

    	}

    @@ -173,7 +169,6 @@ func GetExtendedTableID(ctx context.Context, tx *sql.Tx, key string) (int64, err
  
    }

    // ExtendedTableExists checks if a extended_table with the given key exists.

    // generator: extended_table Exists

    func ExtendedTableExists(ctx context.Context, tx *sql.Tx, key string) (bool, error) {

    	_, err := GetExtendedTableID(ctx, tx, key)

    	if err != nil {

    @@ -188,7 +183,6 @@ func ExtendedTableExists(ctx context.Context, tx *sql.Tx, key string) (bool, err
  
    }

    // CreateExtendedTable adds a new extended_table to the database.

    // generator: extended_table Create

    func CreateExtendedTable(ctx context.Context, tx *sql.Tx, object ExtendedTable) (int64, error) {

    	// Check if a extended_table with the same key exists.

    	exists, err := ExtendedTableExists(ctx, tx, object.Key)

    @@ -207,7 +201,7 @@ func CreateExtendedTable(ctx context.Context, tx *sql.Tx, object ExtendedTable)
  
    	args[1] = object.Value

    	// Prepared statement to use.

    	stmt, err := cluster.Stmt(tx, extendedTableCreate)

    	stmt, err := db.Stmt(tx, extendedTableCreate)

    	if err != nil {

    		return -1, fmt.Errorf("Failed to get \"extendedTableCreate\" prepared statement: %w", err)

    	}

    @@ -227,9 +221,8 @@ func CreateExtendedTable(ctx context.Context, tx *sql.Tx, object ExtendedTable)
  
    }

    // DeleteExtendedTable deletes the extended_table matching the given key parameters.

    // generator: extended_table DeleteOne-by-Key

    func DeleteExtendedTable(ctx context.Context, tx *sql.Tx, key string) error {

    	stmt, err := cluster.Stmt(tx, extendedTableDeleteByKey)

    	stmt, err := db.Stmt(tx, extendedTableDeleteByKey)

    	if err != nil {

    		return fmt.Errorf("Failed to get \"extendedTableDeleteByKey\" prepared statement: %w", err)

    	}

    @@ -254,14 +247,13 @@ func DeleteExtendedTable(ctx context.Context, tx *sql.Tx, key string) error {
  
    }

    // UpdateExtendedTable updates the extended_table matching the given key parameters.

    // generator: extended_table Update

    func UpdateExtendedTable(ctx context.Context, tx *sql.Tx, key string, object ExtendedTable) error {

    	id, err := GetExtendedTableID(ctx, tx, key)

    	if err != nil {

    		return err

    	}

    	stmt, err := cluster.Stmt(tx, extendedTableUpdate)

    	stmt, err := db.Stmt(tx, extendedTableUpdate)

    	if err != nil {

    		return fmt.Errorf("Failed to get \"extendedTableUpdate\" prepared statement: %w", err)

    	}

example/database/extended_schema.go

-Original file line number
+Diff line change
@@ Expand Up / @@ -5,7 +5,7 @@ import ( @@
     	"context"
     	"database/sql"
-    	"github.com/canonical/microcluster/v3/cluster/db"
+    	"github.com/canonical/microcluster/v3/microcluster/db"
     )
     // SchemaExtensions is a list of schema extensions that can be passed to the MicroCluster daemon.
@@ Expand Down @@

example/database/extended_table.go

-Original file line number
+Diff line change
@@ -1,32 +1,13 @@
     package database
-    //go:generate -command mapper lxd-generate db mapper -t extended.mapper.go
-    //go:generate mapper reset
-    //
-    //go:generate mapper stmt -d github.com/canonical/microcluster/v3/cluster -e extended_table objects table=extended_table
-    //go:generate mapper stmt -d github.com/canonical/microcluster/v3/cluster -e extended_table objects-by-Key table=extended_table
-    //go:generate mapper stmt -d github.com/canonical/microcluster/v3/cluster -e extended_table id table=extended_table
-    //go:generate mapper stmt -d github.com/canonical/microcluster/v3/cluster -e extended_table create table=extended_table
-    //go:generate mapper stmt -d github.com/canonical/microcluster/v3/cluster -e extended_table delete-by-Key table=extended_table
-    //go:generate mapper stmt -d github.com/canonical/microcluster/v3/cluster -e extended_table update table=extended_table
-    //
-    //go:generate mapper method -i -d github.com/canonical/microcluster/v3/cluster -e extended_table GetMany table=extended_table
-    //go:generate mapper method -i -d github.com/canonical/microcluster/v3/cluster -e extended_table GetOne table=extended_table
-    //go:generate mapper method -i -d github.com/canonical/microcluster/v3/cluster -e extended_table ID table=extended_table
-    //go:generate mapper method -i -d github.com/canonical/microcluster/v3/cluster -e extended_table Exists table=extended_table
-    //go:generate mapper method -i -d github.com/canonical/microcluster/v3/cluster -e extended_table Create table=extended_table
-    //go:generate mapper method -i -d github.com/canonical/microcluster/v3/cluster -e extended_table DeleteOne-by-Key table=extended_table
-    //go:generate mapper method -i -d github.com/canonical/microcluster/v3/cluster -e extended_table Update table=extended_table
-    // ExtendedTable is an example of a database table. In this case named `extended_table`. The above comments will
-    // generate database queries and helpers using lxd-generate.
+    // ExtendedTable is an example of a database table. In this case named `extended_table`.
     type ExtendedTable struct {
     	ID    int
     	Key   string `db:"primary=yes"`
     	Value string
     }
-    // ExtendedTableFilter is a required struct for use with lxd-generate. It is used for filtering fields on database
+    // ExtendedTableFilter is used for filtering fields on database
     // fetches. In this case we will only support filtering by Key.
     type ExtendedTableFilter struct {
     	Key *string
@@ Expand Down @@

cluster/cluster_members.go → internal/cluster/cluster_members.go

-Original file line number
+Diff line change
@@ Expand Up / @@ -8,28 +8,9 @@ import ( @@
     	"github.com/canonical/microcluster/v3/internal/db/update"
     	"github.com/canonical/microcluster/v3/internal/extensions"
-    	"github.com/canonical/microcluster/v3/rest/types"
+    	"github.com/canonical/microcluster/v3/microcluster/types"
     )
-    //go:generate -command mapper lxd-generate db mapper -t cluster_members.mapper.go
-    //go:generate mapper reset
-    //
-    //go:generate mapper stmt -e core_cluster_member objects table=core_cluster_members
-    //go:generate mapper stmt -e core_cluster_member objects-by-Address table=core_cluster_members
-    //go:generate mapper stmt -e core_cluster_member objects-by-Name table=core_cluster_members
-    //go:generate mapper stmt -e core_cluster_member id table=core_cluster_members
-    //go:generate mapper stmt -e core_cluster_member create table=core_cluster_members
-    //go:generate mapper stmt -e core_cluster_member delete-by-Address table=core_cluster_members
-    //go:generate mapper stmt -e core_cluster_member update table=core_cluster_members
-    //
-    //go:generate mapper method -i -e core_cluster_member GetMany table=core_cluster_members
-    //go:generate mapper method -i -e core_cluster_member GetOne table=core_cluster_members
-    //go:generate mapper method -i -e core_cluster_member ID table=core_cluster_members
-    //go:generate mapper method -i -e core_cluster_member Exists table=core_cluster_members
-    //go:generate mapper method -i -e core_cluster_member Create table=core_cluster_members
-    //go:generate mapper method -i -e core_cluster_member DeleteOne-by-Address table=core_cluster_members
-    //go:generate mapper method -i -e core_cluster_member Update table=core_cluster_members
     // Role is the role of the dqlite cluster member.
     type Role string
@@ Expand Down @@

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Restructure (2): Consolidate packages and move to `microcluster` #552

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

Restructure (2): Consolidate packages and move to microcluster #552

Uh oh!

Restructure (2): Consolidate packages and move to microcluster #552

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

Restructure (2): Consolidate packages and move to `microcluster` #552

Restructure (2): Consolidate packages and move to `microcluster` #552