Refactor config files discovery scheduling

Author: Yumasi

comp/core/configfilesdiscovery/impl/collectors/kafka.go

@@ -26,13 +26,15 @@ func NewKafka() configfilesdiscoveryimpl.ConfigCollector {
 	return kafkaConfigCollector{}
 }
 
-// MatchesCommandline returns whether the command line contains an explicit
-// Kafka broker properties argument. Path resolution is deferred until
-// collection because workloadmeta process events may not include the working
-// directory.
-func (kafkaConfigCollector) MatchesCommandline(args []string) bool {
-	_, ok := kafkaGetConfigArgFromCommandline(args)
-	return ok
+// CanCollectFromProcess returns whether the command line contains an explicit,
+// resolvable Kafka broker properties path.
+func (kafkaConfigCollector) CanCollectFromProcess(commandline configfilesdiscoveryimpl.TargetCommandline) bool {
+	configArg, ok := kafkaGetConfigArgFromCommandline(commandline.Args)
+	if !ok {
+		return false
+	}
+	_, resolved := resolveConfigPath(configArg, commandline.WorkingDir)
+	return resolved
 }
 
 func (c kafkaConfigCollector) Collect(ctx context.Context, reader configfilesdiscoveryimpl.ConfigReader) (configfilesdiscoveryimpl.CollectedConfig, error) {

comp/core/configfilesdiscovery/impl/collectors/kafka_test.go

@@ -154,26 +154,28 @@ func TestKafkaGetConfigPath(t *testing.T) {
 	}
 }
 
-func TestKafkaCollectorMatchesAndReadsRelativeProcessConfig(t *testing.T) {
+func TestKafkaCollectorResolvesAndReadsRelativeProcessConfig(t *testing.T) {
 	eventArgs := []string{"kafka-server-start.sh", "config/server.properties"}
+	eventCommandline := configfilesdiscoveryimpl.TargetCommandline{
+		Args:       eventArgs,
+		WorkingDir: "/opt/kafka",
+	}
 	reader := &kafkaCollectorTestReader{
 		runtimeCommandline: configfilesdiscoveryimpl.TargetCommandline{
 			Args: []string{"/bin/bash", "/mnt/kafka-wrapper/start-kafka.sh"},
 		},
-		liveProcessCommandlines: []configfilesdiscoveryimpl.TargetCommandline{{
-			Args:       eventArgs,
-			WorkingDir: "/opt/kafka",
-		}},
-		file: configfilesdiscoveryimpl.ConfigFile{Path: "/opt/kafka/config/server.properties"},
+		liveProcessCommandlines: []configfilesdiscoveryimpl.TargetCommandline{eventCommandline},
+		file:                    configfilesdiscoveryimpl.ConfigFile{Path: "/opt/kafka/config/server.properties"},
 	}
 
-	configArg, matched := kafkaGetConfigArgFromCommandline(eventArgs)
-	require.True(t, matched)
-	_, resolved := resolveConfigPath(configArg, "")
-	assert.False(t, resolved)
-	require.True(t, kafkaConfigCollector{}.MatchesCommandline(eventArgs))
+	collector := kafkaConfigCollector{}
+	assert.False(t, collector.CanCollectFromProcess(configfilesdiscoveryimpl.TargetCommandline{Args: eventArgs}))
+	assert.True(t, collector.CanCollectFromProcess(eventCommandline))
+	assert.True(t, collector.CanCollectFromProcess(configfilesdiscoveryimpl.TargetCommandline{
+		Args: []string{"kafka-server-start.sh", "/etc/kafka/server.properties"},
+	}))
 
-	collected, err := kafkaConfigCollector{}.Collect(context.Background(), reader)
+	collected, err := collector.Collect(context.Background(), reader)
 
 	require.NoError(t, err)
 	assert.Equal(t, []string{"/opt/kafka/config/server.properties"}, reader.readFileCalls)

comp/core/configfilesdiscovery/impl/collectors/redis.go

@@ -27,12 +27,15 @@ func NewRedis() configfilesdiscoveryimpl.ConfigCollector {
 	return redisConfigCollector{}
 }
 
-// MatchesCommandline returns whether the command line contains an explicit
-// Redis config argument. Path resolution is deferred until collection because
-// workloadmeta process events may not include the working directory.
-func (redisConfigCollector) MatchesCommandline(args []string) bool {
-	_, ok := redisGetConfigArgFromCommandline(args)
-	return ok
+// CanCollectFromProcess returns whether the command line contains an explicit,
+// resolvable Redis config path.
+func (redisConfigCollector) CanCollectFromProcess(commandline configfilesdiscoveryimpl.TargetCommandline) bool {
+	configArg, ok := redisGetConfigArgFromCommandline(commandline.Args)
+	if !ok {
+		return false
+	}
+	_, resolved := resolveConfigPath(configArg, commandline.WorkingDir)
+	return resolved
 }
 
 func (c redisConfigCollector) Collect(ctx context.Context, reader configfilesdiscoveryimpl.ConfigReader) (configfilesdiscoveryimpl.CollectedConfig, error) {

comp/core/configfilesdiscovery/impl/collectors/redis_test.go

@@ -130,26 +130,28 @@ func TestRedisGetConfigPath(t *testing.T) {
 	}
 }
 
-func TestRedisCollectorMatchesAndReadsRelativeProcessConfig(t *testing.T) {
+func TestRedisCollectorResolvesAndReadsRelativeProcessConfig(t *testing.T) {
 	eventArgs := []string{"redis-server", "redis.conf"}
+	eventCommandline := configfilesdiscoveryimpl.TargetCommandline{
+		Args:       eventArgs,
+		WorkingDir: "/etc/redis",
+	}
 	reader := &redisCollectorTestReader{
 		runtimeCommandline: configfilesdiscoveryimpl.TargetCommandline{
 			Args: []string{"/usr/local/bin/tini", "--", "/etc/scripts/start_redis.sh"},
 		},
-		liveProcessCommandlines: []configfilesdiscoveryimpl.TargetCommandline{{
-			Args:       eventArgs,
-			WorkingDir: "/etc/redis",
-		}},
-		file: configfilesdiscoveryimpl.ConfigFile{Path: "/etc/redis/redis.conf"},
+		liveProcessCommandlines: []configfilesdiscoveryimpl.TargetCommandline{eventCommandline},
+		file:                    configfilesdiscoveryimpl.ConfigFile{Path: "/etc/redis/redis.conf"},
 	}
 
-	configArg, matched := redisGetConfigArgFromCommandline(eventArgs)
-	require.True(t, matched)
-	_, resolved := resolveConfigPath(configArg, "")
-	assert.False(t, resolved)
-	require.True(t, redisConfigCollector{}.MatchesCommandline(eventArgs))
+	collector := redisConfigCollector{}
+	assert.False(t, collector.CanCollectFromProcess(configfilesdiscoveryimpl.TargetCommandline{Args: eventArgs}))
+	assert.True(t, collector.CanCollectFromProcess(eventCommandline))
+	assert.True(t, collector.CanCollectFromProcess(configfilesdiscoveryimpl.TargetCommandline{
+		Args: []string{"redis-server", "/etc/redis/redis.conf"},
+	}))
 
-	collected, err := redisConfigCollector{}.Collect(context.Background(), reader)
+	collected, err := collector.Collect(context.Background(), reader)
 
 	require.NoError(t, err)
 	assert.Equal(t, []string{"/etc/redis/redis.conf"}, reader.readFileCalls)