-
Notifications
You must be signed in to change notification settings - Fork 128
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
deps(apiops): bump to v0.1.29 adds 'namespace' command (#1179)
- Loading branch information
Showing
4 changed files
with
156 additions
and
7 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 |
|---|---|---|
| @@ -0,0 +1,146 @@ | ||
| package cmd | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "log" | ||
| "strings" | ||
|
|
||
| "github.com/kong/go-apiops/deckformat" | ||
| "github.com/kong/go-apiops/filebasics" | ||
| "github.com/kong/go-apiops/jsonbasics" | ||
| "github.com/kong/go-apiops/logbasics" | ||
| "github.com/kong/go-apiops/namespace" | ||
| "github.com/kong/go-apiops/yamlbasics" | ||
| "github.com/spf13/cobra" | ||
| ) | ||
|
|
||
| var ( | ||
| cmdNamespaceInputFilename string | ||
| cmdNamespaceOutputFilename string | ||
| cmdNamespaceOutputFormat string | ||
| cmdNamespaceSelectors []string | ||
| cmdNamespacePathPrefix string | ||
| cmdNamespaceAllowEmptySelectors bool | ||
| ) | ||
|
|
||
| // Executes the CLI command "namespace" | ||
| func executeNamespace(cmd *cobra.Command, _ []string) error { | ||
| verbosity, _ := cmd.Flags().GetInt("verbose") | ||
| logbasics.Initialize(log.LstdFlags, verbosity) | ||
| _ = sendAnalytics("file-namespace", "", modeLocal) | ||
|
|
||
| err := namespace.CheckNamespace(cmdNamespacePathPrefix) | ||
| if err != nil { | ||
| return fmt.Errorf("invalid path-prefix '%s': %w", cmdNamespacePathPrefix, err) | ||
| } | ||
|
|
||
| cmdNamespaceOutputFormat = strings.ToUpper(cmdNamespaceOutputFormat) | ||
|
|
||
| trackInfo := deckformat.HistoryNewEntry("namespace") | ||
| trackInfo["input"] = cmdNamespaceInputFilename | ||
| trackInfo["output"] = cmdNamespaceOutputFilename | ||
| trackInfo["selectors"] = cmdNamespaceSelectors | ||
| trackInfo["path-prefix"] = cmdNamespacePathPrefix | ||
|
|
||
| // do the work: read/namespace/write | ||
| data, err := filebasics.DeserializeFile(cmdNamespaceInputFilename) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to read input file '%s'; %w", cmdNamespaceInputFilename, err) | ||
| } | ||
| deckformat.HistoryAppend(data, trackInfo) | ||
|
|
||
| yamlNode := jsonbasics.ConvertToYamlNode(data) | ||
|
|
||
| // var selectors yamlbasics.SelectorSet | ||
| selectors, err := yamlbasics.NewSelectorSet(cmdNamespaceSelectors) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| err = namespace.Apply(yamlNode, selectors, cmdNamespacePathPrefix, cmdNamespaceAllowEmptySelectors) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to apply the namespace: %w", err) | ||
| } | ||
|
|
||
| data = jsonbasics.ConvertToJSONobject(yamlNode) | ||
|
|
||
| return filebasics.WriteSerializedFile(cmdNamespaceOutputFilename, data, | ||
| filebasics.OutputFormat(cmdNamespaceOutputFormat)) | ||
| } | ||
|
|
||
| // | ||
| // | ||
| // Define the CLI data for the namespace command | ||
| // | ||
| // | ||
|
|
||
| func newNamespaceCmd() *cobra.Command { | ||
| namespaceCmd := &cobra.Command{ | ||
| Use: "namespace [flags]", | ||
| Short: "Apply a namespace to routes in a decK file by prefixing the path", | ||
| Long: `Apply a namespace to routes in a decK file by prefixing the path. | ||
| By prefixing paths with a specific segment, colliding paths to services can be | ||
| namespaced to prevent the collisions. Eg. 2 API definitions that both expose a | ||
| '/list' path. By prefixing one with '/addressbook' and the other with '/cookbook' | ||
| the resulting paths '/addressbook/list' and '/cookbook/list' can be exposed without | ||
| colliding. | ||
| To remove the prefix from the path before the request is routed to the service, the | ||
| following approaches are used: | ||
| - if the route has 'strip_path=true' then the added prefix will already be stripped | ||
| - if the related service has a 'path' property that matches the prefix, then the | ||
| 'service.path' property is updated to remove the prefix | ||
| - a "pre-function" plugin will be added to remove the prefix from the path | ||
| `, | ||
| RunE: executeNamespace, | ||
| Example: `# Apply namespace to a deckfile | ||
| deck file namespace --path-prefix=/kong --state=deckfile.yaml | ||
| # Apply namespace to a deckfile, and write to a new file | ||
| # Example file 'kong.yaml': | ||
| routes: | ||
| - paths: | ||
| - ~/tracks/system$ | ||
| strip_path: true | ||
| - paths: | ||
| - ~/list$ | ||
| strip_path: false | ||
| # Apply namespace to the deckfile, and write to stdout: | ||
| cat kong.yaml | deck file namespace --path-prefix=/kong | ||
| # Output: | ||
| routes: | ||
| - paths: | ||
| - ~/kong/tracks/system$ | ||
| strip_path: true | ||
| - paths: | ||
| - ~/kong/list$ | ||
| strip_path: false | ||
| plugins: | ||
| - name: pre-function | ||
| config: | ||
| access: | ||
| - "local ns='/kong' -- this strips the '/kong' namespace from the path\nlocal <more code here>" | ||
| `, | ||
| } | ||
|
|
||
| namespaceCmd.Flags().StringVarP(&cmdNamespaceInputFilename, "state", "s", "-", | ||
| "decK file to process. Use - to read from stdin.") | ||
| namespaceCmd.Flags().StringVarP(&cmdNamespaceOutputFilename, "output-file", "o", "-", | ||
| "Output file to write. Use - to write to stdout.") | ||
| namespaceCmd.Flags().StringVarP(&cmdNamespaceOutputFormat, "format", "", "yaml", | ||
| "Output format: yaml or json.") | ||
| namespaceCmd.Flags().StringArrayVarP(&cmdNamespaceSelectors, "selector", "", []string{}, | ||
| "json-pointer identifying element to patch. Repeat for multiple selectors. Defaults "+ | ||
| "to selecting all routes.") | ||
| namespaceCmd.Flags().StringVarP(&cmdNamespacePathPrefix, "path-prefix", "p", "", | ||
| "The path based namespace to apply.") | ||
| namespaceCmd.Flags().BoolVarP(&cmdNamespaceAllowEmptySelectors, "allow-empty-selectors", | ||
| "", false, "do not error out if the selectors return empty") | ||
|
|
||
| return namespaceCmd | ||
| } |
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
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
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