-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
- Loading branch information
Showing
17 changed files
with
495 additions
and
185 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
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,74 @@ | ||
| // Copyright 2016 cli-docs-tool authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package clidocstool | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "log" | ||
| "os" | ||
| "strconv" | ||
| "time" | ||
|
|
||
| "github.com/spf13/cobra" | ||
| "github.com/spf13/cobra/doc" | ||
| ) | ||
|
|
||
| // GenManTree generates a man page for the command and all descendants. | ||
| // If SOURCE_DATE_EPOCH is set, in order to allow reproducible package | ||
| // builds, we explicitly set the build time to SOURCE_DATE_EPOCH. | ||
| func (c *Client) GenManTree(cmd *cobra.Command) error { | ||
| if err := c.loadLongDescription(cmd, "man"); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| if epoch := os.Getenv("SOURCE_DATE_EPOCH"); c.manHeader != nil && epoch != "" { | ||
| unixEpoch, err := strconv.ParseInt(epoch, 10, 64) | ||
| if err != nil { | ||
| return fmt.Errorf("invalid SOURCE_DATE_EPOCH: %v", err) | ||
| } | ||
| now := time.Unix(unixEpoch, 0) | ||
| c.manHeader.Date = &now | ||
| } | ||
|
|
||
| return c.genManTreeCustom(cmd) | ||
| } | ||
|
|
||
| func (c *Client) genManTreeCustom(cmd *cobra.Command) error { | ||
| for _, sc := range cmd.Commands() { | ||
| if err := c.genManTreeCustom(sc); err != nil { | ||
| return err | ||
| } | ||
| } | ||
|
|
||
| // always disable the addition of [flags] to the usage | ||
| cmd.DisableFlagsInUseLine = true | ||
|
|
||
| // always disable "spf13/cobra" auto gen tag | ||
| cmd.DisableAutoGenTag = true | ||
|
|
||
| // Skip the root command altogether, to prevent generating a useless | ||
| // md file for plugins. | ||
| if c.plugin && !cmd.HasParent() { | ||
| return nil | ||
| } | ||
|
|
||
| log.Printf("INFO: Generating Man for %q", cmd.CommandPath()) | ||
|
|
||
| return doc.GenManTreeFromOpts(cmd, doc.GenManTreeOptions{ | ||
| Header: c.manHeader, | ||
| Path: c.target, | ||
| CommandSeparator: "-", | ||
| }) | ||
| } |
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,93 @@ | ||
| // Copyright 2021 cli-docs-tool authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package clidocstool | ||
|
|
||
| import ( | ||
| "io/fs" | ||
| "os" | ||
| "path" | ||
| "path/filepath" | ||
| "regexp" | ||
| "strconv" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/spf13/cobra/doc" | ||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| //nolint:errcheck | ||
| func TestGenManTree(t *testing.T) { | ||
| setup() | ||
| tmpdir := t.TempDir() | ||
|
|
||
| epoch, err := time.Parse("2006-Jan-02", "2020-Jan-10") | ||
| require.NoError(t, err) | ||
| t.Setenv("SOURCE_DATE_EPOCH", strconv.FormatInt(epoch.Unix(), 10)) | ||
|
|
||
| require.NoError(t, copyFile(path.Join("fixtures", "buildx_stop.pre.md"), path.Join(tmpdir, "buildx_stop.md"))) | ||
|
|
||
| c, err := New(Options{ | ||
| Root: buildxCmd, | ||
| SourceDir: tmpdir, | ||
| Plugin: true, | ||
| ManHeader: &doc.GenManHeader{ | ||
| Title: "DOCKER", | ||
| Section: "1", | ||
| Source: "Docker Community", | ||
| Manual: "Docker User Manuals", | ||
| }, | ||
| }) | ||
| require.NoError(t, err) | ||
| require.NoError(t, c.GenManTree(buildxCmd)) | ||
|
|
||
| seen := make(map[string]struct{}) | ||
| remanpage := regexp.MustCompile(`\.\d+$`) | ||
|
|
||
| filepath.Walk("fixtures", func(path string, info fs.FileInfo, err error) error { | ||
| fname := filepath.Base(path) | ||
| // ignore dirs and any file that is not a manpage | ||
| if info.IsDir() || !remanpage.MatchString(fname) { | ||
| return nil | ||
| } | ||
| t.Run(fname, func(t *testing.T) { | ||
| seen[fname] = struct{}{} | ||
| require.NoError(t, err) | ||
|
|
||
| bres, err := os.ReadFile(filepath.Join(tmpdir, fname)) | ||
| require.NoError(t, err) | ||
|
|
||
| bexc, err := os.ReadFile(path) | ||
| require.NoError(t, err) | ||
| assert.Equal(t, string(bexc), string(bres)) | ||
| }) | ||
| return nil | ||
| }) | ||
|
|
||
| filepath.Walk(tmpdir, func(path string, info fs.FileInfo, err error) error { | ||
| fname := filepath.Base(path) | ||
| // ignore dirs and any file that is not a manpage | ||
| if info.IsDir() || !remanpage.MatchString(fname) { | ||
| return nil | ||
| } | ||
| t.Run("seen_"+fname, func(t *testing.T) { | ||
| if _, ok := seen[fname]; !ok { | ||
| t.Errorf("file %s not found in fixtures", fname) | ||
| } | ||
| }) | ||
| return nil | ||
| }) | ||
| } |
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
Oops, something went wrong.