fix: plugin error message by JeyJeyGao · Pull Request #1217 · notaryproject/notation

JeyJeyGao · 2025-03-12T08:47:29Z

Examples:

When putting an arbitrary file into the plugin folder:
Before:

NAME                   DESCRIPTION   VERSION   CAPABILITIES   ERROR                                                                                                                                                                                                                              
azure-trustedsigning                           []             fork/exec /home/jj/.config/notation/plugins/azure-trustedsigning/notation-azure-trustedsigning: exec format error

After

NAME                   DESCRIPTION   VERSION   CAPABILITIES   ERROR                                                                                                                                                                                                                              
azure-trustedsigning                           []             plugin executable file `notation-azure-trustedsigning` is not executable. Use `notation plugin install` command to install the plugin. Please ensure that the plugin executable file is compatible with linux/amd64

When the plugin name is not followed the plugin spec:
Before

NAME                   DESCRIPTION   VERSION   CAPABILITIES   ERROR                                                                                                                                                                                                                                                                                                                        
azure-trustedsigning                           []             plugin executable file is either not found or inaccessible: stat /home/jj/.config/notation/plugins/azure-trustedsigning/notation-azure-trustedsigning: no such file or directory

After

NAME                   DESCRIPTION   VERSION   CAPABILITIES   ERROR                                                                                                                                                                                                                                                                                                                        
azure-trustedsigning                           []             plugin executable file `notation-azure-trustedsigning` not found. Use `notation plugin install` command to install the plugin. Each plugin executable must be placed in the $PLUGIN_DIRECTORY/{plugin-name} directory, with the executable named as 'notation-{plugin-name}''

When the notation plugin executable file is not executable:
Before/After are the same

NAME                   DESCRIPTION   VERSION   CAPABILITIES   ERROR                                                                                                               
azure-trustedsigning                           []             fork/exec /home/jj/.config/notation/plugins/azure-trustedsigning/notation-azure-trustedsigning: permission denied

When using an AMR64 arch of plugin file on an AMD64 machine:
Before:

NAME                   DESCRIPTION   VERSION   CAPABILITIES   ERROR                                                                                                                                                                                                                              
azure-trustedsigning                           []             fork/exec /home/jj/.config/notation/plugins/azure-trustedsigning/notation-azure-trustedsigning: exec format error

After:

NAME                   DESCRIPTION   VERSION   CAPABILITIES   ERROR                                                                                                                                                                                                                              
azure-trustedsigning                           []             plugin file `notation-azure-trustedsigning` is not executable. Use `notation plugin install` command to install the plugin. Please ensure that the plugin executable file is compatible with linux/amd64

Resolves #704

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

codecov · 2025-03-12T08:50:04Z

Codecov Report

Attention: Patch coverage is 80.00000% with 4 lines in your changes missing coverage. Please review.

Project coverage is 76.54%. Comparing base (784ffb8) to head (1455007).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
cmd/notation/plugin/list.go	80.00%	3 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1217      +/-   ##
==========================================
- Coverage   76.54%   76.54%   -0.01%     
==========================================
  Files          67       67              
  Lines        3710     3727      +17     
==========================================
+ Hits         2840     2853      +13     
- Misses        671      674       +3     
- Partials      199      200       +1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

ghost

Can you provide a before-and-after comparison regarding this change?

JeyJeyGao · 2025-03-13T02:17:36Z

Can you provide a before-and-after comparison regarding this change?

Updated.

ghost

It seems that the changes in this PR does not align with the discussion in the original issue. Will review this PR once everyone is on the same page.

cc: @FeynmanZhou

JeyJeyGao · 2025-03-13T02:26:54Z

It seems that the changes in this PR does not align with the discussion in the original issue. Will review this PR once everyone is on the same page.

cc: @FeynmanZhou

Yes, the change may not be exactly as originally proposed, as I believe we need to retain the original Go built-in error for easier error investigation. I have added an additional recommendation message to improve the error message. Please have a look, @FeynmanZhou.

cmd/notation/plugin/list.go

FeynmanZhou · 2025-03-14T06:14:28Z

It seems that the changes in this PR does not align with the discussion in the original issue. Will review this PR once everyone is on the same page.

cc: @FeynmanZhou

@Two-Hearts The error message in original issue is no longer valid. @JeyJeyGao helped revisit the latest plugin-related error message and proposed this PR. We just need to make sure these error message follow the Notation CLI Error Handling and Message Guideline.

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

FeynmanZhou

LGTM. Thanks @JeyJeyGao

shizhMSFT

LGTM

cmd/notation/plugin/list.go

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

FeynmanZhou

LGTM

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

cmd/notation/plugin/list.go

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

…ssage

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

ghost

LGTM

FeynmanZhou

LGTM

