Handle context cancellation in fact gatherers (#384)

trento-project · Feb 5, 2025 · a61a9b0 · a61a9b0
1 parent 08eac24
commit a61a9b0
Show file tree

Hide file tree

Showing 18 changed files with 293 additions and 68 deletions.
diff --git a/internal/factsengine/gatherers/corosyncconf.go b/internal/factsengine/gatherers/corosyncconf.go
@@ -51,7 +51,7 @@ func NewCorosyncConfGatherer(configFile string) *CorosyncConfGatherer {
 }
 
 func (s *CorosyncConfGatherer) Gather(
-	_ context.Context,
+	ctx context.Context,
 	factsRequests []entities.FactRequest,
 ) ([]entities.Fact, error) {
 	facts := []entities.Fact{}
@@ -82,6 +82,10 @@ func (s *CorosyncConfGatherer) Gather(
 		facts = append(facts, fact)
 	}
 
+	if ctx.Err() != nil {
+		return nil, ctx.Err()
+	}
+
 	log.Infof("Requested corosync.conf file facts gathered")
 	return facts, nil
 }

diff --git a/internal/factsengine/gatherers/corosyncconf_test.go b/internal/factsengine/gatherers/corosyncconf_test.go
@@ -243,3 +243,23 @@ func (suite *CorosyncConfTestSuite) TestCorosyncConfInvalid() {
 	suite.EqualError(err, expectedError.Error())
 	suite.Empty(factsGathered)
 }
+
+func (suite *CorosyncCmapctlTestSuite) TestCorosyncConfContextCancelled() {
+	c := gatherers.NewCorosyncConfGatherer(helpers.GetFixturePath("gatherers/corosync.conf.one_node"))
+
+	factsRequest := []entities.FactRequest{
+		{
+			Name:     "corosync_nodes",
+			Gatherer: "corosync.conf",
+			Argument: "nodelist.node",
+		},
+	}
+
+	ctx, cancel := context.WithCancel(context.Background())
+	cancel()
+
+	factResults, err := c.Gather(ctx, factsRequest)
+
+	suite.Error(err)
+	suite.Empty(factResults)
+}
diff --git a/internal/factsengine/gatherers/fstab.go b/internal/factsengine/gatherers/fstab.go
@@ -49,7 +49,7 @@ func NewDefaultFstabGatherer() *FstabGatherer {
 	return &FstabGatherer{fstabFilePath: FstabFilePath}
 }
 
-func (f *FstabGatherer) Gather(_ context.Context, factsRequests []entities.FactRequest) ([]entities.Fact, error) {
+func (f *FstabGatherer) Gather(ctx context.Context, factsRequests []entities.FactRequest) ([]entities.Fact, error) {
 	log.Infof("Starting %s facts gathering process", FstabGathererName)
 	facts := []entities.Fact{}
 
@@ -80,6 +80,10 @@ func (f *FstabGatherer) Gather(_ context.Context, factsRequests []entities.FactR
 		facts = append(facts, entities.NewFactGatheredWithRequest(requestedFact, factValues))
 	}
 
+	if ctx.Err() != nil {
+		return nil, ctx.Err()
+	}
+
 	log.Infof("Requested %s facts gathered", FstabGathererName)
 
 	return facts, nil

diff --git a/internal/factsengine/gatherers/fstab_test.go b/internal/factsengine/gatherers/fstab_test.go
@@ -158,3 +158,24 @@ func (s *FstabGathererTestSuite) TestFstabGatheringSuccess() {
 	s.NoError(err)
 	s.EqualValues(expectedResults, result)
 }
+
+func (suite *SapInstanceHostnameResolverTestSuite) TestFstabContextCancelled() {
+
+	gatherer := gatherers.NewFstabGatherer(helpers.GetFixturePath("gatherers/fstab.valid"))
+
+	factsRequest := []entities.FactRequest{
+		{
+			Name:     "fstab",
+			CheckID:  "check1",
+			Gatherer: "fstab",
+		},
+	}
+
+	ctx, cancel := context.WithCancel(context.Background())
+	cancel()
+
+	factResults, err := gatherer.Gather(ctx, factsRequest)
+
+	suite.Error(err)
+	suite.Empty(factResults)
+}
diff --git a/internal/factsengine/gatherers/groups.go b/internal/factsengine/gatherers/groups.go
@@ -50,7 +50,7 @@ func NewGroupsGatherer(groupsFilePath string) *GroupsGatherer {
 	return &GroupsGatherer{groupsFilePath: groupsFilePath}
 }
 
-func (g *GroupsGatherer) Gather(_ context.Context, factsRequests []entities.FactRequest) ([]entities.Fact, error) {
+func (g *GroupsGatherer) Gather(ctx context.Context, factsRequests []entities.FactRequest) ([]entities.Fact, error) {
 	log.Infof("Starting %s facts gathering process", GroupsGathererName)
 	facts := []entities.Fact{}
 
@@ -80,6 +80,10 @@ func (g *GroupsGatherer) Gather(_ context.Context, factsRequests []entities.Fact
 		facts = append(facts, entities.NewFactGatheredWithRequest(requestedFact, factValues))
 	}
 
+	if ctx.Err() != nil {
+		return nil, ctx.Err()
+	}
+
 	log.Infof("Requested %s facts gathered", GroupsGathererName)
 
 	return facts, nil

diff --git a/internal/factsengine/gatherers/groups_test.go b/internal/factsengine/gatherers/groups_test.go
@@ -111,3 +111,21 @@ func (s *GroupsGathererSuite) TestGroupsParsingDecodeErrorInvalidFormat() {
 	s.Nil(result)
 	s.EqualError(err, "fact gathering error: groups-decoding-error - error deconding groups file: could not decode groups file line daemon:x:1, entry are less then 4")
 }
+
+func (s *GroupsGathererSuite) TestGroupsContextCancelled() {
+	gatherer := gatherers.NewGroupsGatherer(helpers.GetFixturePath("gatherers/groups.valid"))
+
+	factsRequest := []entities.FactRequest{{
+		Name:     "groups",
+		Gatherer: "groups",
+		CheckID:  "checkone",
+	}}
+
+	ctx, cancel := context.WithCancel(context.Background())
+	cancel()
+
+	factResults, err := gatherer.Gather(ctx, factsRequest)
+
+	s.Error(err)
+	s.Empty(factResults)
+}
diff --git a/internal/factsengine/gatherers/hostsfile.go b/internal/factsengine/gatherers/hostsfile.go
@@ -54,7 +54,7 @@ func NewHostsFileGatherer(hostsFile string) *HostsFileGatherer {
 	return &HostsFileGatherer{hostsFilePath: hostsFile}
 }
 
-func (s *HostsFileGatherer) Gather(_ context.Context, factsRequests []entities.FactRequest) ([]entities.Fact, error) {
+func (s *HostsFileGatherer) Gather(ctx context.Context, factsRequests []entities.FactRequest) ([]entities.Fact, error) {
 	facts := []entities.Fact{}
 	log.Infof("Starting /etc/hosts file facts gathering process")
 
@@ -85,6 +85,10 @@ func (s *HostsFileGatherer) Gather(_ context.Context, factsRequests []entities.F
 		facts = append(facts, fact)
 	}
 
+	if ctx.Err() != nil {
+		return nil, ctx.Err()
+	}
+
 	log.Infof("Requested /etc/hosts file facts gathered")
 	return facts, nil
 }

diff --git a/internal/factsengine/gatherers/hostsfile_test.go b/internal/factsengine/gatherers/hostsfile_test.go
@@ -153,3 +153,22 @@ func (suite *HostsFileTestSuite) TestHostsFileIgnoresCommentedHosts() {
 	suite.NoError(err)
 	suite.ElementsMatch(expectedResults, factResults)
 }
+
+func (suite *HostsFileTestSuite) TestHostsFileContextCancelled() {
+	gatherer := gatherers.NewHostsFileGatherer(helpers.GetFixturePath("gatherers/hosts.basic"))
+
+	factsRequest := []entities.FactRequest{{
+		Name:     "hosts_localhost",
+		Gatherer: "hosts",
+		Argument: "localhost",
+		CheckID:  "check1",
+	}}
+
+	ctx, cancel := context.WithCancel(context.Background())
+	cancel()
+
+	factResults, err := gatherer.Gather(ctx, factsRequest)
+
+	suite.Error(err)
+	suite.Empty(factResults)
+}
diff --git a/internal/factsengine/gatherers/osrelease.go b/internal/factsengine/gatherers/osrelease.go
@@ -41,7 +41,7 @@ func NewOSReleaseGatherer(path string) *OSReleaseGatherer {
 	}
 }
 
-func (g *OSReleaseGatherer) Gather(_ context.Context, factsRequests []entities.FactRequest) ([]entities.Fact, error) {
+func (g *OSReleaseGatherer) Gather(ctx context.Context, factsRequests []entities.FactRequest) ([]entities.Fact, error) {
 	facts := []entities.Fact{}
 	log.Infof("Starting %s facts gathering process", OSReleaseGathererName)
 
@@ -74,6 +74,10 @@ func (g *OSReleaseGatherer) Gather(_ context.Context, factsRequests []entities.F
 		facts = append(facts, fact)
 	}
 
+	if ctx.Err() != nil {
+		return nil, ctx.Err()
+	}
+
 	log.Infof("Requested %s facts gathered", OSReleaseGathererName)
 	return facts, nil
 }

diff --git a/internal/factsengine/gatherers/osrelease_test.go b/internal/factsengine/gatherers/osrelease_test.go
@@ -87,3 +87,21 @@ func (suite *OSReleaseGathererTestSuite) TestOSReleaseGathererErrorDecoding() {
 
 	suite.EqualError(err, "fact gathering error: os-release-decoding-error - error decoding file content: error on line 3: missing =")
 }
+
+func (suite *OSReleaseGathererTestSuite) TestOSReleaseContextCancelled() {
+	gatherer := gatherers.NewOSReleaseGatherer(helpers.GetFixturePath("gatherers/os-release.basic"))
+
+	factsRequest := []entities.FactRequest{{
+		Name:     "os-release",
+		Gatherer: "os-release@v1",
+		CheckID:  "check1",
+	}}
+
+	ctx, cancel := context.WithCancel(context.Background())
+	cancel()
+
+	factResults, err := gatherer.Gather(ctx, factsRequest)
+
+	suite.Error(err)
+	suite.Empty(factResults)
+}
diff --git a/internal/factsengine/gatherers/passwd.go b/internal/factsengine/gatherers/passwd.go
@@ -54,7 +54,7 @@ func NewPasswdGatherer(path string) *PasswdGatherer {
 	}
 }
 
-func (g *PasswdGatherer) Gather(_ context.Context, factsRequests []entities.FactRequest) ([]entities.Fact, error) {
+func (g *PasswdGatherer) Gather(ctx context.Context, factsRequests []entities.FactRequest) ([]entities.Fact, error) {
 	facts := []entities.Fact{}
 	log.Infof("Starting %s facts gathering process", PasswdGathererName)
 
@@ -74,6 +74,10 @@ func (g *PasswdGatherer) Gather(_ context.Context, factsRequests []entities.Fact
 		facts = append(facts, fact)
 	}
 
+	if ctx.Err() != nil {
+		return nil, ctx.Err()
+	}
+
 	log.Infof("Requested %s facts gathered", PasswdGathererName)
 	return facts, nil
 }

diff --git a/internal/factsengine/gatherers/passwd_test.go b/internal/factsengine/gatherers/passwd_test.go
@@ -108,3 +108,21 @@ func (suite *PasswdTestSuite) TestPasswdErrorDecoding() {
 	suite.EqualError(err, "fact gathering error: passwd-file-error - error reading /etc/passwd file: "+
 		"invalid passwd file: line 1 entry does not have 7 values")
 }
+
+func (suite *PasswdTestSuite) TestPasswdContextCancelled() {
+	gatherer := gatherers.NewPasswdGatherer(helpers.GetFixturePath("gatherers/passwd.basic"))
+
+	factsRequest := []entities.FactRequest{{
+		Name:     "passwd",
+		Gatherer: "passwd",
+		CheckID:  "check1",
+	}}
+
+	ctx, cancel := context.WithCancel(context.Background())
+	cancel()
+
+	factResults, err := gatherer.Gather(ctx, factsRequest)
+
+	suite.Error(err)
+	suite.Empty(factResults)
+}