From e1c94c200ccead25889d48823785a14846c7a1eb Mon Sep 17 00:00:00 2001 From: iseki Date: Mon, 3 Jun 2024 14:58:35 +0800 Subject: [PATCH] refactor: split constants to env package --- cmd/murphy/root.go | 2 +- config/tokenfile.go | 3 ++- env/common.go | 2 -- env/constants.go | 7 +++++++ inspector/textual_formatter.go | 3 ++- logger/log_file.go | 3 ++- version/version.go | 3 ++- 7 files changed, 16 insertions(+), 7 deletions(-) create mode 100644 env/constants.go diff --git a/cmd/murphy/root.go b/cmd/murphy/root.go index 4bbe5fe8..455bd371 100644 --- a/cmd/murphy/root.go +++ b/cmd/murphy/root.go @@ -38,7 +38,7 @@ func preRun(cmd *cobra.Command, args []string) error { func rootCmd() *cobra.Command { c := &cobra.Command{ - Use: "murphysec", + Use: env.RootCommand, PersistentPreRunE: preRun, TraverseChildren: true, Run: func(cmd *cobra.Command, args []string) { diff --git a/config/tokenfile.go b/config/tokenfile.go index eecf974d..9b80f8dc 100644 --- a/config/tokenfile.go +++ b/config/tokenfile.go @@ -3,6 +3,7 @@ package config import ( "context" "github.com/mitchellh/go-homedir" + "github.com/murphysecurity/murphysec/env" "github.com/murphysecurity/murphysec/infra/logctx" "github.com/murphysecurity/murphysec/utils" "io" @@ -13,7 +14,7 @@ import ( ) const ( - DefaultTokenFile = "~/.murphysec/token" + DefaultTokenFile = "~/" + env.HomeSubdir + "/token" TokenFileMaxSize = 1 * 1024 ) diff --git a/env/common.go b/env/common.go index db13bc08..eca90236 100644 --- a/env/common.go +++ b/env/common.go @@ -14,8 +14,6 @@ func envi(name string, defaultValue int) int { } } -const DefaultServerURL = "https://www.murphysec.com" - var ServerURLOverride = os.Getenv("MPS_CLI_SERVER") var APITokenOverride = os.Getenv("API_TOKEN") var ScannerScan = false diff --git a/env/constants.go b/env/constants.go new file mode 100644 index 00000000..db08a7b4 --- /dev/null +++ b/env/constants.go @@ -0,0 +1,7 @@ +package env + +const RootCommand = "murphysec" +const UserAgentPrefix = "murphy-cli" +const SpdxName = "com.github.murphysecurity/murphysec" +const HomeSubdir = ".murphysec" +const DefaultServerURL = "https://www.murphysec.com" diff --git a/inspector/textual_formatter.go b/inspector/textual_formatter.go index eab879ed..c54a55f6 100644 --- a/inspector/textual_formatter.go +++ b/inspector/textual_formatter.go @@ -3,6 +3,7 @@ package inspector import ( "encoding/json" "fmt" + "github.com/murphysecurity/murphysec/env" "github.com/murphysecurity/murphysec/model" "time" ) @@ -103,7 +104,7 @@ func BuildSpdx(task *model.ScanTask) []byte { "created": time.Now(), "creators": []string{"Tool: murphysec-cli"}, }, - "name": "com.github.murphysecurity/murphysec", + "name": env.SpdxName, "dataLicense": "CC0-1.0", "packages": packages, "relationships": relationships, diff --git a/logger/log_file.go b/logger/log_file.go index d0820506..51e397b5 100644 --- a/logger/log_file.go +++ b/logger/log_file.go @@ -3,6 +3,7 @@ package logger import ( "fmt" "github.com/mitchellh/go-homedir" + "github.com/murphysecurity/murphysec/env" "github.com/murphysecurity/murphysec/errors" "github.com/murphysecurity/murphysec/utils/must" "os" @@ -12,7 +13,7 @@ import ( "time" ) -const defaultLogFilePath = ".murphysec/logs" +const defaultLogFilePath = env.HomeSubdir + "/logs" // CreateLogFile create log file. If _filepath is empty, use default log path func CreateLogFile(_filepath string) (_ *os.File, err error) { diff --git a/version/version.go b/version/version.go index 75e655e8..4cf40b63 100644 --- a/version/version.go +++ b/version/version.go @@ -2,12 +2,13 @@ package version import ( "github.com/iseki0/osname" + "github.com/murphysecurity/murphysec/env" "github.com/murphysecurity/murphysec/infra/buildinfo" "runtime" "strings" ) -const name = "murphysec-cli" +const name = env.UserAgentPrefix var userAgent string