Conformance test: move loader to each component type's folder (#3162)

Signed-off-by: ItalyPaleAle <[email protected]>

Author: ItalyPaleAle

.golangci.yml

@@ -15,6 +15,7 @@ run:
   # list of build tags, all linters use it. Default is empty list.
   build-tags:
     - certtests
+    - conftests
     - metadata
 
   # which dirs to skip: they won't be analyzed;
@@ -301,3 +302,4 @@ linters:
     - deadcode
     - nosnakecase
     - varcheck
+    - goconst

tests/conformance/README.md

@@ -4,15 +4,15 @@
 
 1. `tests/` directory contains the configuration and the test definition for conformance tests.
 2. All the conformance tests are within the `tests/conformance` directory.
-3. All the configurations are in the `tests/config` directory.
-4. Each of the component specific `component` definition are in their specific `component type` folder in the `tests/config` folder. For example, the `redis` statestore component definition within `state` directory.
-  - The component types are: `bindings`, `configuration`, `crypto`, `pubsub`, `state`, `secretstores`, `workflows`.
-  - Cloud specific components will be within their own `cloud` directory within the `component type` folder, e.g. `pubsub/azure/servicebus`.
+3. All the components' configurations are in the `tests/config` directory.
+4. Each of the component specific component's definition are in their specific `<component type>` folder in the `tests/config` folder. For example, the SQLite state store component definition is in the `tests/config/state/sqlite/` directory.
+  - The component types are: `bindings`, `configuration`, `crypto`, `lock`, `pubsub`, `state`, `secretstores`, `workflows`.
+  - Cloud-specific components will be within their own `<cloud>` directory within the `<component type>` folder, e.g. `tests/config/pubsub/azure/servicebus`.
+  - If a component has multiple variants, they are defined in sub-folders. For example, for the MySQL state store, `tests/config/state/mysql/mysql` contains the configuration for testing against MySQL, while `tests/config/state/mysql/mariadb` uses MariaDB.
 5. Similar to the component definitions, each component type has its own set of the conformance tests definitions.
-6. Each `component type` contains a `tests.yml` definition that defines the component to be tested along with component specific test configuration. Nested folder names have their `/` in path replaced by `.` in the component name in `tests.yml`, e.g. `azure/servicebus/topics` should be `azure.servicebus.topics`
-7. All the tests configurations are defined in `common.go` file.
-8. Each `component type` has its own `_test` file to trigger the conformance tests. E.g. `bindings_test.go`.
-9. Each test added will also need to be added to the `component type/tests.yml` workflow file.
+6. Each component type contains a `tests.yml` definition that defines the component to be tested along with component-specific test configuration. Nested folder names have their `/` in path replaced by `.` in the component name in `tests.yml`, e.g. `azure/servicebus/topics` should be `azure.servicebus.topics`
+7. Each component type has its own `_test` file to trigger the conformance tests, e.g. `bindings_test.go`. This file contains also the test configurations.
+9. Each test added will also need to be added to the `<component type>/tests.yml` workflow file.
 
 ## Conformance test workflow
 
@@ -24,21 +24,21 @@
 
 1. Add the component specific YAML to `tests/config/<COMPONENT-TYPE>/<COMPONENT>/<FILE>.yaml`.
 2. All passwords will be of the form `${{PASSWORD_KEY}}` so that it is injected via environment variables.
