Skip to content

Added Scantype-Controller Test to test the RetriggerOnScanTypeChange Flag #983

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.

Sign up for GitHub

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
J12934 merged 1 commit into from
Feb 23, 2022
Merged

Added Scantype-Controller Test to test the RetriggerOnScanTypeChange Flag #983

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 43 additions & 2 deletions operator/controllers/execution/scantype_controller_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ var _ = Describe("ScanType controller", func() {

createNamespace(ctx, namespace)
createScanType(ctx, namespace)
scheduledScan := createScheduledScan(ctx, namespace)
scheduledScan := createScheduledScan(ctx, namespace, true)

// ensure that the ScheduledScan has been triggered
waitForScheduledScanToBeTriggered(ctx, namespace)
Expand Down Expand Up @@ -74,7 +74,7 @@ var _ = Describe("ScanType controller", func() {

createNamespace(ctx, namespace)
createScanType(ctx, namespace)
scheduledScan := createScheduledScan(ctx, namespace)
scheduledScan := createScheduledScan(ctx, namespace, true)

// ensure that the ScheduledScan has been triggered
waitForScheduledScanToBeTriggered(ctx, namespace)
Expand All @@ -96,6 +96,47 @@ var _ = Describe("ScanType controller", func() {
}, timeout, interval).Should(BeTrue(), "Scan was restarted without need")
})
})

Context("Should not trigger rescan when RetriggerOnScanTypeChange is set to False", func() {
It("Should restart a scheduledScan when RetriggerOnScanTypeChange is set to True", func() {
ctx := context.Background()
namespace := "scantype-retrigger-on-scantype-false-test"

createNamespace(ctx, namespace)
createScanType(ctx, namespace)
scheduledScan := createScheduledScan(ctx, namespace, false)

// ensure that the ScheduledScan has been triggered
waitForScheduledScanToBeTriggered(ctx, namespace)
k8sClient.Get(ctx, types.NamespacedName{Name: "test-scan", Namespace: namespace}, &scheduledScan)
initialExecutionTime := *scheduledScan.Status.LastScheduleTime

// wait at least one second to ensure that the unix timestamps are at least one second apart.
time.Sleep(1 * time.Second)

By("Update ScanType to trigger rescan")
var scanType executionv1.ScanType
k8sClient.Get(ctx, types.NamespacedName{Name: "nmap", Namespace: namespace}, &scanType)
if scanType.ObjectMeta.Annotations == nil {
scanType.ObjectMeta.Annotations = map[string]string{}
}
scanType.ObjectMeta.Annotations["foobar.securecodebox.io/example"] = "barfoo"
err := k8sClient.Update(ctx, &scanType)
if err != nil {
panic(err)
}

By("Controller should set the lastScheduled Timestamp to the past to force a re-scan")
Eventually(func() bool {
err := k8sClient.Get(ctx, types.NamespacedName{Name: "test-scan", Namespace: namespace}, &scheduledScan)
if errors.IsNotFound(err) {
panic("ScheduledScan should be present for this check!")
}

return scheduledScan.Status.LastScheduleTime.Unix() == initialExecutionTime.Unix()
}, timeout, interval).Should(BeTrue())
})
})
})

func waitForScheduledScanToBeTriggered(ctx context.Context, namespace string) {
Expand Down
4 changes: 2 additions & 2 deletions operator/controllers/execution/test_utils_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,15 +63,15 @@ func createScanType(ctx context.Context, namespace string) {
Expect(k8sClient.Create(ctx, scanType)).Should(Succeed())
}

func createScheduledScan(ctx context.Context, namespace string) executionv1.ScheduledScan {
func createScheduledScan(ctx context.Context, namespace string, retriggerOnScanTypeChange bool) executionv1.ScheduledScan {
scheduledScan := executionv1.ScheduledScan{
ObjectMeta: metav1.ObjectMeta{
Name: "test-scan",
Namespace: namespace,
},
Spec: executionv1.ScheduledScanSpec{
Interval: metav1.Duration{Duration: 42 * time.Hour},
RetriggerOnScanTypeChange: true,
RetriggerOnScanTypeChange: retriggerOnScanTypeChange,
ScanSpec: &executionv1.ScanSpec{
ScanType: "nmap",
Parameters: []string{"scanme.nmap.org"},
Expand Down