✨ Add -migrations to the job name to make it clearer what they are.

Author: coderanger

components/migrations.go

@@ -196,7 +196,7 @@ func (comp *migrationsComponent) Reconcile(ctx *cu.Context) (cu.Result, error) {
 
 	migrationJob := &batchv1.Job{
 		ObjectMeta: metav1.ObjectMeta{
-			Name:        obj.Name,
+			Name:        obj.Name + "-migrations",
 			Namespace:   obj.Namespace,
 			Labels:      obj.Labels,
 			Annotations: map[string]string{},

components/migrations_test.go

@@ -61,7 +61,7 @@ var _ = Describe("Migrations component", func() {
 		}
 		job = &batchv1.Job{
 			ObjectMeta: metav1.ObjectMeta{
-				Name:      "testing",
+				Name:      "testing-migrations",
 				Namespace: "default",
 			},
 			Spec: batchv1.JobSpec{
@@ -110,9 +110,9 @@ var _ = Describe("Migrations component", func() {
 	It("starts a migration", func() {
 		helper.TestClient.Create(pod)
 		helper.MustReconcile()
-		Expect(helper.Events).To(Receive(Equal("Normal MigrationsStarted Started migration job default/testing using image myapp:latest")))
+		Expect(helper.Events).To(Receive(Equal("Normal MigrationsStarted Started migration job default/testing-migrations using image myapp:latest")))
 		Expect(obj).To(HaveCondition("MigrationsReady").WithReason("MigrationsRunning").WithStatus("False"))
-		helper.TestClient.GetName("testing", job)
+		helper.TestClient.GetName("testing-migrations", job)
 		Expect(job.Spec.Template.Spec.Containers[0].Name).To(Equal("migrations"))
 		Expect(job.Spec.Template.Spec.Containers[0].Image).To(Equal("myapp:latest"))
 	})
@@ -123,7 +123,7 @@ var _ = Describe("Migrations component", func() {
 		helper.MustReconcile()
 		Expect(obj).To(HaveCondition("MigrationsReady").WithReason("MigrationsRunning").WithStatus("False"))
 		job2 := &batchv1.Job{}
-		helper.TestClient.GetName("testing", job2)
+		helper.TestClient.GetName("testing-migrations", job2)
 		Expect(job.Spec).To(Equal(job2.Spec))
 	})
 
@@ -133,7 +133,7 @@ var _ = Describe("Migrations component", func() {
 		helper.TestClient.Create(job)
 		helper.MustReconcile()
 		Expect(obj).To(HaveCondition("MigrationsReady").WithReason("StaleJob").WithStatus("False"))
-		err := helper.Client.Get(context.Background(), types.NamespacedName{Name: "testing", Namespace: "default"}, job)
+		err := helper.Client.Get(context.Background(), types.NamespacedName{Name: "testing-migrations", Namespace: "default"}, job)
 		Expect(kerrors.IsNotFound(err)).To(BeTrue())
 	})
 
@@ -143,7 +143,7 @@ var _ = Describe("Migrations component", func() {
 		helper.TestClient.Create(job)
 		helper.MustReconcile()
 		Expect(obj).To(HaveCondition("MigrationsReady").WithStatus("True"))
-		err := helper.Client.Get(context.Background(), types.NamespacedName{Name: "testing", Namespace: "default"}, job)
+		err := helper.Client.Get(context.Background(), types.NamespacedName{Name: "testing-migrations", Namespace: "default"}, job)
 		Expect(kerrors.IsNotFound(err)).To(BeTrue())
 	})
 
@@ -154,7 +154,7 @@ var _ = Describe("Migrations component", func() {
 		helper.MustReconcile()
 		Expect(obj).To(HaveCondition("MigrationsReady").WithStatus("False").WithReason("MigrationsFailed"))
 		job2 := &batchv1.Job{}
-		helper.TestClient.GetName("testing", job2)
+		helper.TestClient.GetName("testing-migrations", job2)
 		Expect(job.Spec).To(Equal(job2.Spec))
 	})
 
@@ -173,15 +173,15 @@ var _ = Describe("Migrations component", func() {
 		pod2.Spec.Containers[0].Image = "two:latest"
 		helper.TestClient.Create(pod2)
 		helper.MustReconcile()
-		helper.TestClient.GetName("testing", job)
+		helper.TestClient.GetName("testing-migrations", job)
 		Expect(job.Spec.Template.Spec.Containers[0].Image).To(Equal("two:latest"))
 	})
 
 	It("applies image override", func() {
 		obj.Spec.Image = "other:1"
 		helper.TestClient.Create(pod)
 		helper.MustReconcile()
-		helper.TestClient.GetName("testing", job)
+		helper.TestClient.GetName("testing-migrations", job)
 		Expect(job.Spec.Template.Spec.Containers[0].Image).To(Equal("other:1"))
 	})
 
@@ -190,7 +190,7 @@ var _ = Describe("Migrations component", func() {
 		obj.Spec.Command = &command
 		helper.TestClient.Create(pod)
 		helper.MustReconcile()
-		helper.TestClient.GetName("testing", job)
+		helper.TestClient.GetName("testing-migrations", job)
 		Expect(job.Spec.Template.Spec.Containers[0].Command).To(Equal([]string{"run", "migrations"}))
 	})
 
@@ -199,7 +199,7 @@ var _ = Describe("Migrations component", func() {
 		obj.Spec.Args = &args
 		helper.TestClient.Create(pod)
 		helper.MustReconcile()
-		helper.TestClient.GetName("testing", job)
+		helper.TestClient.GetName("testing-migrations", job)
 		Expect(job.Spec.Template.Spec.Containers[0].Args).To(Equal([]string{"run", "migrations"}))
 	})
 
@@ -246,7 +246,7 @@ var _ = Describe("Migrations component", func() {
 		helper.TestClient.Create(pod)
 
 		helper.MustReconcile()
-		helper.TestClient.GetName("testing", job)
+		helper.TestClient.GetName("testing-migrations", job)
 		Expect(job.Spec.Template.Spec.Containers[0].Image).To(Equal("myapp:v1"))
 	})
 })

controllers/migrator_test.go

@@ -82,7 +82,7 @@ var _ = Describe("Migrator controller", func() {
 
 		// Mark the job as successful.
 		job := &batchv1.Job{}
-		c.EventuallyGetName("testing", job)
+		c.EventuallyGetName("testing-migrations", job)
 		job.Status.Succeeded = 1
 		c.Status().Update(job)
 
@@ -92,8 +92,8 @@ var _ = Describe("Migrator controller", func() {
 
 		// Make sure the job doesn't come back.
 		Consistently(func() error {
-			return helper.Client.Get(context.Background(), types.NamespacedName{Name: "testing", Namespace: helper.Namespace}, job)
-		}, 5).Should(MatchError("Job.batch \"testing\" not found"))
+			return helper.Client.Get(context.Background(), types.NamespacedName{Name: "testing-migrations", Namespace: helper.Namespace}, job)
+		}, 5).Should(MatchError("Job.batch \"testing-migrations\" not found"))
 
 		// Update the pod image and see if a new migration is run.
 		c.Delete(pod)
@@ -104,7 +104,7 @@ var _ = Describe("Migrator controller", func() {
 		c.EventuallyGetName("testing", migrator, c.EventuallyCondition("Ready", "False"))
 
 		// Mark the new job as successful.
-		c.EventuallyGetName("testing", job)
+		c.EventuallyGetName("testing-migrations", job)
 		job.Status.Succeeded = 1
 		c.Status().Update(job)