Skip to content

Commit

Permalink
Add tests for handleJob:
Browse files Browse the repository at this point in the history 
Signed-off-by: Jacob Weinstock <[email protected]>
  • Loading branch information
@jacobweinstock
jacobweinstock committed Oct 10, 2024
1 parent 00eee39 commit cdd0ad7
Show file tree
Hide file tree
Showing 2 changed files with 229 additions and 1 deletion.
2 changes: 1 addition & 1 deletion internal/deprecated/workflow/job.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ func (s *state) createJob(ctx context.Context, actions []rufio.Action, name jobN
return reconcile.Result{}, fmt.Errorf("hardware is nil")

Check warning on line 126 in internal/deprecated/workflow/job.go

View check run for this annotation

Codecov / codecov/patch

internal/deprecated/workflow/job.go#L126 

Added line #L126 was not covered by tests
}
if s.hardware.Spec.BMCRef == nil {
return reconcile.Result{}, fmt.Errorf("hardware %s does not have a BMC", s.hardware.Name)
return reconcile.Result{}, fmt.Errorf("hardware %q does not have a BMC", s.hardware.Name)

Check warning on line 129 in internal/deprecated/workflow/job.go

View check run for this annotation

Codecov / codecov/patch

internal/deprecated/workflow/job.go#L129 

Added line #L129 was not covered by tests
}

