!breaking: 💣 repositoryName is now used instead of id #343

Author: Ravinou

helpers/functions/isSshPubKeyDuplicate.test.ts

@@ -0,0 +1,70 @@
+import { describe, it, expect } from 'vitest';
+import isSshPubKeyDuplicate from './isSshPubKeyDuplicate';
+import { Optional, Repository } from '~/types';
+
+describe('isSshPubKeyDuplicate', () => {
+  it('should return true if the SSH public key is duplicated', () => {
+    const pubKey = 'ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEArandomkey user@hostname';
+    const repoList: Array<Optional<Repository>> = [
+      { sshPublicKey: 'ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEArandomkey other@host' } as Repository,
+    ];
+
+    expect(isSshPubKeyDuplicate(pubKey, repoList)).toBe(true);
+  });
+
+  it('should return false if the SSH public key is not duplicated', () => {
+    const pubKey = 'ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAdifferentkey user@hostname';
+    const repoList: Array<Optional<Repository>> = [
+      { sshPublicKey: 'ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEArandomkey other@host' } as Repository,
+    ];
+
+    expect(isSshPubKeyDuplicate(pubKey, repoList)).toBe(false);
+  });
+
+  it('should throw an error if pubKey is missing', () => {
+    const repoList: Array<Optional<Repository>> = [
+      { sshPublicKey: 'ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEArandomkey other@host' } as Repository,
+    ];
+
+    expect(() => isSshPubKeyDuplicate('', repoList)).toThrow(
+      'Missing or invalid parameters for duplicate SSH public key check.'
+    );
+  });
+
+  it('should throw an error if repoList is missing', () => {
+    const pubKey = 'ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEArandomkey user@hostname';
+
+    expect(() => isSshPubKeyDuplicate(pubKey, null as any)).toThrow(
+      'Missing or invalid parameters for duplicate SSH public key check.'
+    );
+  });
+
+  it('should return false if repoList is empty', () => {
+    const pubKey = 'ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEArandomkey user@hostname';
+    const repoList: Array<Optional<Repository>> = [];
+
+    expect(isSshPubKeyDuplicate(pubKey, repoList)).toBe(false);
+  });
+
+  it('should handle repositories with undefined sshPublicKey', () => {
+    const pubKey = 'ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEArandomkey user@hostname';
+    const repoList: Array<Optional<Repository>> = [
+      // @ts-expect-error
+      { sshPublicKey: undefined } as Repository,
+      { sshPublicKey: 'ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEArandomkey other@host' } as Repository,
+    ];
+
+    expect(isSshPubKeyDuplicate(pubKey, repoList)).toBe(true);
+  });
+
+  it('should handle repositories with null sshPublicKey', () => {
+    const pubKey = 'ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEArandomkey user@hostname';
+    const repoList: Array<Optional<Repository>> = [
+      // @ts-expect-error
+      { sshPublicKey: null } as Repository,
+      { sshPublicKey: 'ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAdifferentkey other@host' } as Repository,
+    ];
+
+    expect(isSshPubKeyDuplicate(pubKey, repoList)).toBe(false);
+  });
+});

helpers/functions/isSshPubKeyDuplicate.ts

@@ -21,7 +21,7 @@ export default function isSshPubKeyDuplicate(
 
   // Check if the normalized key is already in the repository list
   return repoList.some((repo) => {
-    const repoSshKeyWithoutComment = repo?.sshPublicKey.split(' ').slice(0, 2).join(' ');
+    const repoSshKeyWithoutComment = repo?.sshPublicKey?.split(' ').slice(0, 2).join(' ');
     return repoSshKeyWithoutComment === pubKeyWithoutComment;
   });
 }

helpers/functions/repositoryNameCheck.test.ts

@@ -0,0 +1,52 @@
+import { describe, it, expect } from 'vitest';
+import repositoryNameCheck from './repositoryNameCheck';
+
+describe('repositoryNameCheck', () => {
+  it('should return true for a valid 8-character hexadecimal string', () => {
+    expect(repositoryNameCheck('a1b2c3d4')).toBe(true);
+  });
+
+  it('should return false for a string shorter than 8 characters', () => {
+    expect(repositoryNameCheck('a1b2c3')).toBe(false);
+  });
+
+  it('should return false for a string longer than 8 characters', () => {
+    expect(repositoryNameCheck('a1b2c3d4e5')).toBe(false);
+  });
+
+  it('should return false for a string with non-hexadecimal characters', () => {
+    expect(repositoryNameCheck('a1b2c3g4')).toBe(false);
+  });
+
+  it('should return false for an empty string', () => {
+    expect(repositoryNameCheck('')).toBe(false);
+  });
+
+  it('should return false for a string with special characters', () => {
+    expect(repositoryNameCheck('a1b2c3d@')).toBe(false);
+  });
+
+  it('should return false for a string with uppercase hexadecimal characters', () => {
+    expect(repositoryNameCheck('A1B2C3D4')).toBe(false);
+  });
+
+  it('should return false for a string with spaces', () => {
+    expect(repositoryNameCheck('a1b2 c3d4')).toBe(false);
+  });
+
+  it('should return false for a non string name', () => {
+    expect(repositoryNameCheck(12345678)).toBe(false);
+  });
+
+  it('should return false for null', () => {
+    expect(repositoryNameCheck(null)).toBe(false);
+  });
+
+  it('should return false for undefined', () => {
+    expect(repositoryNameCheck(undefined)).toBe(false);
+  });
+
+  it('should return false for boolean', () => {
+    expect(repositoryNameCheck(true)).toBe(false);
+  });
+});

helpers/functions/repositoryNameCheck.ts

@@ -0,0 +1,9 @@
+// BorgWarehouse repository name is an 8-character hexadecimal string
+
+export default function repositoryNameCheck(name: unknown): boolean {
+  if (typeof name !== 'string') {
+    return false;
+  }
+  const repositoryNameRegex = /^[a-f0-9]{8}$/;
+  return repositoryNameRegex.test(name) ? true : false;
+}