forked from k8sgpt-ai/k8sgpt
-
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.
test: added tests for the PDB analyzer
This commit introduces comprehensive tests for the `PodDisruptionBudget` analyzer defined in the `pkg/analyzer` package. Adding these tests increases the code coverage of the `pdb.go` file to >96%. Additionally, a potential crash in case of empty or nil PDB status conditions has been addressed. Partially addresses: k8sgpt-ai#889 Signed-off-by: VaibhavMalik4187 <vaibhavmalik2018@gmail.com>
- Loading branch information
1 parent
f5c3f18
commit 1b2a804
Showing
2 changed files
with
141 additions
and
0 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,136 @@ | ||
/* | ||
Copyright 2024 The K8sGPT 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 analyzer | ||
|
||
import ( | ||
"context" | ||
"testing" | ||
|
||
"github.com/k8sgpt-ai/k8sgpt/pkg/common" | ||
"github.com/k8sgpt-ai/k8sgpt/pkg/kubernetes" | ||
"github.com/stretchr/testify/require" | ||
policyv1 "k8s.io/api/policy/v1" | ||
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
"k8s.io/apimachinery/pkg/util/intstr" | ||
"k8s.io/client-go/kubernetes/fake" | ||
) | ||
|
||
type Expectations struct { | ||
name string | ||
failures []string | ||
} | ||
|
||
func TestPodDisruptionBudgetAnalyzer(t *testing.T) { | ||
config := common.Analyzer{ | ||
Client: &kubernetes.Client{ | ||
Client: fake.NewSimpleClientset( | ||
&policyv1.PodDisruptionBudget{ | ||
ObjectMeta: metav1.ObjectMeta{ | ||
Name: "PDB1", | ||
Namespace: "test", | ||
}, | ||
// Status conditions are nil. | ||
Status: policyv1.PodDisruptionBudgetStatus{ | ||
Conditions: nil, | ||
}, | ||
}, | ||
&policyv1.PodDisruptionBudget{ | ||
ObjectMeta: metav1.ObjectMeta{ | ||
Name: "PDB2", | ||
Namespace: "test", | ||
}, | ||
// Status conditions are empty. | ||
Status: policyv1.PodDisruptionBudgetStatus{ | ||
Conditions: []metav1.Condition{}, | ||
}, | ||
}, | ||
&policyv1.PodDisruptionBudget{ | ||
ObjectMeta: metav1.ObjectMeta{ | ||
Name: "PDB3", | ||
Namespace: "test", | ||
}, | ||
Status: policyv1.PodDisruptionBudgetStatus{ | ||
Conditions: []metav1.Condition{ | ||
{ | ||
Type: "DisruptionAllowed", | ||
Status: "False", | ||
Reason: "test reason", | ||
}, | ||
}, | ||
}, | ||
Spec: policyv1.PodDisruptionBudgetSpec{ | ||
MaxUnavailable: &intstr.IntOrString{ | ||
Type: 0, | ||
IntVal: 17, | ||
StrVal: "17", | ||
}, | ||
MinAvailable: &intstr.IntOrString{ | ||
Type: 0, | ||
IntVal: 7, | ||
StrVal: "7", | ||
}, | ||
// MatchLabels specified. | ||
Selector: &metav1.LabelSelector{ | ||
MatchLabels: map[string]string{ | ||
"label1": "test1", | ||
"label2": "test2", | ||
}, | ||
}, | ||
}, | ||
}, | ||
&policyv1.PodDisruptionBudget{ | ||
ObjectMeta: metav1.ObjectMeta{ | ||
Name: "PDB4", | ||
Namespace: "test", | ||
}, | ||
Status: policyv1.PodDisruptionBudgetStatus{ | ||
Conditions: []metav1.Condition{ | ||
{ | ||
Type: "DisruptionAllowed", | ||
Status: "False", | ||
Reason: "test reason", | ||
}, | ||
}, | ||
}, | ||
// Match Labels Empty. | ||
Spec: policyv1.PodDisruptionBudgetSpec{ | ||
Selector: &metav1.LabelSelector{}, | ||
}, | ||
}, | ||
), | ||
}, | ||
Context: context.Background(), | ||
Namespace: "test", | ||
} | ||
expectations := []Expectations{ | ||
{ | ||
name: "test/PDB3", | ||
failures: []string{ | ||
"test reason, expected pdb pod label label1=test1", | ||
"test reason, expected pdb pod label label2=test2", | ||
}, | ||
}, | ||
} | ||
|
||
pdbAnalyzer := PdbAnalyzer{} | ||
results, err := pdbAnalyzer.Analyze(config) | ||
require.NoError(t, err) | ||
|
||
for i, expectation := range expectations { | ||
require.Equal(t, expectation.name, results[i].Name) | ||
for j, failure := range expectation.failures { | ||
require.Equal(t, failure, results[i].Error[j].Text) | ||
} | ||
} | ||
} |