feat: test integration connection (#669)

* feat: add test integration for pi-hole * refactor: test integration for pi-hole * fix: multiple secrets of same type could be used for integration creation * fix: remove integration test connection test and add mock for test-connection function * fix: add missing onUpdateFn to mysql integration secrets * fix: format issues * feat: add home assistant test connection * fix: deepsource issues * test: add system integration tests for test connection * fix: add before all for pulling home assistant image * test: add unit tests for handleTestConnectionResponseAsync * test: add unit test for testConnectionAsync * test: add mroe tests to integration-test-connection * fix: deepsource issues * fix: deepsource issue * chore: address pull request feedback
2024-06-22 21:02:04 +02:00
parent 92afd82d22
commit f92aeba403
30 changed files with 1138 additions and 550 deletions
--- a/packages/api/src/router/integration/integration-test-connection.ts
+++ b/packages/api/src/router/integration/integration-test-connection.ts
@@ -0,0 +1,95 @@
+import { decryptSecret } from "@homarr/common";
+import type { Integration } from "@homarr/db/schema/sqlite";
+import type { IntegrationKind, IntegrationSecretKind } from "@homarr/definitions";
+import { getAllSecretKindOptions } from "@homarr/definitions";
+import { integrationCreatorByKind, IntegrationTestConnectionError } from "@homarr/integrations";
+
+type FormIntegration = Integration & {
+  secrets: {
+    kind: IntegrationSecretKind;
+    value: string | null;
+  }[];
+};
+
+export const testConnectionAsync = async (
+  integration: FormIntegration,
+  dbSecrets: {
+    kind: IntegrationSecretKind;
+    value: `${string}.${string}`;
+  }[] = [],
+) => {
+  const formSecrets = integration.secrets
+    .filter((secret) => secret.value !== null)
+    .map((secret) => ({
+      ...secret,
+      // We ensured above that the value is not null
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      value: secret.value!,
+      source: "form" as const,
+    }));
+
+  const decryptedDbSecrets = dbSecrets.map((secret) => ({
+    ...secret,
+    value: decryptSecret(secret.value),
+    source: "db" as const,
+  }));
+
+  const sourcedSecrets = [...formSecrets, ...decryptedDbSecrets];
+  const secretKinds = getSecretKindOption(integration.kind, sourcedSecrets);
+
+  const filteredSecrets = secretKinds.map((kind) => {
+    const secrets = sourcedSecrets.filter((secret) => secret.kind === kind);
+    // Will never be undefined because of the check before
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    if (secrets.length === 1) return secrets[0]!;
+
+    // There will always be a matching secret because of the getSecretKindOption function
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    return secrets.find((secret) => secret.source === "form") ?? secrets[0]!;
+  });
+
+  const integrationInstance = integrationCreatorByKind(integration.kind, {
+    id: integration.id,
+    name: integration.name,
+    url: integration.url,
+    decryptedSecrets: filteredSecrets,
+  });
+
+  await integrationInstance.testConnectionAsync();
+};
+
+interface SourcedIntegrationSecret {
+  kind: IntegrationSecretKind;
+  value: string;
+  source: "db" | "form";
+}
+
+const getSecretKindOption = (kind: IntegrationKind, sourcedSecrets: SourcedIntegrationSecret[]) => {
+  const matchingSecretKindOptions = getAllSecretKindOptions(kind).filter((secretKinds) =>
+    secretKinds.every((kind) => sourcedSecrets.some((secret) => secret.kind === kind)),
+  );
+
+  if (matchingSecretKindOptions.length === 0) {
+    throw new IntegrationTestConnectionError("secretNotDefined");
+  }
+
+  if (matchingSecretKindOptions.length === 1) {
+    // Will never be undefined because of the check above
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    return matchingSecretKindOptions[0]!;
+  }
+
+  const onlyFormSecretsKindOptions = matchingSecretKindOptions.filter((secretKinds) =>
+    sourcedSecrets.filter((secret) => secretKinds.includes(secret.kind)).every((secret) => secret.source === "form"),
+  );
+
+  if (onlyFormSecretsKindOptions.length >= 1) {
+    // Will never be undefined because of the check above
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    return onlyFormSecretsKindOptions[0]!;
+  }
+
+  // Will never be undefined because of the check above
+  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+  return matchingSecretKindOptions[0]!;
+};