-3. Register the component `New**` function in `common.go`. For example:
+3. Register the component `New**` function in `<COMPONENT-TYPE>_test.go`. For example:
 
     ```go
     ...
-        switch tc.Component {
+        switch name {
         case "azure.servicebusqueues":
-            binding = b_azure_servicebusqueues.NewAzureServiceBusQueues(testLogger)
+            return b_azure_servicebusqueues.NewAzureServiceBusQueues(testLogger)
         case "azure.storagequeues":
-            binding = b_azure_storagequeues.NewAzureStorageQueues(testLogger)
+            return b_azure_storagequeues.NewAzureStorageQueues(testLogger)
         case "azure.eventgrid":
-            binding = b_azure_eventgrid.NewAzureEventGrid(testLogger)
+            return b_azure_eventgrid.NewAzureEventGrid(testLogger)
         case "kafka":
-            binding = b_kafka.NewKafka(testLogger)
+            return b_kafka.NewKafka(testLogger)
         case "new-component":
-            binding = b_new_component.NewComponent(testLogger)
+            return b_new_component.NewComponent(testLogger)
         default:
             return nil
         }

tests/conformance/bindings_test.go

@@ -17,14 +17,123 @@ limitations under the License.
 package conformance
 
 import (
+	"path/filepath"
 	"testing"
 
 	"github.com/stretchr/testify/require"
+
+	"github.com/dapr/components-contrib/bindings"
+	b_aws_s3 "github.com/dapr/components-contrib/bindings/aws/s3"
+	b_azure_blobstorage "github.com/dapr/components-contrib/bindings/azure/blobstorage"
+	b_azure_cosmosdb "github.com/dapr/components-contrib/bindings/azure/cosmosdb"
+	b_azure_eventgrid "github.com/dapr/components-contrib/bindings/azure/eventgrid"
+	b_azure_eventhubs "github.com/dapr/components-contrib/bindings/azure/eventhubs"
+	b_azure_servicebusqueues "github.com/dapr/components-contrib/bindings/azure/servicebusqueues"
+	b_azure_storagequeues "github.com/dapr/components-contrib/bindings/azure/storagequeues"
+	b_cron "github.com/dapr/components-contrib/bindings/cron"
+	b_http "github.com/dapr/components-contrib/bindings/http"
+	b_influx "github.com/dapr/components-contrib/bindings/influx"
+	b_kafka "github.com/dapr/components-contrib/bindings/kafka"
+	b_kubemq "github.com/dapr/components-contrib/bindings/kubemq"
+	b_mqtt3 "github.com/dapr/components-contrib/bindings/mqtt3"
+	b_postgres "github.com/dapr/components-contrib/bindings/postgres"
+	b_rabbitmq "github.com/dapr/components-contrib/bindings/rabbitmq"
+	b_redis "github.com/dapr/components-contrib/bindings/redis"
+	conf_bindings "github.com/dapr/components-contrib/tests/conformance/bindings"
 )
 
 func TestBindingsConformance(t *testing.T) {
-	tc, err := NewTestConfiguration("../config/bindings/tests.yml")
+	const configPath = "../config/bindings/"
+	tc, err := NewTestConfiguration(filepath.Join(configPath, "tests.yml"))
 	require.NoError(t, err)
 	require.NotNil(t, tc)
+
+	tc.TestFn = func(comp *TestComponent) func(t *testing.T) {
+		return func(t *testing.T) {
+			ParseConfigurationMap(t, comp.Config)
+
+			componentConfigPath := convertComponentNameToPath(comp.Component, comp.Profile)
+			props, err := loadComponentsAndProperties(t, filepath.Join(configPath, componentConfigPath))
+			require.NoErrorf(t, err, "error running conformance test for component %s", comp.Component)
+
+			inputBinding := loadInputBindings(comp.Component)
+			outputBinding := loadOutputBindings(comp.Component)
+			require.True(t, inputBinding != nil || outputBinding != nil)
+
+			bindingsConfig, err := conf_bindings.NewTestConfig(comp.Component, comp.Operations, comp.Config)
+			require.NoErrorf(t, err, "error running conformance test for component %s", comp.Component)
+
+			conf_bindings.ConformanceTests(t, props, inputBinding, outputBinding, bindingsConfig)
+		}
+	}
+
 	tc.Run(t)
 }
+
+func loadOutputBindings(name string) bindings.OutputBinding {
+	switch name {
+	case "redis.v6":
+		return b_redis.NewRedis(testLogger)
+	case "redis.v7":
+		return b_redis.NewRedis(testLogger)
+	case "azure.blobstorage":
+		return b_azure_blobstorage.NewAzureBlobStorage(testLogger)
+	case "azure.storagequeues":
+		return b_azure_storagequeues.NewAzureStorageQueues(testLogger)
+	case "azure.servicebusqueues":
+		return b_azure_servicebusqueues.NewAzureServiceBusQueues(testLogger)
+	case "azure.eventgrid":
+		return b_azure_eventgrid.NewAzureEventGrid(testLogger)
+	case "azure.eventhubs":
+		return b_azure_eventhubs.NewAzureEventHubs(testLogger)
+	case "azure.cosmosdb":
+		return b_azure_cosmosdb.NewCosmosDB(testLogger)
+	case "kafka":
+		return b_kafka.NewKafka(testLogger)
+	case "http":
+		return b_http.NewHTTP(testLogger)
+	case "influx":
+		return b_influx.NewInflux(testLogger)
+	case "mqtt3":
+		return b_mqtt3.NewMQTT(testLogger)
+	case "rabbitmq":
+		return b_rabbitmq.NewRabbitMQ(testLogger)
+	case "kubemq":
+		return b_kubemq.NewKubeMQ(testLogger)
+	case "postgresql.docker":
+		return b_postgres.NewPostgres(testLogger)
+	case "postgresql.azure":
+		return b_postgres.NewPostgres(testLogger)
+	case "aws.s3.docker":
+		return b_aws_s3.NewAWSS3(testLogger)
+	case "aws.s3.terraform":
+		return b_aws_s3.NewAWSS3(testLogger)
+	default:
+		return nil
+	}
+}
+
+func loadInputBindings(name string) bindings.InputBinding {
+	switch name {
+	case "azure.servicebusqueues":
+		return b_azure_servicebusqueues.NewAzureServiceBusQueues(testLogger)
+	case "azure.storagequeues":
+		return b_azure_storagequeues.NewAzureStorageQueues(testLogger)
+	case "azure.eventgrid":
+		return b_azure_eventgrid.NewAzureEventGrid(testLogger)
+	case "cron":
+		return b_cron.NewCron(testLogger)
+	case "azure.eventhubs":
+		return b_azure_eventhubs.NewAzureEventHubs(testLogger)
+	case "kafka":
+		return b_kafka.NewKafka(testLogger)
+	case "mqtt3":
+		return b_mqtt3.NewMQTT(testLogger)
+	case "rabbitmq":
+		return b_rabbitmq.NewRabbitMQ(testLogger)
+	case "kubemq":
+		return b_kubemq.NewKubeMQ(testLogger)
+	default:
+		return nil
+	}
+}