forked from radius-project/radius
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fixing the panic for annotations.Configuration (radius-project#6864)
# Description Fixing the panic for annotations.Configuration ## Type of change - This pull request is a minor refactor, code cleanup, test improvement, or other maintenance task and doesn't change the functionality of Radius (issue link optional). Fixes: #issue_number ## Auto-generated summary <!-- copilot:all --> ### <samp>🤖[[deprecated]](https://githubnext.com/copilot-for-prs-sunset) Generated by Copilot at 3f37db3</samp> ### Summary 🛡️🐛🚀 <!-- 1. 🛡️ - This emoji represents the defensive programming practice of avoiding nil pointer dereferences by initializing the field to an empty struct. 2. 🐛 - This emoji represents the bug fix of preventing potential panics when accessing the configuration subfields. 3. 🚀 - This emoji represents the improvement of the code quality and reliability by making it more robust and resilient to unexpected inputs. --> Fix possible nil pointer dereferences in deployment reconciler. Ensure `annotations.Configuration` is always initialized before accessing its subfields in `pkg/controller/reconciler/deployment_reconciler.go`. > _`Configuration` /_ > _may be nil, so we guard /_ > _against winter frost_ ### Walkthrough * Initialize configuration annotations field to avoid nil pointer dereferences ([link](https://github.com/radius-project/radius/pull/6864/files?diff=unified&w=0#diff-87a7dfa06c174a6b41b671b2cfffb84c81e481881baec866a026e7dd00db8195L251-R261)) Signed-off-by: ytimocin <[email protected]>
- Loading branch information
Showing
4 changed files
with
343 additions
and
8 deletions.
There are no files selected for viewing
This file contains 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 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,167 @@ | ||
| /* | ||
| Copyright 2023. | ||
| 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 reconciler | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "fmt" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
| appsv1 "k8s.io/api/apps/v1" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| ) | ||
|
|
||
| func Test_readAnnotations(t *testing.T) { | ||
| testDeploymentStatus := &deploymentStatus{ | ||
| Scope: "/planes/radius/local/resourceGroups/controller-test", | ||
| Application: "test-application", | ||
| Environment: "test-environment", | ||
| Container: "test-container", | ||
| Operation: nil, | ||
| Phrase: deploymentPhraseReady, | ||
| } | ||
|
|
||
| dsm, err := json.Marshal(testDeploymentStatus) | ||
| require.NoError(t, err) | ||
|
|
||
| // invalidDeploymentStatus is missing a curly brace at the end of the JSON | ||
| // so that an unmarshaling error can be triggered. | ||
| invalidDeploymentStatus := []byte(`{"invalid": "json"`) | ||
|
|
||
| tests := []struct { | ||
| name string | ||
| deployment *appsv1.Deployment | ||
| annotations deploymentAnnotations | ||
| err error | ||
| }{ | ||
| { | ||
| name: "radius-disabled-with-annotation", | ||
| deployment: &appsv1.Deployment{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Annotations: map[string]string{ | ||
| AnnotationRadiusEnabled: "false", | ||
| }, | ||
| }, | ||
| }, | ||
| annotations: deploymentAnnotations{ | ||
| Configuration: nil, | ||
| ConfigurationHash: "", | ||
| Status: nil, | ||
| }, | ||
| err: nil, | ||
| }, | ||
| { | ||
| name: "radius-disabled-empty-annotation-map", | ||
| deployment: &appsv1.Deployment{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Annotations: map[string]string{}, | ||
| }, | ||
| }, | ||
| annotations: deploymentAnnotations{ | ||
| Configuration: nil, | ||
| ConfigurationHash: "", | ||
| Status: nil, | ||
| }, | ||
| err: nil, | ||
| }, | ||
| { | ||
| name: "radius-disabled-no-annotations", | ||
| deployment: &appsv1.Deployment{ | ||
| ObjectMeta: metav1.ObjectMeta{}, | ||
| }, | ||
| annotations: deploymentAnnotations{ | ||
| Configuration: nil, | ||
| ConfigurationHash: "", | ||
| Status: nil, | ||
| }, | ||
| err: nil, | ||
| }, | ||
| { | ||
| name: "radius-was-enabled-now-disabled-with-annotations", | ||
| deployment: &appsv1.Deployment{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Annotations: map[string]string{ | ||
| AnnotationRadiusEnabled: "false", | ||
| AnnotationRadiusConfigurationHash: "configuration-hash", | ||
| AnnotationRadiusStatus: string(dsm), | ||
| }, | ||
| }, | ||
| }, | ||
| annotations: deploymentAnnotations{ | ||
| Configuration: nil, | ||
| ConfigurationHash: "configuration-hash", | ||
| Status: testDeploymentStatus, | ||
| }, | ||
| err: nil, | ||
| }, | ||
| { | ||
| name: "radius-enabled-with-annotations", | ||
| deployment: &appsv1.Deployment{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Annotations: map[string]string{ | ||
| AnnotationRadiusEnabled: "true", | ||
| AnnotationRadiusConfigurationHash: "configuration-hash", | ||
| AnnotationRadiusStatus: string(dsm), | ||
| AnnotationRadiusApplication: "test-application", | ||
| AnnotationRadiusEnvironment: "test-environment", | ||
| AnnotationRadiusConnectionPrefix + "test-connection": "test-connection-value", | ||
| }, | ||
| }, | ||
| }, | ||
| annotations: deploymentAnnotations{ | ||
| Configuration: &deploymentConfiguration{ | ||
| Environment: "test-environment", | ||
| Application: "test-application", | ||
| Connections: map[string]string{ | ||
| "test-connection": "test-connection-value", | ||
| }, | ||
| }, | ||
| ConfigurationHash: "configuration-hash", | ||
| Status: testDeploymentStatus, | ||
| }, | ||
| err: nil, | ||
| }, | ||
| { | ||
| name: "status-unmarshal-error", | ||
| deployment: &appsv1.Deployment{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Annotations: map[string]string{ | ||
| AnnotationRadiusEnabled: "true", | ||
| AnnotationRadiusConfigurationHash: "configuration-hash", | ||
| AnnotationRadiusStatus: string(invalidDeploymentStatus), | ||
| AnnotationRadiusApplication: "test-application", | ||
| AnnotationRadiusEnvironment: "test-environment", | ||
| AnnotationRadiusConnectionPrefix + "test-connection": "test-connection-value", | ||
| }, | ||
| }, | ||
| }, | ||
| annotations: deploymentAnnotations{ | ||
| ConfigurationHash: "configuration-hash", | ||
| }, | ||
| err: fmt.Errorf("failed to unmarshal status annotation: %w", | ||
| json.Unmarshal(invalidDeploymentStatus, &deploymentStatus{})), | ||
| }, | ||
| } | ||
| for _, tt := range tests { | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| annotations, err := readAnnotations(tt.deployment) | ||
| require.Equal(t, tt.err, err) | ||
| require.Equal(t, tt.annotations, annotations) | ||
| }) | ||
| } | ||
| } |
This file contains 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
Oops, something went wrong.