Optionally save logs as output #243
Merged
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
When action.SaveLogs is set, a copy of the invocation image logs are saved as an output named io.cnab.outputs.invocationImageLogs. The logs are copied as they are written to a logfile, which after the bundle completes, are saved as an output when the claim result is saved. Signed-off-by: Carolyn Van Slyck <[email protected]>
If an output was generated that isn't defined in the bundle, e.g. the driver or tool added the output, then do not throw an error when it is read. When reading through the claimstore only sensitive values are encrypted, so if it doesn't have a definition, it was stored without being encrypted. Signed-off-by: Carolyn Van Slyck <[email protected]>
vdice
approved these changes
Mar 4, 2021
claim/result_test.go
Outdated
| }) | ||
|
|
||
| t.Run("output has no digest", func(t *testing.T) { | ||
| t.Run("output has no meatdata", func(t *testing.T) { |
There was a problem hiding this comment.
I feel like this is an easter egg for PR reviewers 🥩 and I almost don't want to change it buuut... s/meatdata/metadata?
|
I found a bug with how the filesytem store lists outputs. You wouldn't have noticed unless you were working with an output with a period in the name. So this PR works but if you are using filesystem store, then there's a bug. I'm fixing now. |
When listing documents in FileSystemStore with the file extension filter set to "", any document with an extension was being filtered out. This causes problems when an output (which doesn't require an extension) has a period in the name, such as the logs output, or mydata.json. I'v changed the logic so that when no filter is set for the file extension, we return all files in the directory. Signed-off-by: Carolyn Van Slyck <[email protected]>
|
@vdice Can you take one more look? I just fixed that bug in FileSystemStore. Seemed like it should be fixed here since without it, when you list outputs on the filesystem, it was missing the logs. |
vdice
approved these changes
Mar 4, 2021
|
Oh my goodness, sorry one more fix for this FileSystemStore bug. 🤦♀️ |
The FileSystemStore was removing the file extension from output names but outputs can be generated with file extensions. So when there isn't a file extension filter specified for an item, such as outputs, leave the file extension as-is. We will still remove the .json extension for documents such as claims. Signed-off-by: Carolyn Van Slyck <[email protected]>
|
Sorry about that, there were a few changes needed to the test and FileSystemStore so that when you list outputs, you get the original filenames. For example, if I save an output named "users.json", when I list outputs, I should see "users.json" as the output name. |
vdice
approved these changes
Mar 4, 2021
I can't spell but we shall miss you meatdata... Signed-off-by: Carolyn Van Slyck <[email protected]>
radu-matei
approved these changes
Mar 10, 2021
simongdavies
pushed a commit
to simongdavies/cnab-go
that referenced
this pull request
Mar 31, 2021
* Optionally save logs as output When action.SaveLogs is set, a copy of the invocation image logs are saved as an output named io.cnab.outputs.invocationImageLogs. The logs are copied as they are written to a logfile, which after the bundle completes, are saved as an output when the claim result is saved. Signed-off-by: Carolyn Van Slyck <[email protected]> * Handle reading undefined outputs If an output was generated that isn't defined in the bundle, e.g. the driver or tool added the output, then do not throw an error when it is read. When reading through the claimstore only sensitive values are encrypted, so if it doesn't have a definition, it was stored without being encrypted. Signed-off-by: Carolyn Van Slyck <[email protected]> * Fix empty file extension bug in FileSystemStore When listing documents in FileSystemStore with the file extension filter set to "", any document with an extension was being filtered out. This causes problems when an output (which doesn't require an extension) has a period in the name, such as the logs output, or mydata.json. I'v changed the logic so that when no filter is set for the file extension, we return all files in the directory. Signed-off-by: Carolyn Van Slyck <[email protected]> * Do not remove file extension from output names The FileSystemStore was removing the file extension from output names but outputs can be generated with file extensions. So when there isn't a file extension filter specified for an item, such as outputs, leave the file extension as-is. We will still remove the .json extension for documents such as claims. Signed-off-by: Carolyn Van Slyck <[email protected]> * Fix meatdata I can't spell but we shall miss you meatdata... Signed-off-by: Carolyn Van Slyck <[email protected]>
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.
When action.SaveLogs is set, a copy of the invocation image logs are saved as an output named
io.cnab.outputs.invocationImageLogs. The logs are copied as they are written to a logfile, which after the bundle completes, are saved as an output when the claim result is saved.CNAB tools control if logs are saved or not, defaulting to false.
This is very useful for "remote" bundle execution, like when it's run by the kubernetes driver. The user can see the logs from a run without having to figure out which pod to log, and its stored with the other installation data.
This PR also fixes a bug in the FileSystemStore where listing outputs was not returning any outputs with a period in the name.