Examples: **When putting an arbitrary file into the plugin folder:** Before: ``` NAME DESCRIPTION VERSION CAPABILITIES ERROR azure-trustedsigning [] fork/exec /home/jj/.config/notation/plugins/azure-trustedsigning/notation-azure-trustedsigning: exec format error ``` After ``` NAME DESCRIPTION VERSION CAPABILITIES ERROR azure-trustedsigning [] plugin executable file `notation-azure-trustedsigning` is not executable. Use `notation plugin install` command to install the plugin. Please ensure that the plugin executable file is compatible with linux/amd64 ``` **When the plugin name is not followed the plugin spec:** Before ``` NAME DESCRIPTION VERSION CAPABILITIES ERROR azure-trustedsigning [] plugin executable file is either not found or inaccessible: stat /home/jj/.config/notation/plugins/azure-trustedsigning/notation-azure-trustedsigning: no such file or directory ``` After ``` NAME DESCRIPTION VERSION CAPABILITIES ERROR azure-trustedsigning [] plugin executable file `notation-azure-trustedsigning` not found. Use `notation plugin install` command to install the plugin. Each plugin executable must be placed in the $PLUGIN_DIRECTORY/{plugin-name} directory, with the executable named as 'notation-{plugin-name}'' ``` **When the notation plugin executable file is not executable:** Before/After are the same ``` NAME DESCRIPTION VERSION CAPABILITIES ERROR azure-trustedsigning [] fork/exec /home/jj/.config/notation/plugins/azure-trustedsigning/notation-azure-trustedsigning: permission denied ``` **When using an AMR64 arch of plugin file on an AMD64 machine:** Before: ``` NAME DESCRIPTION VERSION CAPABILITIES ERROR azure-trustedsigning [] fork/exec /home/jj/.config/notation/plugins/azure-trustedsigning/notation-azure-trustedsigning: exec format error ``` After: ``` NAME DESCRIPTION VERSION CAPABILITIES ERROR azure-trustedsigning [] plugin file `notation-azure-trustedsigning` is not executable. Use `notation plugin install` command to install the plugin. Please ensure that the plugin executable file is compatible with linux/amd64 ``` Resolves notaryproject#704 --------- Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

fix: plugin error message

de3a8f9

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

JeyJeyGao added 2 commits March 12, 2025 12:51

fix: improve error message for plugin

b12a5ea

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

fix: update

7f23e76

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

JeyJeyGao marked this pull request as ready for review March 12, 2025 12:59

JeyJeyGao requested review from NiazFK, gokarnm, priteshbandi, rgnote, shizhMSFT and toddysm as code owners March 12, 2025 12:59

JeyJeyGao requested a review from a user March 12, 2025 12:59

JeyJeyGao requested review from vaninrao10 and yizha1 as code owners March 12, 2025 12:59

ghost reviewed Mar 13, 2025

View reviewed changes

ghost suggested changes Mar 13, 2025

View reviewed changes

FeynmanZhou reviewed Mar 14, 2025

View reviewed changes

cmd/notation/plugin/list.go Outdated Show resolved Hide resolved

fix: resolve comment

12fcc1d

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

FeynmanZhou previously approved these changes Mar 17, 2025

View reviewed changes

shizhMSFT previously approved these changes Mar 18, 2025

View reviewed changes

ghost suggested changes Mar 19, 2025

View reviewed changes

cmd/notation/plugin/list.go Outdated Show resolved Hide resolved

cmd/notation/plugin/list.go Show resolved Hide resolved

cmd/notation/plugin/list.go Outdated Show resolved Hide resolved

JeyJeyGao added 2 commits March 19, 2025 02:53

fix: resolve comment

4e1a2a5

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

fix: update

6e57033

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

JeyJeyGao dismissed stale reviews from shizhMSFT and FeynmanZhou via 6e57033 March 19, 2025 02:57

fix: update

5119cf9

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

FeynmanZhou previously approved these changes Mar 20, 2025

View reviewed changes

fix: resolve comment

6961521

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

JeyJeyGao dismissed FeynmanZhou’s stale review via 6961521 March 24, 2025 04:37

ghost reviewed Mar 24, 2025

View reviewed changes

JeyJeyGao added 7 commits March 24, 2025 06:10

fix: resolve comment

79fbf8d

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

Merge remote-tracking branch 'upstream/main' into fix/plugin_error_me…

7438a23

…ssage

fix: update go mod

546ba31

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

fix: remove .

fc516f6

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

fix: update

8b6227c

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

fix: update

1ac601b

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

fix: update

1455007

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

ghost approved these changes Mar 24, 2025

View reviewed changes

FeynmanZhou approved these changes Mar 24, 2025

View reviewed changes

JeyJeyGao merged commit b7a2f0c into notaryproject:main Mar 25, 2025
7 checks passed

JeyJeyGao deleted the fix/plugin_error_message branch March 25, 2025 00:23

Comments

Conversation

JeyJeyGao commented Mar 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Mar 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

ghost left a comment

Choose a reason for hiding this comment

Uh oh!

JeyJeyGao commented Mar 13, 2025

Uh oh!

ghost left a comment

Choose a reason for hiding this comment

Uh oh!

JeyJeyGao commented Mar 13, 2025

Uh oh!

Uh oh!

FeynmanZhou commented Mar 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

FeynmanZhou left a comment

Choose a reason for hiding this comment

Uh oh!

shizhMSFT left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

FeynmanZhou left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ghost left a comment

Choose a reason for hiding this comment

Uh oh!

FeynmanZhou left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

JeyJeyGao commented Mar 12, 2025 •

edited

Loading

codecov bot commented Mar 12, 2025 •

edited

Loading

FeynmanZhou commented Mar 14, 2025 •

edited

Loading