Merge pull request juju#13603 from manadart/2.9-caas-firewaller-races

jujubot · web-flow · commit 6681d38208ff · 2022-01-11T21:48:50.000+10:00
juju#13603 The race test job runs quite slowly on arm64. It turns up race conditions in the CAAS firewaller worker tests. Here we do some synchronising to ensure tests pass without races. ## QA steps run the `WorkerSuite` tests in a loop with the `-race` flag. ## Documentation changes None. ## Bug reference N/A
diff --git a/worker/caasfirewaller/worker_test.go b/worker/caasfirewaller/worker_test.go
@@ -271,36 +271,38 @@ func (s *WorkerSuite) TestWatcherErrorStopsWorker(c *gc.C) {
 	s.sendApplicationChange(c, "gitlab")
 
 	s.applicationGetter.appWatcher.KillErr(errors.New("splat"))
-	workertest.CheckKilled(c, s.applicationGetter.appWatcher)
-	workertest.CheckKilled(c, s.applicationGetter.allWatcher)
+	_ = workertest.CheckKilled(c, s.applicationGetter.appWatcher)
+	_ = workertest.CheckKilled(c, s.applicationGetter.allWatcher)
 	err = workertest.CheckKilled(c, w)
 	c.Assert(err, gc.ErrorMatches, "splat")
 }
 
 func (s *WorkerSuite) TestV2CharmSkipProcessing(c *gc.C) {
-	w, err := caasfirewaller.NewWorker(s.config)
-	c.Assert(err, jc.ErrorIsNil)
-	defer workertest.CleanKill(c, w)
-
 	s.charmGetter.charmInfo.Manifest = &charm.Manifest{Bases: []charm.Base{{}}}
 	s.charmGetter.charmInfo.Meta = &charm.Meta{}
 
+	w, err := caasfirewaller.NewWorker(s.config)
+	c.Assert(err, jc.ErrorIsNil)
+
 	s.sendApplicationChange(c, "gitlab")
+	s.waitCharmGetterCalls(c, "ApplicationCharmInfo")
+
+	workertest.CleanKill(c, w)
 
-	s.charmGetter.CheckCallNames(c, "ApplicationCharmInfo")
 	s.lifeGetter.CheckNoCalls(c)
 }
 
 func (s *WorkerSuite) TestCharmNotFound(c *gc.C) {
 	w, err := caasfirewaller.NewWorker(s.config)
 	c.Assert(err, jc.ErrorIsNil)
-	defer workertest.CleanKill(c, w)
 
 	s.charmGetter.charmInfo = nil
 
 	s.sendApplicationChange(c, "gitlab")
+	s.waitCharmGetterCalls(c, "ApplicationCharmInfo")
+
+	workertest.CleanKill(c, w)
 
-	s.charmGetter.CheckCallNames(c, "ApplicationCharmInfo")
 	s.lifeGetter.CheckNoCalls(c)
 }
 
@@ -311,7 +313,7 @@ func (s *WorkerSuite) TestCharmChangesToV2(c *gc.C) {
 
 	s.sendApplicationChange(c, "gitlab")
 	s.waitCharmGetterCalls(c, "ApplicationCharmInfo")
-	s.lifeGetter.CheckCallNames(c, "Life")
+	s.waitLifeGetterCalls(c, "Life")
 
 	s.charmGetter.charmInfo.Manifest = &charm.Manifest{Bases: []charm.Base{{}}}
 	s.charmGetter.charmInfo.Meta = &charm.Meta{}
@@ -323,11 +325,25 @@ func (s *WorkerSuite) TestCharmChangesToV2(c *gc.C) {
 }
 
 func (s *WorkerSuite) waitCharmGetterCalls(c *gc.C, names ...string) {
+	waitStubCalls(c, &s.charmGetter, names...)
+}
+
+func (s *WorkerSuite) waitLifeGetterCalls(c *gc.C, names ...string) {
+	waitStubCalls(c, &s.lifeGetter, names...)
+}
+
+type waitStub interface {
+	Calls() []testing.StubCall
+	CheckCallNames(c *gc.C, expected ...string) bool
+	ResetCalls()
+}
+
+func waitStubCalls(c *gc.C, stub waitStub, names ...string) {
 	for a := coretesting.LongAttempt.Start(); a.Next(); {
-		if len(s.charmGetter.Calls()) >= len(names) {
+		if len(stub.Calls()) >= len(names) {
 			break
 		}
 	}
-	s.charmGetter.CheckCallNames(c, names...)
-	s.charmGetter.ResetCalls()
+	stub.CheckCallNames(c, names...)
+	stub.ResetCalls()
 }
