-
Notifications
You must be signed in to change notification settings - Fork 41
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add tests for docgen, but still need to verify generated contents.
- Loading branch information
Matthew Witkowski
committed
Sep 18, 2023
1 parent
cc48f79
commit 8beeafb
Showing
1 changed file
with
118 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,119 @@ | ||
package cmd_test | ||
|
||
import ( | ||
"context" | ||
"os" | ||
"path/filepath" | ||
"testing" | ||
|
||
"github.com/cosmos/cosmos-sdk/client" | ||
"github.com/cosmos/cosmos-sdk/server" | ||
sdksim "github.com/cosmos/cosmos-sdk/simapp" | ||
genutiltest "github.com/cosmos/cosmos-sdk/x/genutil/client/testutil" | ||
provenancecmd "github.com/provenance-io/provenance/cmd/provenanced/cmd" | ||
"github.com/spf13/viper" | ||
"github.com/stretchr/testify/require" | ||
"github.com/tendermint/tendermint/libs/log" | ||
) | ||
|
||
func TestDocGen(t *testing.T) { | ||
tests := []struct { | ||
name string | ||
target string | ||
createTarget bool | ||
flags []string | ||
err string | ||
}{ | ||
{ | ||
name: "failure - no flags specified", | ||
target: "tmp", | ||
createTarget: true, | ||
err: "at least one doc type must be specified.", | ||
}, | ||
{ | ||
name: "failure - unsupported flag format", | ||
target: "tmp", | ||
flags: []string{"--bad"}, | ||
createTarget: true, | ||
err: "unknown flag: --bad", | ||
}, | ||
{ | ||
name: "success - yaml is generated", | ||
target: "tmp", | ||
createTarget: true, | ||
flags: []string{"--yaml"}, | ||
}, | ||
{ | ||
name: "success - rest is generated", | ||
target: "tmp", | ||
createTarget: true, | ||
flags: []string{"--rest"}, | ||
}, | ||
{ | ||
name: "success - manpage is generated", | ||
target: "tmp", | ||
createTarget: true, | ||
flags: []string{"--manpage"}, | ||
}, | ||
{ | ||
name: "success - markdown is generated", | ||
target: "tmp", | ||
createTarget: true, | ||
flags: []string{"--markdown"}, | ||
}, | ||
{ | ||
name: "success - multiple types supported", | ||
target: "tmp", | ||
createTarget: true, | ||
flags: []string{"--markdown", "--yaml"}, | ||
}, | ||
{ | ||
name: "success - generates a new directory", | ||
target: "tmp2", | ||
createTarget: false, | ||
flags: []string{"--yaml"}, | ||
}, | ||
} | ||
|
||
for _, tc := range tests { | ||
t.Run(tc.name, func(t *testing.T) { | ||
home := t.TempDir() | ||
|
||
targetPath := filepath.Join(home, tc.target) | ||
if tc.createTarget { | ||
require.NoError(t, os.Mkdir(targetPath, 0755)) | ||
} | ||
|
||
logger := log.NewNopLogger() | ||
cfg, err := genutiltest.CreateDefaultTendermintConfig(home) | ||
require.NoError(t, err) | ||
|
||
appCodec := sdksim.MakeTestEncodingConfig().Codec | ||
err = genutiltest.ExecInitCmd(testMbm, home, appCodec) | ||
require.NoError(t, err) | ||
|
||
serverCtx := server.NewContext(viper.New(), cfg, logger) | ||
clientCtx := client.Context{}.WithCodec(appCodec).WithHomeDir(home) | ||
|
||
ctx := context.Background() | ||
ctx = context.WithValue(ctx, client.ClientContextKey, &clientCtx) | ||
ctx = context.WithValue(ctx, server.ServerContextKey, serverCtx) | ||
|
||
cmd := provenancecmd.GetDocGenCmd() | ||
args := append([]string{targetPath}, tc.flags...) | ||
cmd.SetArgs(args) | ||
|
||
if len(tc.err) > 0 { | ||
err := cmd.ExecuteContext(ctx) | ||
require.Error(t, err) | ||
require.Equal(t, tc.err, err.Error()) | ||
} else { | ||
err := cmd.ExecuteContext(ctx) | ||
require.NoError(t, err) | ||
// We probably want to check generation of files | ||
} | ||
|
||
require.NoError(t, os.RemoveAll(targetPath)) | ||
}) | ||
} | ||
} |