unit-test: cmd/tokengen #1383 (#1385)

Signed-off-by: Angelo De Caro <adc@zurich.ibm.com>

Author: adecaro

cmd/tokengen/README.md

@@ -1,157 +1,53 @@
 # Tokengen
 
-`tokengen` is an utility for generating Fabric Token-SDK material. 
-It is provided as a means of preconfiguring public parameters, token chaincode, and so. 
-It would normally not be used in the operation of a production network.
+`tokengen` is a utility for generating Fabric Token-SDK material, such as public parameters, token chaincode packages, and other cryptographic artifacts. 
 
-## Syntax
+It is primarily used for pre-configuring development and testing environments.
 
-The `tokengen` command has five subcommands, as follows:
+## Build
 
-- artifacts
-- certifier-keygen
-- gen
-- help
-- version
-
-## tokengen artifacts
-
-This command is used to centrally generate key material and configuration files.
-It takes in input a `topology` file, in `yaml` format, that describes the topologies of the networks involved.
-An example can be found [`here`](./samples/topology/fungible.yaml). 
-Topology files can be edited directly or they can be generated programmatically as shown [`here`](./samples/topology/fungible.go). 
-
-```
-Read topology from file and generates artifacts.
-
-Usage:
-tokengen artifacts [flags]
-
-Flags:
--h, --help              help for artifacts
--o, --output string     output folder (default "./testdata")
--p, --port int          host starting port (default 20000)
--t, --topology string   topology file in yaml format
-```
-
-## tokengen certifier-keygen
-
-```
-Gen Token Certifier Key Pair.
-
-Usage:
-  tokengen certifier-keygen [flags]
-
-Flags:
-  -d, --driver string   driver (zkatdlognogh.v1) (default "zkatdlognogh.v1")
-  -h, --help            help for certifier-keygen
-  -o, --output string   output folder (default ".")
-  -p, --pppath string   path to the public parameters file
-```
-
-## tokengen gen
-
-The `tokengen gen` command has two subcommands, as follows:
-
-- fabtoken.v1: generates the public parameters for the fabtoken driver
-- zkatdlognogh.v1: generates the public parameters for the zkatdlognogh.v1 driver
-
-## tokengen gen fabtoken.v1
-
-```
-Usage:
-  tokengen gen fabtoken.v1 [flags]
-
-Flags:
-  -a, --auditors strings   list of auditor MSP directories containing the corresponding auditor certificate
-      --cc                 generate chaincode package
-  -h, --help               help for fabtoken.v1
-  -s, --issuers strings    list of issuer MSP directories containing the corresponding issuer certificate
-  -o, --output string      output folder (default ".")
-  -v, --version uint       allows the caller of tokengen to override the version number put in the public params
-```
-
-The public parameters are stored in the output folder with name `fabtokenv1_pp.json`.
-If version is overridden, then file name will be `("fabtokenv%d_pp.json", version)`.
-
-### tokengen gen zkatdlognogh.v1
+To build `tokengen`, run the following command from the root of the repository:
 
+```bash
+make tokengen
 ```
-Usage:
-  tokengen gen zkatdlognogh.v1 [flags]
 
-Flags:
-  -r, --aries               flag to indicate that aries should be used as backend for idemix
-  -a, --auditors strings    list of auditor MSP directories containing the corresponding auditor certificate
-  -b, --bits uint           bits is used to define the maximum quantity a token can contain (default 64)
-      --cc                  generate chaincode package
-  -x, --extra stringArray   extra data in key=value format, where value is the path to a file containing the data to load and store in the key
-  -h, --help                help for zkatdlognogh.v1
-  -i, --idemix string       idemix msp dir
-  -s, --issuers strings     list of issuer MSP directories containing the corresponding issuer certificate
-  -o, --output string       output folder (default ".")
-  -v, --version uint        allows the caller of tokengen to override the version number put in the public params
-``` 
+The binary will be generated in the `$GOROOT/bin` directory.
 
-The public parameters are stored in the output folder with name `zkatdlognoghv1_pp.json`.
-If version is overridden, then file name will be `("zkatdlognogh%d_pp.json", version)`.
+## Usage
 
-### tokengen update zkatdlognogh.v1
+The `tokengen` tool uses a command-line interface with several subcommands. You can always use the `--help` flag to see available options for any command.
 
-This command takes an existing `zkatdlognoghv1_pp.json` and allows you to update the issuer and/or auditor certificates, while keeping the public parameters intact.
-
-```
-Usage:
-  tokengen update zkatdlognogh.v1 [flags]
-
-Flags:
-  -a, --auditors strings    list of auditor MSP directories containing the corresponding auditor certificate
-  -x, --extra stringArray   extra data in key=value format, where is the path to a file containing the data to load and store in the key
-  -h, --help                help for zkatdlognogh.v1
-  -i, --input string        path of the public param file
-  -s, --issuers strings     list of issuer MSP directories containing the corresponding issuer certificate
-  -o, --output string       output folder (default ".")
-  -v, --version uint        allows the caller of tokengen to override the version number put in the public params
+```bash
+tokengen [command] --help
 ```
 
