tbot configure command for assisting Machine ID configuration
#12517
Conversation
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
strideynet
force-pushed
the
strideynet/machine-id-yaml-configuration-output
branch
5 times, most recently
from
7d57aa0 to
7df8370
Compare
strideynet
commented
May 9, 2022
| // the same across dev laptops and GCB. | ||
| // If we switch to a more dependency injected model for botfs, we can | ||
| // ensure that the test one returns the same value across operating systems. | ||
| normalizeOSDependentValues := func(data []byte) []byte { |
There was a problem hiding this comment.
I'm really not a fan of this, but I didn't want to completely refactor botfs to be a dependency injected struct without a bit more investigation.
I'm completely open to some more suggestions here.
There was a problem hiding this comment.
Yeah, that's unfortunate. The overly-simple botfs design has caused some problems already and I'm not opposed to refactoring it.
strideynet
force-pushed
the
strideynet/machine-id-yaml-configuration-output
branch
2 times, most recently
from
116b026 to
f26dd16
Compare
strideynet
force-pushed
the
strideynet/machine-id-yaml-configuration-output
branch
2 times, most recently
from
fdde9b1 to
2ef34cd
Compare
zmb3
reviewed
May 9, 2022
strideynet
force-pushed
the
strideynet/machine-id-yaml-configuration-output
branch
from
f8b5bad to
3cda886
Compare
timothyb89
reviewed
May 9, 2022
| // the same across dev laptops and GCB. | ||
| // If we switch to a more dependency injected model for botfs, we can | ||
| // ensure that the test one returns the same value across operating systems. | ||
| normalizeOSDependentValues := func(data []byte) []byte { |
There was a problem hiding this comment.
Yeah, that's unfortunate. The overly-simple botfs design has caused some problems already and I'm not opposed to refactoring it.
| @@ -292,7 +296,7 @@ func FromCLIConf(cf *CLIConf) (*BotConfig, error) { | |||
| } | |||
|
|
|||
| if err := config.CheckAndSetDefaults(); err != nil { | |||
| return nil, trace.Wrap(err, "validing merged bot config") | |||
| return nil, trace.Wrap(err, "validating merged bot config") | |||
zmb3
approved these changes
May 9, 2022
strideynet
force-pushed
the
strideynet/machine-id-yaml-configuration-output
branch
from
3cda886 to
2f39587
Compare
strideynet
force-pushed
the
strideynet/machine-id-yaml-configuration-output
branch
from
2f39587 to
77dba07
Compare
timothyb89
approved these changes
May 9, 2022
strideynet
force-pushed
the
strideynet/machine-id-yaml-configuration-output
branch
from
77dba07 to
93a4214
Compare
strideynet
added a commit
that referenced
this pull request
May 11, 2022
* add `tbot configure` command * introduce golden file test helper * address PR comments by zmb
strideynet
added a commit
that referenced
this pull request
May 17, 2022
* add `tbot configure` command * introduce golden file test helper * address PR comments by zmb
strideynet
added a commit
that referenced
this pull request
May 17, 2022
…) (#12576) * add `tbot configure` command * introduce golden file test helper * address PR comments by zmb
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #11483
Command outputs YAML to stdout or to a file, allowing the user to create a configuration file from parameters. This assists users with achieving a working tbot configuration as fast as possible.
The
-oflag can be provided to write the configuration directly to a file, but when this is omitted, the configuration is just output to stdout:goldenThis also introduces a test helper package called
golden. I'm happy to extract this into a separate PR if needs be. I have found golden files to be a very convenient and effective way of handling large expected outputs from tests in a way that can be easily updated, and inspected in PR diffs."Golden files" are expected test outputs stored as files under
testdata/rather than embedded directly within the test table. Running the tests with the environment variableGOLDEN_UPDATE=1causes this files to be updated, rather than asserted against.