fix: align with pm suggestions

steadybit · Nov 14, 2024 · af76f38 · af76f38
1 parent b6abb43
commit af76f38
Show file tree

Hide file tree

Showing 6 changed files with 7 additions and 7 deletions.
diff --git a/extkafka/check_consumer_group.go b/extkafka/check_consumer_group.go
@@ -50,7 +50,7 @@ func (m *ConsumerGroupCheckAction) Describe() action_kit_api.ActionDescription {
 	return action_kit_api.ActionDescription{
 		Id:          fmt.Sprintf("%s.check", kafkaConsumerTargetId),
 		Label:       "Check Consumer State",
-		Description: "check the consumer state",
+		Description: "Check the consumer state",
 		Version:     extbuild.GetSemverVersionStringOrUnknown(),
 		Icon:        extutil.Ptr(kafkaIcon),
 		TargetSelection: extutil.Ptr(action_kit_api.TargetSelection{

diff --git a/extkafka/check_consumer_group_test.go b/extkafka/check_consumer_group_test.go
@@ -37,7 +37,7 @@ func TestCheckConsumerGroup_Describe(t *testing.T) {
 			response := action.Describe()
 
 			//Then
-			assert.Equal(t, "check the consumer state", response.Description)
+			assert.Equal(t, "Check the consumer state", response.Description)
 			assert.Equal(t, "Check Consumer State", response.Label)
 			assert.Equal(t, kafkaConsumerTargetId, response.TargetSelection.TargetType)
 			assert.Equal(t, fmt.Sprintf("%s.check", kafkaConsumerTargetId), response.Id)

diff --git a/extkafka/check_topic_lag_for_consumer.go b/extkafka/check_topic_lag_for_consumer.go
@@ -49,7 +49,7 @@ func (m *ConsumerGroupLagCheckAction) Describe() action_kit_api.ActionDescriptio
 	return action_kit_api.ActionDescription{
 		Id:          fmt.Sprintf("%s.check-lag", kafkaConsumerTargetId),
 		Label:       "Check Topic Lag",
-		Description: "check if the consumer group have lags on a topic",
+		Description: "Check the consumer lag for a given topic (lag is calculated by the difference between topic offset and consumer offset)",
 		Version:     extbuild.GetSemverVersionStringOrUnknown(),
 		Icon:        extutil.Ptr(kafkaIcon),
 		TargetSelection: extutil.Ptr(action_kit_api.TargetSelection{

diff --git a/extkafka/check_topic_lag_for_consumer_test.go b/extkafka/check_topic_lag_for_consumer_test.go
@@ -37,7 +37,7 @@ func TestCheckTopicLag_Describe(t *testing.T) {
 			response := action.Describe()
 
 			//Then
-			assert.Equal(t, "check if the consumer group have lags on a topic", response.Description)
+			assert.Equal(t, "Check the consumer lag for a given topic (lag is calculated by the difference between topic offset and consumer offset)", response.Description)
 			assert.Equal(t, "Check Topic Lag", response.Label)
 			assert.Equal(t, kafkaConsumerTargetId, response.TargetSelection.TargetType)
 			assert.Equal(t, fmt.Sprintf("%s.check-lag", kafkaConsumerTargetId), response.Id)

diff --git a/extkafka/delete_last_records.go b/extkafka/delete_last_records.go
@@ -59,7 +59,7 @@ func (k *DeleteRecordsAttack) Describe() action_kit_api.ActionDescription {
 		Parameters: []action_kit_api.ActionParameter{
 			{
 				Name:        "partitions",
-				Label:       "Partition to delete records (move the offset to the new targeted one)",
+				Label:       "Partition to issue delete records requests",
 				Description: extutil.Ptr("One or more partitions to delete the records"),
 				Type:        action_kit_api.StringArray,
 				Required:    extutil.Ptr(true),

diff --git a/extkafka/partition_attack_elect_new_leader.go b/extkafka/partition_attack_elect_new_leader.go
@@ -30,8 +30,8 @@ func (f kafkaBrokerElectNewLeaderAttack) NewEmptyState() KafkaBrokerAttackState
 func (f kafkaBrokerElectNewLeaderAttack) Describe() action_kit_api.ActionDescription {
 	return action_kit_api.ActionDescription{
 		Id:          fmt.Sprintf("%s.elect-new-leader", kafkaTopicTargetId),
-		Label:       "Elect New Leader",
-		Description: "Triggers election for a new leader for a given topic and partition(s)",
+		Label:       "Trigger Partition Leader Election",
+		Description: "Trigger election for a new leader for a given topic and partition(s)",
 		Version:     extbuild.GetSemverVersionStringOrUnknown(),
 		Icon:        extutil.Ptr(kafkaIcon),
 		TargetSelection: extutil.Ptr(action_kit_api.TargetSelection{