-## tokengen pp
+### Core Commands
 
-The `tokengen pp` command has the following subcommands:
+- **`artifacts`**: Generates key material and configuration files from a topology description (YAML).
+- **`gen`**: Generates public parameters for specific drivers (e.g., `fabtoken.v1`, `zkatdlognogh.v1`).
+- **`update`**: Updates certificates within existing public parameters.
+- **`pp print`**: Inspects and prints human-readable details of a public parameters file.
+- **`certifier-keygen`**: Generates key pairs for token certifiers.
+- **`version`**: Displays the build version information.
 
-- print: Inspect public parameters
-
-### tokengen pp print
-
-```
-Usage:
-  tokengen pp print [flags]
-
-Flags:
-  -h, --help           help for print
-  -i, --input string   path of the public param file
-```
-
-## tokengen help
+### Examples
 
+#### Generate Public Parameters for FabToken
+```bash
+tokengen gen fabtoken.v1 --auditors ./msp/auditor --issuers ./msp/issuer --output ./params
 ```
-Help provides help for any command in the application.
-Simply type tokengen help [path to command] for full details.
 
-Usage:
-  tokengen help [command] [flags]
-
-Flags:
-  -h, --help   help for help
+#### Inspect Public Parameters
+```bash
+tokengen pp print --input ./params/fabtokenv1_pp.json
 ```
 
-## tokengen version
-
+#### Generate Artifacts from Topology
+```bash
+tokengen artifacts --topology ./topology.yaml --output ./artifacts
 ```
-Print current version of tokengen.
 
-Usage:
-  tokengen version [flags]
+## Configuration
 
