Merge pull request #10 from mia-platform/feat/add-source-configuration

mia-platform · Nov 15, 2024 · d7b3130 · d7b3130
2 parents 42d04cf + 2588957
commit d7b3130
Show file tree

Hide file tree

Showing 13 changed files with 280 additions and 241 deletions.
diff --git a/.markdownlint.yaml b/.markdownlint.yaml
@@ -1,7 +1,7 @@
 default: true
 MD003:
   style: atx
-MD010: false
+MD010: true
 MD013:
   line_length: 120
   heading_line_length: 80

diff --git a/docs/10_overview.md b/docs/10_overview.md
@@ -43,36 +43,38 @@ to save data into the collection `jira-issues`.
 
 ```json
 {
-	"integrations": [
-		{
-			"type": "jira",
-			"authentication": {
-				"secret": {
-					"fromEnv": "JIRA_SECRET"
-				}
-			},
-			"processors": [
-				{
-					"type": "mapper",
-					"outputEvent": {
-						"key": "{{ issue.key }}",
-						"summary": "{{ issue.fields.summary }}",
-						"createdAt": "{{ issue.fields.created }}",
-						"description": "{{ issue.fields.description }}"
-					}
-				}
-			],
-			"sinks": [
-				{
-					"type": "mongo",
-					"url": {
-						"fromEnv": "MONGO_URL"
-					},
-					"collection": "jira-issues"
-				}
-			]
-		}
-	]
+  "integrations": [
+    {
+      "source": {
+        "type": "jira",
+        "authentication": {
+          "secret": {
+            "fromEnv": "JIRA_SECRET"
+          }
+        }
+      },
+      "processors": [
+        {
+          "type": "mapper",
+          "outputEvent": {
+            "key": "{{ issue.key }}",
+            "summary": "{{ issue.fields.summary }}",
+            "createdAt": "{{ issue.fields.created }}",
+            "description": "{{ issue.fields.description }}"
+          }
+        }
+      ],
+      "sinks": [
+        {
+          "type": "mongo",
+          "url": {
+            "fromEnv": "MONGO_URL"
+          },
+          "collection": "jira-issues"
+        }
+      ]
+    }
+  ]
 }
 </details>
 ```
diff --git a/docs/20_install.md b/docs/20_install.md
@@ -34,11 +34,13 @@ The following is an example of a configuration for integrate source `Jira` with
 {
   "integrations": [
     {
-      "type": "jira",
-      "authentication": {
-        "secret": {
-          "fromFile": "testdata/secret"
-        }
+      "source": {
+        "type": "jira",
+        "authentication": {
+          "secret": {
+            "fromFile": "testdata/secret"
+          }
+        },
       },
       "processors": [
         {

diff --git a/internal/config/config.go b/internal/config/config.go
@@ -37,11 +37,15 @@ type Authentication struct {
 type Processors []GenericConfig
 type Sinks []GenericConfig
 
-type Integration struct {
+type Source struct {
 	Type           string         `json:"type"`
 	Authentication Authentication `json:"authentication"`
-	Processors     Processors     `json:"processors"`
-	Sinks          Sinks          `json:"sinks"`
+}
+
+type Integration struct {
+	Source     Source     `json:"source"`
+	Processors Processors `json:"processors"`
+	Sinks      Sinks      `json:"sinks"`
 }
 
 type Configuration struct {

diff --git a/internal/config/config.schema.json b/internal/config/config.schema.json
@@ -1,99 +1,112 @@
 {
-	"$schema": "http://json-schema.org/draft-07/schema#",
-	"type": "object",
-	"properties": {
-		"integrations": {
-			"type": "array",
-			"items": {
-				"type": "object",
-				"properties": {
-					"type": {
-						"type": "string",
-						"enum": [
-							"jira"
-						]
-					},
-					"authentication": {
-						"type": "object",
-						"properties": {
-							"secret": {
-								"$ref": "#/definitions/secret"
-							}
-						}
-					},
-					"processors": {
-						"type": "array",
-						"items": {
-							"type": "object",
-							"properties": {
-								"type": {
-									"type": "string",
-									"enum": [
-										"mapper"
-									]
-								},
-								"outputEvent": {
-									"type": "object"
-								}
-							},
-							"required": [
-								"type",
-								"outputEvent"
-							]
-						}
-					},
-					"sinks": {
-						"type": "array",
-						"items": {
-							"oneOf": [
-								{
-									"type": "object",
-									"properties": {
-										"type": {
-											"type": "string",
-											"const": "mongo"
-										},
-										"url": {
-											"$ref": "#/definitions/secret"
-										},
-										"collection": {
-											"type": "string"
-										}
-									},
-									"required": [
-										"type",
-										"url",
-										"collection"
-									]
-								}
-							]
-						}
-					}
-				},
-				"required": [
-					"type",
-					"sinks"
-				],
-				"additionalProperties": false
-			},
-			"minItems": 1
-		}
-	},
-	"required": [
-		"integrations"
-	],
-	"additionalProperties": false,
-	"definitions": {
-		"secret": {
-			"type": "object",
-			"properties": {
-				"fromEnv": {
-					"type": "string"
-				},
-				"fromFile": {
-					"type": "string"
-				}
-			}
-		}
-	}
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "integrations": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "source": {
+            "type": "object",
+            "properties": {
+              "type": {
+                "type": "string",
+                "enum": [
+                  "jira"
+                ]
+              },
+              "authentication": {
+                "type": "object",
+                "properties": {
+                  "secret": {
+                    "$ref": "#/definitions/secret"
+                  }
+                }
+              }
+            },
+            "required": [
+              "type"
+            ]
+          },
+          "processors": {
+            "type": "array",
+            "items": {
+              "oneOf": [
+                {
+                  "type": "object",
+                  "properties": {
+                    "type": {
+                      "type": "string",
+                      "enum": [
+                        "mapper"
+                      ]
+                    },
+                    "outputEvent": {
+                      "type": "object"
+                    }
+                  },
+                  "required": [
+                    "type",
+                    "outputEvent"
+                  ]
+                }
+              ]
+            }
+          },
+          "sinks": {
+            "type": "array",
+            "items": {
+              "oneOf": [
+                {
+                  "type": "object",
+                  "properties": {
+                    "type": {
+                      "type": "string",
+                      "const": "mongo"
+                    },
+                    "url": {
+                      "$ref": "#/definitions/secret"
+                    },
+                    "collection": {
+                      "type": "string"
+                    }
+                  },
+                  "required": [
+                    "type",
+                    "url",
+                    "collection"
+                  ]
+                }
+              ]
+            },
+            "minItems": 1
+          }
+        },
+        "required": [
+          "source",
+          "sinks"
+        ],
+        "additionalProperties": false
+      },
+      "minItems": 1
+    }
+  },
+  "required": [
+    "integrations"
+  ],
+  "additionalProperties": false,
+  "definitions": {
+    "secret": {
+      "type": "object",
+      "properties": {
+        "fromEnv": {
+          "type": "string"
+        },
+        "fromFile": {
+          "type": "string"
+        }
+      }
+    }
+  }
 }
diff --git a/internal/config/config_test.go b/internal/config/config_test.go
@@ -49,9 +49,11 @@ func TestLoadServiceConfiguration(t *testing.T) {
 			expectedContent: &Configuration{
 				Integrations: []Integration{
 					{
-						Type: "jira",
-						Authentication: Authentication{
-							Secret: SecretSource("MY_SECRET"),
+						Source: Source{
+							Type: "jira",
+							Authentication: Authentication{
+								Secret: SecretSource("MY_SECRET"),
+							},
 						},
 						Processors: Processors{
 							{