1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
// Copyright The Notary Project 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 cmd
import (
"context"
"github.com/notaryproject/notation-go/log"
"github.com/notaryproject/notation/internal/trace"
"github.com/sirupsen/logrus"
"github.com/spf13/cobra"
"github.com/spf13/pflag"
credentialstrace "oras.land/oras-go/v2/registry/remote/credentials/trace"
)
// SignerFlagOpts cmd opts for using cmd.GetSigner
type SignerFlagOpts struct {
Key string
SignatureFormat string
KeyID string
PluginName string
}
// ApplyFlags set flags and their default values for the FlagSet
func (opts *SignerFlagOpts) ApplyFlagsToCommand(command *cobra.Command) {
fs := command.Flags()
SetPflagKey(fs, &opts.Key)
SetPflagSignatureFormat(fs, &opts.SignatureFormat)
SetPflagID(fs, &opts.KeyID)
SetPflagPlugin(fs, &opts.PluginName)
command.MarkFlagsRequiredTogether("id", "plugin")
command.MarkFlagsMutuallyExclusive("key", "id")
command.MarkFlagsMutuallyExclusive("key", "plugin")
}
// LoggingFlagOpts option struct.
type LoggingFlagOpts struct {
Debug bool
Verbose bool
}
// ApplyFlags applies flags to a command flag set.
func (opts *LoggingFlagOpts) ApplyFlags(fs *pflag.FlagSet) {
fs.BoolVarP(&opts.Debug, "debug", "d", false, "debug mode")
fs.BoolVarP(&opts.Verbose, "verbose", "v", false, "verbose mode")
}
// InitializeLogger sets up the logger based on common options.
func (opts *LoggingFlagOpts) InitializeLogger(ctx context.Context) context.Context {
if opts.Debug {
ctx = trace.WithLoggerLevel(ctx, logrus.DebugLevel)
} else if opts.Verbose {
ctx = trace.WithLoggerLevel(ctx, logrus.InfoLevel)
} else {
return ctx
}
return withExecutableTrace(ctx)
}
// withExecutableTrace adds tracing for credential helper executables.
func withExecutableTrace(ctx context.Context) context.Context {
logger := log.GetLogger(ctx)
ctx = credentialstrace.WithExecutableTrace(ctx, &credentialstrace.ExecutableTrace{
ExecuteStart: func(executableName, action string) {
logger.Debugf("started executing credential helper program %s with action %s", executableName, action)
},
ExecuteDone: func(executableName, action string, err error) {
if err != nil {
logger.Errorf("finished executing credential helper program %s with action %s and got error %w", executableName, action, err)
} else {
logger.Debugf("successfully finished executing credential helper program %s with action %s", executableName, action)
}
},
})
return ctx
}
|