-Flags:
-  -h, --help   help for version
-```
+`tokengen` can also be configured via environment variables prefixed with `CORE_`. For example, `CORE_LOGGING_LEVEL=debug` will set the logging level to debug.

cmd/tokengen/cobra/artifactgen/artifactgen_test.go

@@ -0,0 +1,35 @@
+/*
+Copyright IBM Corp. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
+package artifactgen
+
+import (
+	"os"
+	"path/filepath"
+	"testing"
+
+	"github.com/hyperledger-labs/fabric-token-sdk/cmd/tokengen/cobra/artifactgen/testdata"
+	"github.com/hyperledger-labs/fabric-token-sdk/integration/nwo/token/generators/crypto/zkatdlognoghv1"
+	tokensdk "github.com/hyperledger-labs/fabric-token-sdk/token/sdk/dig"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+// TestWriteTopologies tests the WriteTopologies function.
+func TestWriteTopologies(t *testing.T) {
+	tempDir := t.TempDir()
+	fileName := filepath.Join(tempDir, "topologies.yaml")
+	topologies := testdata.Topology(zkatdlognoghv1.DriverIdentifier, &tokensdk.SDK{})
+
+	err := WriteTopologies(fileName, topologies, 0644)
+	require.NoError(t, err)
+	assert.FileExists(t, fileName)
+
+	// Test read back
+	raw, err := os.ReadFile(fileName)
+	require.NoError(t, err)
+	assert.Contains(t, string(raw), "topologies:")
+}

cmd/tokengen/cobra/artifactgen/gen/gen.go

@@ -19,14 +19,17 @@ import (
 	"gopkg.in/yaml.v2"
 )
 
+// Topology represents a topology.
 type Topology struct {
 	Type string `yaml:"type,omitempty"`
 }
 
+// Topologies represents a list of topologies.
 type Topologies struct {
 	Topologies []Topology `yaml:"topologies,omitempty"`
 }
 
+// T represents a list of topologies.
 type T struct {
 	Topologies []interface{} `yaml:"topologies,omitempty"`
 }
@@ -35,7 +38,7 @@ var topologyFile string
 var output string
 var port int
 
-// Cmd returns the Cobra Command for Version
+// Cmd returns the Cobra Command for generating artifacts.
 func Cmd() *cobra.Command {
 	// Set the flags on the node start command.
 	flags := cobraCommand.Flags()
@@ -70,14 +73,31 @@ func gen(args []string) error {
 	if err != nil {
 		return errors.Wrapf(err, "failed reading topology file [%s]", topologyFile)
 	}
+	t2, err := LoadTopologies(raw)
+	if err != nil {
+		return errors.Wrapf(err, "failed loading topologies from [%s]", topologyFile)
+	}
+
+	network, err := integration.New(port, output, t2...)
+	if err != nil {
+		return errors.Wrapf(err, "cannot instantate integration infrastructure")
+	}
+	network.RegisterPlatformFactory(token.NewPlatformFactory(nil))
+	network.Generate()
+
+	return nil
+}
+
+// LoadTopologies loads topologies from the given raw byte slice.
+func LoadTopologies(raw []byte) ([]api.Topology, error) {
 	names := &Topologies{}
 	if err := yaml.Unmarshal(raw, names); err != nil {
-		return errors.Wrapf(err, "failed unmarshalling topology file [%s]", topologyFile)
+		return nil, errors.Wrapf(err, "failed unmarshalling topologies")
 	}
 
 	t := &T{}
 	if err := yaml.Unmarshal(raw, t); err != nil {
-		return errors.Wrapf(err, "failed unmarshalling topology file [%s]", topologyFile)
+		return nil, errors.Wrapf(err, "failed unmarshalling topologies")
 	}
 	t2 := []api.Topology{}
 	for i, topology := range names.Topologies {
@@ -86,41 +106,34 @@ func gen(args []string) error {
 			top := fabric.NewDefaultTopology()
 			r, err := yaml.Marshal(t.Topologies[i])
 			if err != nil {
-				return errors.Wrapf(err, "failed remarshalling topology configuration [%s]", topologyFile)
+				return nil, errors.Wrapf(err, "failed remarshalling topology configuration")
 			}
 			if err := yaml.Unmarshal(r, top); err != nil {
-				return errors.Wrapf(err, "failed unmarshalling topology file [%s]", topologyFile)
+				return nil, errors.Wrapf(err, "failed unmarshalling topology")
 			}
 			t2 = append(t2, top)
 		case fsc.TopologyName:
 			top := fsc.NewTopology()
 			r, err := yaml.Marshal(t.Topologies[i])
 			if err != nil {
-				return errors.Wrapf(err, "failed remarshalling topology configuration [%s]", topologyFile)
+				return nil, errors.Wrapf(err, "failed remarshalling topology configuration")
 			}
 			if err := yaml.Unmarshal(r, top); err != nil {
-				return errors.Wrapf(err, "failed unmarshalling topology file [%s]", topologyFile)
+				return nil, errors.Wrapf(err, "failed unmarshalling topology")
 			}
 			t2 = append(t2, top)
 		case token.TopologyName:
 			top := token.NewTopology()
 			r, err := yaml.Marshal(t.Topologies[i])
 			if err != nil {
-				return errors.Wrapf(err, "failed remarshalling topology configuration [%s]", topologyFile)
+				return nil, errors.Wrapf(err, "failed remarshalling topology configuration")
 			}
 			if err := yaml.Unmarshal(r, top); err != nil {
-				return errors.Wrapf(err, "failed unmarshalling topology file [%s]", topologyFile)
+				return nil, errors.Wrapf(err, "failed unmarshalling topology")
 			}
 			t2 = append(t2, top)
 		}
 	}
 
-	network, err := integration.New(port, output, t2...)
-	if err != nil {
-		return errors.Wrapf(err, "cannot instantate integration infrastructure")
-	}
-	network.RegisterPlatformFactory(token.NewPlatformFactory(nil))
-	network.Generate()
-
-	return nil
+	return t2, nil
 }