-
Notifications
You must be signed in to change notification settings - Fork 27
Consolidate the OidcAuthentication properties on FeedResource into a single property #341
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
0b9d61e
Pulls Oidc Auth into a single property under Feed Resource to handle …
IsaacCalligeros95 9b8d637
Explicitly check oidcAuth is nil on NewAwsECR method. Handles case of…
IsaacCalligeros95 3067396
undo
IsaacCalligeros95 6a2204a
Fix failing tests
IsaacCalligeros95 9aa2a03
Fix GCR feed type
IsaacCalligeros95 1165314
Fix unneccesary unmarshalling
IsaacCalligeros95 aae3ca8
Reintroduce unmarshalling
IsaacCalligeros95 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,200 @@ | ||
| package feeds | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| ) | ||
|
|
||
| // OidcAuthentication represents a union type that can hold any of the three OIDC authentication types | ||
| // The properties are flattened at the top level for API compatibility | ||
| type OidcAuthentication struct { | ||
| // Type indicates which OIDC authentication type this represents | ||
| Type OidcAuthenticationType `json:"Type"` | ||
|
|
||
| // Common fields across all OIDC types | ||
| Audience string `json:"Audience,omitempty"` | ||
| SubjectKeys []string `json:"SubjectKeys,omitempty"` | ||
|
|
||
| // Azure-specific fields | ||
| ClientId string `json:"ClientId,omitempty"` | ||
| TenantId string `json:"TenantId,omitempty"` | ||
|
|
||
| // AWS-specific fields | ||
| SessionDuration string `json:"SessionDuration,omitempty"` | ||
| RoleArn string `json:"RoleArn,omitempty"` | ||
| } | ||
|
|
||
| // OidcAuthenticationType represents the type of OIDC authentication | ||
| type OidcAuthenticationType string | ||
|
|
||
| const ( | ||
| OidcAuthenticationTypeAzure OidcAuthenticationType = "Azure" | ||
| OidcAuthenticationTypeAWS OidcAuthenticationType = "AWS" | ||
| OidcAuthenticationTypeGoogle OidcAuthenticationType = "Google" | ||
| ) | ||
|
|
||
| // NewAzureOidcAuthentication creates a new OIDC authentication for Azure | ||
| func NewAzureOidcAuthentication(clientId, tenantId, audience string, subjectKeys []string) *OidcAuthentication { | ||
| return &OidcAuthentication{ | ||
| Type: OidcAuthenticationTypeAzure, | ||
| ClientId: clientId, | ||
| TenantId: tenantId, | ||
| Audience: audience, | ||
| SubjectKeys: subjectKeys, | ||
| } | ||
| } | ||
|
|
||
| // NewAwsOidcAuthentication creates a new OIDC authentication for AWS | ||
| func NewAwsOidcAuthentication(sessionDuration, audience, roleArn string, subjectKeys []string) *OidcAuthentication { | ||
| return &OidcAuthentication{ | ||
| Type: OidcAuthenticationTypeAWS, | ||
| SessionDuration: sessionDuration, | ||
| Audience: audience, | ||
| RoleArn: roleArn, | ||
| SubjectKeys: subjectKeys, | ||
| } | ||
| } | ||
|
|
||
| // NewGoogleOidcAuthentication creates a new OIDC authentication for Google | ||
| func NewGoogleOidcAuthentication(audience string, subjectKeys []string) *OidcAuthentication { | ||
| return &OidcAuthentication{ | ||
| Type: OidcAuthenticationTypeGoogle, | ||
| Audience: audience, | ||
| SubjectKeys: subjectKeys, | ||
| } | ||
| } | ||
|
|
||
| // GetAzure returns the Azure OIDC authentication data if this is an Azure type | ||
| func (o *OidcAuthentication) GetAzure() (*AzureContainerRegistryOidcAuthentication, bool) { | ||
| if o.Type == OidcAuthenticationTypeAzure { | ||
| return &AzureContainerRegistryOidcAuthentication{ | ||
| ClientId: o.ClientId, | ||
| TenantId: o.TenantId, | ||
| Audience: o.Audience, | ||
| SubjectKeys: o.SubjectKeys, | ||
| }, true | ||
| } | ||
| return nil, false | ||
| } | ||
|
|
||
| // GetAWS returns the AWS OIDC authentication data if this is an AWS type | ||
| func (o *OidcAuthentication) GetAWS() (*AwsElasticContainerRegistryOidcAuthentication, bool) { | ||
| if o.Type == OidcAuthenticationTypeAWS { | ||
| return &AwsElasticContainerRegistryOidcAuthentication{ | ||
| SessionDuration: o.SessionDuration, | ||
| Audience: o.Audience, | ||
| SubjectKeys: o.SubjectKeys, | ||
| RoleArn: o.RoleArn, | ||
| }, true | ||
| } | ||
| return nil, false | ||
| } | ||
|
|
||
| // GetGoogle returns the Google OIDC authentication data if this is a Google type | ||
| func (o *OidcAuthentication) GetGoogle() (*GoogleContainerRegistryOidcAuthentication, bool) { | ||
| if o.Type == OidcAuthenticationTypeGoogle { | ||
| return &GoogleContainerRegistryOidcAuthentication{ | ||
| Audience: o.Audience, | ||
| SubjectKeys: o.SubjectKeys, | ||
| }, true | ||
| } | ||
| return nil, false | ||
| } | ||
|
|
||
| // MarshalJSON implements custom JSON marshaling to handle the union type | ||
| func (o *OidcAuthentication) MarshalJSON() ([]byte, error) { | ||
| // Create a map to hold the fields we want to serialize | ||
| result := make(map[string]interface{}) | ||
|
|
||
| // Always include the Type field | ||
| result["Type"] = o.Type | ||
|
|
||
| // Add common fields | ||
| if o.Audience != "" { | ||
| result["Audience"] = o.Audience | ||
| } | ||
| if len(o.SubjectKeys) > 0 { | ||
| result["SubjectKeys"] = o.SubjectKeys | ||
| } | ||
|
|
||
| // Add type-specific fields based on the type | ||
| switch o.Type { | ||
| case OidcAuthenticationTypeAzure: | ||
| if o.ClientId != "" { | ||
| result["ClientId"] = o.ClientId | ||
| } | ||
| if o.TenantId != "" { | ||
| result["TenantId"] = o.TenantId | ||
| } | ||
| case OidcAuthenticationTypeAWS: | ||
| if o.SessionDuration != "" { | ||
| result["SessionDuration"] = o.SessionDuration | ||
| } | ||
| if o.RoleArn != "" { | ||
| result["RoleArn"] = o.RoleArn | ||
| } | ||
| case OidcAuthenticationTypeGoogle: | ||
| // Google only has common fields, no additional ones | ||
| } | ||
|
|
||
| return json.Marshal(result) | ||
| } | ||
|
|
||
| // UnmarshalJSON implements custom JSON unmarshaling to handle the union type | ||
| func (o *OidcAuthentication) UnmarshalJSON(data []byte) error { | ||
| if len(data) == 0 || string(data) == "null" { | ||
| *o = OidcAuthentication{} | ||
| return nil | ||
| } | ||
|
|
||
| // First, unmarshal into a map to inspect the fields | ||
| var raw map[string]interface{} | ||
| if err := json.Unmarshal(data, &raw); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| // Discriminate based on properties. This is hacky, but we would have to add a "Type" property to the API | ||
| // To handle this properly | ||
| if _, hasClientId := raw["ClientId"]; hasClientId { | ||
| o.Type = OidcAuthenticationTypeAzure | ||
| } else if _, hasRoleArn := raw["RoleArn"]; hasRoleArn { | ||
| o.Type = OidcAuthenticationTypeAWS | ||
| } else { | ||
| o.Type = OidcAuthenticationTypeGoogle | ||
| } | ||
|
|
||
| // Now unmarshal into the appropriate struct to get all fields | ||
| switch o.Type { | ||
| case OidcAuthenticationTypeAzure: | ||
| var azure AzureContainerRegistryOidcAuthentication | ||
| if err := json.Unmarshal(data, &azure); err != nil { | ||
| return err | ||
| } | ||
| o.Type = OidcAuthenticationTypeAzure | ||
|
IsaacCalligeros95 marked this conversation as resolved.
|
||
| o.ClientId = azure.ClientId | ||
| o.TenantId = azure.TenantId | ||
| o.Audience = azure.Audience | ||
| o.SubjectKeys = azure.SubjectKeys | ||
|
|
||
| case OidcAuthenticationTypeAWS: | ||
| var aws AwsElasticContainerRegistryOidcAuthentication | ||
| if err := json.Unmarshal(data, &aws); err != nil { | ||
| return err | ||
| } | ||
| o.Type = OidcAuthenticationTypeAWS | ||
| o.SessionDuration = aws.SessionDuration | ||
| o.Audience = aws.Audience | ||
| o.SubjectKeys = aws.SubjectKeys | ||
| o.RoleArn = aws.RoleArn | ||
|
|
||
| case OidcAuthenticationTypeGoogle: | ||
| var google GoogleContainerRegistryOidcAuthentication | ||
| if err := json.Unmarshal(data, &google); err != nil { | ||
| return err | ||
| } | ||
| o.Type = OidcAuthenticationTypeGoogle | ||
| o.Audience = google.Audience | ||
| o.SubjectKeys = google.SubjectKeys | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you also need to check that the value isn't empty?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, the ClientId can be empty, but the field is still returned on the OidcAuthentication object and used as the discriminator to get the type
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh, didn't realise ClientId was optional. In either case, just flagging this up as a small regression risk as we need to be careful that other shapes aren't changed at any point to include null/undefined/empty properties which could trigger the wrong conditional (seems unlikely, but possible). I'm not sure what to suggest for optional fields, though.