Skip to content

Commit 1e897b4

Browse files
EyalDelareaEyalDelarea
committed
rename oidc config params to be more specific & update usage params
1 parent 46e6fb0 commit 1e897b4

File tree

8 files changed

+22
-26
lines changed

8 files changed

+22
-26
lines changed

‎common/commands/config.go‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ type ConfigCommand struct {
6666
// For unit tests
6767
disablePrompts bool
6868
cmdType ConfigAction
69-
oidcSetupParams *generic.OidcTokenParams
69+
oidcSetupParams *generic.ConfigOidcParams
7070
}
7171

7272
func NewConfigCommand(cmdType ConfigAction, serverId string) *ConfigCommand {
@@ -300,7 +300,7 @@ func (cc *ConfigCommand) prepareConfigurationData() ([]*config.ServerDetails, er
300300
if cc.defaultDetails != nil {
301301
cc.details.InsecureTls = cc.defaultDetails.InsecureTls
302302
}
303-
cc.oidcSetupParams = new(generic.OidcTokenParams)
303+
cc.oidcSetupParams = new(generic.ConfigOidcParams)
304304
}
305305

306306
// Get configurations list
@@ -847,7 +847,7 @@ func (cc *ConfigCommand) handleWebLogin() error {
847847
return nil
848848
}
849849

850-
func (cc *ConfigCommand) SetOIDCParams(oidcDetails *generic.OidcTokenParams) *ConfigCommand {
850+
func (cc *ConfigCommand) SetOIDCParams(oidcDetails *generic.ConfigOidcParams) *ConfigCommand {
851851
cc.oidcSetupParams = oidcDetails
852852
return cc
853853
}
@@ -887,7 +887,7 @@ func assertSingleAuthMethod(details *config.ServerDetails) error {
887887

888888
type ConfigCommandConfiguration struct {
889889
ServerDetails *config.ServerDetails
890-
OidcParams *generic.OidcTokenParams
890+
OidcParams *generic.ConfigOidcParams
891891
Interactive bool
892892
EncPassword bool
893893
BasicAuthOnly bool
@@ -905,7 +905,7 @@ func GetAllServerIds() []string {
905905
return serverIds
906906
}
907907

908-
func validateOidcParams(platformUrl string, oidcParams *generic.OidcTokenParams) error {
908+
func validateOidcParams(platformUrl string, oidcParams *generic.ConfigOidcParams) error {
909909
if platformUrl == "" {
910910
return errorutils.CheckErrorf("the --url flag must be provided when --oidc-provider is used")
911911
}

‎common/commands/config_test.go‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -351,14 +351,14 @@ func TestValidateOidcParams(t *testing.T) {
351351
testsCases := []struct {
352352
name string
353353
platformUrl string
354-
oidcParams *token.OidcTokenParams
354+
oidcParams *token.ConfigOidcParams
355355
expectError bool
356356
errContains string
357357
}{
358358
{
359359
name: "All parameters set",
360360
platformUrl: "https://my.jfrog.com",
361-
oidcParams: &token.OidcTokenParams{
361+
oidcParams: &token.ConfigOidcParams{
362362
TokenId: "token123",
363363
ProviderName: "MyProvider",
364364
},
@@ -367,7 +367,7 @@ func TestValidateOidcParams(t *testing.T) {
367367
{
368368
name: "Missing platform URL",
369369
platformUrl: "",
370-
oidcParams: &token.OidcTokenParams{
370+
oidcParams: &token.ConfigOidcParams{
371371
TokenId: "token123",
372372
ProviderName: "MyProvider",
373373
},
@@ -377,7 +377,7 @@ func TestValidateOidcParams(t *testing.T) {
377377
{
378378
name: "Missing OIDC Token ID",
379379
platformUrl: "https://my.jfrog.com",
380-
oidcParams: &token.OidcTokenParams{
380+
oidcParams: &token.ConfigOidcParams{
381381
TokenId: "",
382382
ProviderName: "MyProvider",
383383
},
@@ -387,7 +387,7 @@ func TestValidateOidcParams(t *testing.T) {
387387
{
388388
name: "Missing OIDC Provider Name",
389389
platformUrl: "https://my.jfrog.com",
390-
oidcParams: &token.OidcTokenParams{
390+
oidcParams: &token.ConfigOidcParams{
391391
TokenId: "token123",
392392
ProviderName: "",
393393
},

‎general/token/oidctokenexchange.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,12 @@ func OidcProviderTypeFromString(providerType string) (OidcProviderType, error) {
4747
}
4848

4949
type OidcTokenExchangeCommand struct {
50-
*OidcTokenParams
50+
*ConfigOidcParams
5151
serverDetails *config.ServerDetails
5252
response *auth.OidcTokenResponseData
5353
}
5454

55-
type OidcTokenParams struct {
55+
type ConfigOidcParams struct {
5656
ProviderType OidcProviderType
5757
ProviderName string
5858
TokenId string
@@ -66,7 +66,7 @@ type OidcTokenParams struct {
6666
}
6767

6868
func NewOidcTokenExchangeCommand() *OidcTokenExchangeCommand {
69-
return &OidcTokenExchangeCommand{response: new(auth.OidcTokenResponseData), OidcTokenParams: &OidcTokenParams{}}
69+
return &OidcTokenExchangeCommand{response: new(auth.OidcTokenResponseData), ConfigOidcParams: &ConfigOidcParams{}}
7070
}
7171

7272
func (otc *OidcTokenExchangeCommand) SetServerDetails(serverDetails *config.ServerDetails) *OidcTokenExchangeCommand {

‎general/utils_test.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ func TestDeduceServerId(t *testing.T) {
2929

3030
func TestSetProviderTypeAsString_CaseInsensitive(t *testing.T) {
3131
cmd := token.NewOidcTokenExchangeCommand()
32-
cmd.OidcTokenParams = &token.OidcTokenParams{}
32+
cmd.ConfigOidcParams = &token.ConfigOidcParams{}
3333

3434
testCases := []struct {
3535
input string

‎go.mod‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ require (
114114
sigs.k8s.io/yaml v1.4.0 // indirect
115115
)
116116

117-
replace github.com/jfrog/jfrog-client-go => github.com/eyaldelarea/jfrog-client-go v1.28.1-0.20250331065416-fc01ce0b98d2
117+
replace github.com/jfrog/jfrog-client-go => github.com/eyaldelarea/jfrog-client-go v1.28.1-0.20250401135859-aef6525515a2
118118

119119
// replace github.com/jfrog/build-info-go => github.com/jfrog/build-info-go v1.8.9-0.20250226091544-c803cbbc5495
120120

‎go.sum‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,8 @@ github.com/elazarl/goproxy v1.4.0 h1:4GyuSbFa+s26+3rmYNSuUVsx+HgPrV1bk1jXI0l9wjM
5454
github.com/elazarl/goproxy v1.4.0/go.mod h1:X/5W/t+gzDyLfHW4DrMdpjqYjpXsURlBt9lpBDxZZZQ=
5555
github.com/emirpasic/gods v1.18.1 h1:FXtiHYKDGKCW2KzwZKx0iC0PQmdlorYgdFG9jPXJ1Bc=
5656
github.com/emirpasic/gods v1.18.1/go.mod h1:8tpGGwCnJ5H4r6BWwaV6OrWmMoPhUl5jm/FMNAnJvWQ=
57-
github.com/eyaldelarea/jfrog-client-go v1.28.1-0.20250331065416-fc01ce0b98d2 h1:rO/QmCuFAaa5SRKwI+lpcjIHMsHJs+HO5tYEpXxuIhE=
58-
github.com/eyaldelarea/jfrog-client-go v1.28.1-0.20250331065416-fc01ce0b98d2/go.mod h1:2tQPwRhGS/F357BOKFfZrQbjd4XbzHPYUQm/OFNwLHg=
57+
github.com/eyaldelarea/jfrog-client-go v1.28.1-0.20250401135859-aef6525515a2 h1:344RWRiUNXGbksuhilim3QM4RFSeaYgLOHKkJp+kHEk=
58+
github.com/eyaldelarea/jfrog-client-go v1.28.1-0.20250401135859-aef6525515a2/go.mod h1:2tQPwRhGS/F357BOKFfZrQbjd4XbzHPYUQm/OFNwLHg=
5959
github.com/forPelevin/gomoji v1.2.0 h1:9k4WVSSkE1ARO/BWywxgEUBvR/jMnao6EZzrql5nxJ8=
6060
github.com/forPelevin/gomoji v1.2.0/go.mod h1:8+Z3KNGkdslmeGZBC3tCrwMrcPy5GRzAD+gL9NAwMXg=
6161
github.com/frankban/quicktest v1.14.6 h1:7Xjx+VpznH+oBnejlPUj8oUpdxnVs4f8XU8WnHkI4W8=

‎utils/usage/visibility/commands_count_metric.go‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ type commandsCountLabels struct {
1010
ProductID string `json:"product_id"`
1111
ProductVersion string `json:"product_version"`
1212
FeatureID string `json:"feature_id"`
13-
OIDCUsed string `json:"oidc_used"`
1413
JobID string `json:"job_id"`
1514
RunID string `json:"run_id"`
1615
GitRepo string `json:"git_repo"`
@@ -25,9 +24,8 @@ func NewCommandsCountMetric(commandName string) services.VisibilityMetric {
2524
ProductID: coreutils.GetCliUserAgentName(),
2625
ProductVersion: coreutils.GetCliUserAgentVersion(),
2726
FeatureID: commandName,
28-
OIDCUsed: os.Getenv("JFROG_CLI_USAGE_OIDC_USED"),
29-
JobID: os.Getenv("JFROG_CLI_USAGE_JOB_ID"),
30-
RunID: os.Getenv("JFROG_CLI_USAGE_RUN_ID"),
27+
JobID: os.Getenv("JFROG_CLI_CI_JOB_ID"),
28+
RunID: os.Getenv("JFROG_CLI_CI_RUN_ID"),
3129
GitRepo: os.Getenv("JFROG_CLI_USAGE_GIT_REPO"),
3230
GhTokenForCodeScanningAlertsProvided: os.Getenv("JFROG_CLI_USAGE_GH_TOKEN_FOR_CODE_SCANNING_ALERTS_PROVIDED"),
3331
},

‎utils/usage/visibility/commands_count_metric_test.go‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,9 @@ import (
1111
func TestCreateCommandsCountMetric(t *testing.T) {
1212
// Set environment variables for the test using SetEnvWithCallbackAndAssert
1313
envVars := map[string]string{
14-
"JFROG_CLI_USAGE_OIDC_USED": "TRUE",
15-
"JFROG_CLI_USAGE_JOB_ID": "job123",
16-
"JFROG_CLI_USAGE_RUN_ID": "run456",
17-
"JFROG_CLI_USAGE_GIT_REPO": "test-repo",
14+
"JFROG_CLI_CI_JOB_ID": "job123",
15+
"JFROG_CLI_CI_RUN_ID": "run456",
16+
"JFROG_CLI_USAGE_GIT_REPO": "test-repo",
1817
"JFROG_CLI_USAGE_GH_TOKEN_FOR_CODE_SCANNING_ALERTS_PROVIDED": "TRUE",
1918
}
2019
cleanupFuncs := []func(){}
@@ -41,7 +40,6 @@ func TestCreateCommandsCountMetric(t *testing.T) {
4140
"product_id": "` + coreutils.GetCliUserAgentName() + `",
4241
"product_version": "` + coreutils.GetCliUserAgentVersion() + `",
4342
"feature_id": "testCommand",
44-
"oidc_used": "TRUE",
4543
"job_id": "job123",
4644
"run_id": "run456",
4745
"git_repo": "test-repo",

0 commit comments

Comments
 (0)