if err := create(ctx, s.client, name.String(), s.hardware, s.workflow.Namespace, actions); err != nil {
Expand Down
228 changes: 228 additions & 0 deletions internal/deprecated/workflow/job_test.go
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,228 @@
package workflow

import (
"context"
"testing"

"github.com/google/go-cmp/cmp"
"github.com/google/go-cmp/cmp/cmpopts"
rufio "github.com/tinkerbell/rufio/api/v1alpha1"
"github.com/tinkerbell/tink/api/v1alpha1"
v1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/types"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
)

func TestHandleJob(t *testing.T) {
tests := map[string]struct {
workflow *v1alpha1.Workflow
wantWorkflow *v1alpha1.WorkflowStatus
hardware *v1alpha1.Hardware
actions []rufio.Action
name jobName
wantError bool
wantResult reconcile.Result
job *rufio.Job
}{
"existing job deleted, new job created and completed": {
workflow: &v1alpha1.Workflow{
Status: v1alpha1.WorkflowStatus{
BootOptions: v1alpha1.BootOptionsStatus{
Jobs: map[string]v1alpha1.JobStatus{
jobNameNetboot.String(): {
ExistingJobDeleted: true,
UID: types.UID("1234"),
Complete: true,
},
},
AllowNetboot: v1alpha1.AllowNetbootStatus{},
},
},
},
wantWorkflow: &v1alpha1.WorkflowStatus{
BootOptions: v1alpha1.BootOptionsStatus{
Jobs: map[string]v1alpha1.JobStatus{
jobNameNetboot.String(): {
ExistingJobDeleted: true,
UID: types.UID("1234"),
Complete: true,
},
},
AllowNetboot: v1alpha1.AllowNetbootStatus{},
},
},
hardware: &v1alpha1.Hardware{
ObjectMeta: metav1.ObjectMeta{
Name: "test-hardware",
Namespace: "default",
},
Spec: v1alpha1.HardwareSpec{
BMCRef: &v1.TypedLocalObjectReference{
Name: "test-bmc",
Kind: "machine.bmc.tinkerbell.org",
},
},
},
name: jobNameNetboot,
wantResult: reconcile.Result{Requeue: true},
},
"existing job not deleted": {
workflow: &v1alpha1.Workflow{
Status: v1alpha1.WorkflowStatus{
BootOptions: v1alpha1.BootOptionsStatus{
Jobs: map[string]v1alpha1.JobStatus{
jobNameNetboot.String(): {},
},
AllowNetboot: v1alpha1.AllowNetbootStatus{},
},
},
},
wantWorkflow: &v1alpha1.WorkflowStatus{
BootOptions: v1alpha1.BootOptionsStatus{
Jobs: map[string]v1alpha1.JobStatus{
jobNameNetboot.String(): {
ExistingJobDeleted: true,
},
},
AllowNetboot: v1alpha1.AllowNetbootStatus{},
},
},
name: jobNameNetboot,
wantResult: reconcile.Result{Requeue: true},
},
"existing job deleted, create new job": {
workflow: &v1alpha1.Workflow{
Status: v1alpha1.WorkflowStatus{
BootOptions: v1alpha1.BootOptionsStatus{
Jobs: map[string]v1alpha1.JobStatus{
jobNameNetboot.String(): {
ExistingJobDeleted: true,
},
},
AllowNetboot: v1alpha1.AllowNetbootStatus{},
},
},
},
wantWorkflow: &v1alpha1.WorkflowStatus{
Conditions: []v1alpha1.WorkflowCondition{
{
Type: v1alpha1.NetbootJobSetupComplete,
Status: metav1.ConditionTrue,
Reason: "Created",
Message: "job created",
},
},
BootOptions: v1alpha1.BootOptionsStatus{
Jobs: map[string]v1alpha1.JobStatus{
jobNameNetboot.String(): {
ExistingJobDeleted: true,
},
},
AllowNetboot: v1alpha1.AllowNetbootStatus{},
},
},
hardware: &v1alpha1.Hardware{
ObjectMeta: metav1.ObjectMeta{
Name: "test-hardware",
Namespace: "default",
},
Spec: v1alpha1.HardwareSpec{
BMCRef: &v1.TypedLocalObjectReference{
Name: "test-bmc",
Kind: "machine.bmc.tinkerbell.org",
},
},
},
actions: []rufio.Action{},
name: jobNameNetboot,
wantResult: reconcile.Result{Requeue: true},
},
"existing job deleted, new job created": {
workflow: &v1alpha1.Workflow{
ObjectMeta: metav1.ObjectMeta{
Namespace: "default",
},
Status: v1alpha1.WorkflowStatus{
BootOptions: v1alpha1.BootOptionsStatus{
Jobs: map[string]v1alpha1.JobStatus{
jobNameNetboot.String(): {
ExistingJobDeleted: true,
UID: types.UID("1234"),
},
},
AllowNetboot: v1alpha1.AllowNetbootStatus{},
},
},
},
wantWorkflow: &v1alpha1.WorkflowStatus{
Conditions: []v1alpha1.WorkflowCondition{
{
Type: v1alpha1.NetbootJobComplete,
Status: metav1.ConditionTrue,
Reason: "Complete",
Message: "job completed",
},
},
BootOptions: v1alpha1.BootOptionsStatus{
Jobs: map[string]v1alpha1.JobStatus{
jobNameNetboot.String(): {
ExistingJobDeleted: true,
UID: types.UID("1234"),
Complete: true,
},
},
AllowNetboot: v1alpha1.AllowNetbootStatus{},
},
},
hardware: &v1alpha1.Hardware{},
actions: []rufio.Action{},
name: jobNameNetboot,
wantResult: reconcile.Result{},
job: &rufio.Job{
ObjectMeta: metav1.ObjectMeta{
Name: jobNameNetboot.String(),
Namespace: "default",
UID: types.UID("1234"),
},
Status: rufio.JobStatus{
Conditions: []rufio.JobCondition{
{
Type: rufio.JobCompleted,
Status: rufio.ConditionTrue,
},
},
},
},
},
}

for name, tc := range tests {
t.Run(name, func(t *testing.T) {
runtimescheme := runtime.NewScheme()
rufio.AddToScheme(runtimescheme)
v1alpha1.AddToScheme(runtimescheme)
clientBulider := GetFakeClientBuilder().WithScheme(runtimescheme)
if tc.job != nil {
clientBulider.WithRuntimeObjects(tc.job)
}
s := &state{
workflow: tc.workflow,
hardware: tc.hardware,
client: clientBulider.Build(),
}
ctx := context.Background()
r, err := s.handleJob(ctx, tc.actions, tc.name)
if (err != nil) != tc.wantError {
t.Errorf("expected error: %v, got: %v", tc.wantError, err)
}
if diff := cmp.Diff(tc.wantResult, r); diff != "" {
t.Errorf("unexpected result (-want +got):\n%s", diff)
}
if diff := cmp.Diff(*tc.wantWorkflow, s.workflow.Status, cmpopts.IgnoreFields(v1alpha1.WorkflowCondition{}, "Time")); diff != "" {
t.Errorf("unexpected workflow status (-want +got):\n%s", diff)
}
})
}
}

0 comments on commit cdd0ad7

Please sign in to comment.