From 0d7e02afdd4b87aeb7b74a1be6c343fbed928cfa Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Andr=C3=A9=20Jaenisch?= <andre.jaenisch@posteo.de>
Date: Sat, 15 Jun 2024 19:08:37 +0200
Subject: [PATCH] test: write tests for Project molecule
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

During testing I realised that the buttons are not accessible.
While I was adding text I also ensured that it can be translated.

Signed-off-by: André Jaenisch <andre.jaenisch@posteo.de>
---
 src/lib/components/molecules/Project.svelte |  23 +++-
 src/lib/components/templates/Profile.svelte |   8 +-
 src/lib/i18n/locales/bg.json                |   5 +
 src/lib/i18n/locales/de.json                |   5 +
 src/lib/i18n/locales/en.json                |   5 +
 src/lib/i18n/locales/he.json                |   5 +
 src/lib/i18n/locales/pl.json                |   5 +
 tests/components/molecules/Project.test.ts  | 141 ++++++++++++++++++++
 8 files changed, 192 insertions(+), 5 deletions(-)
 create mode 100644 tests/components/molecules/Project.test.ts

diff --git a/src/lib/components/molecules/Project.svelte b/src/lib/components/molecules/Project.svelte
index 379b928..af68bb5 100644
--- a/src/lib/components/molecules/Project.svelte
+++ b/src/lib/components/molecules/Project.svelte
@@ -12,6 +12,7 @@ You should have received a copy of the GNU Affero General Public License along w
 -->
 
 <script>
+	import { _ } from 'svelte-i18n';
 	import {
 		EyeClosed16,
 		Person24,
@@ -21,15 +22,26 @@ You should have received a copy of the GNU Affero General Public License along w
 		TriangleDown16
 	} from 'svelte-octicons';
 
+	/**
+	 * Translation keys.
+	 */
+	export let i18n = {
+		buttons: {
+			fork: 'page.profile.projects.actions.fork',
+			star: 'page.profile.projects.actions.star',
+			watch: 'page.profile.projects.actions.watch'
+		}
+	};
+
 	/**
 	 * Collaborators to this project.
 	 */
 	export let collaborators = [];
 
 	/**
-	 * A followed project.
+	 * A software project.
 	 */
-	export let following = {
+	export let project = {
 		name: '',
 		summary: ''
 	};
@@ -41,7 +53,7 @@ You should have received a copy of the GNU Affero General Public License along w
 		<!-- Name + Icon -->
 		<div class="flex -ms-10">
 			<Repo24 fill="currentColor" />
-			{following.name}
+			{project.name}
 			<!-- Members -->
 			<ul class="ms-2 gap-4">
 				{#each collaborators as member}
@@ -56,7 +68,7 @@ You should have received a copy of the GNU Affero General Public License along w
 		<!-- Description -->
 		<!-- Compensate padding with negative margin -->
 		<div class="flex -ms-4">
-			{following.summary}
+			{project.summary}
 		</div>
 		<!-- Tags -->
 		<div class="flex"></div>
@@ -66,12 +78,15 @@ You should have received a copy of the GNU Affero General Public License along w
 		<!-- Star Fork Watch -->
 		<div class="flex gap-4">
 			<button type="button" class="btn-icon border rounded-none">
+				<span class="sr-only">{$_(i18n.buttons.fork)}</span>
 				<RepoForked16 fill="currentColor" />
 			</button>
 			<button type="button" class="btn-icon border rounded-none">
+				<span class="sr-only">{$_(i18n.buttons.star)}</span>
 				<Star16 fill="currentColor" />
 			</button>
 			<button type="button" class="btn-icon border rounded-none">
+				<span class="sr-only">{$_(i18n.buttons.watch)}</span>
 				<EyeClosed16 fill="currentColor" />
 				<TriangleDown16 fill="currentColor" />
 			</button>
diff --git a/src/lib/components/templates/Profile.svelte b/src/lib/components/templates/Profile.svelte
index a884094..e2de1c8 100644
--- a/src/lib/components/templates/Profile.svelte
+++ b/src/lib/components/templates/Profile.svelte
@@ -25,6 +25,11 @@ You should have received a copy of the GNU Affero General Public License along w
 	 * Translation keys.
 	 */
 	const i18n = {
+		buttons: {
+			fork: 'page.profile.projects.actions.fork',
+			star: 'page.profile.projects.actions.star',
+			watch: 'page.profile.projects.actions.watch'
+		},
 		heading: 'page.profile.heading'
 	};
 
@@ -111,7 +116,8 @@ You should have received a copy of the GNU Affero General Public License along w
 										data.user.collaboratorsMap,
 										following.id
 									)}
-									{following}
+									{i18n}
+									project={following}
 								/>
 							</li>
 						{/if}
diff --git a/src/lib/i18n/locales/bg.json b/src/lib/i18n/locales/bg.json
index b17569b..36f28c9 100644
--- a/src/lib/i18n/locales/bg.json
+++ b/src/lib/i18n/locales/bg.json
@@ -74,6 +74,11 @@
 				"heading": ""
 			},
 			"projects": {
+				"actions": {
+					"fork": "",
+					"star": "",
+					"watch": ""
+				},
 				"add_or_import": "",
 				"empty": "",
 				"heading": ""
diff --git a/src/lib/i18n/locales/de.json b/src/lib/i18n/locales/de.json
index 1663a91..0a43fcf 100644
--- a/src/lib/i18n/locales/de.json
+++ b/src/lib/i18n/locales/de.json
@@ -74,6 +74,11 @@
 				"heading": "Aktivitäten"
 			},
 			"projects": {
+				"actions": {
+					"fork": "",
+					"star": "",
+					"watch": ""
+				},
 				"add_or_import": "{addElementOpen}Ein Projekt hinzufügen{addElementClose} oder {importElementOpen}Ein Projekt importieren{importElementClose}.",
 				"empty": "Bisher keine Projekte hinzugefügt.",
 				"heading": "Projekte"
diff --git a/src/lib/i18n/locales/en.json b/src/lib/i18n/locales/en.json
index 63b30f8..e0997f7 100644
--- a/src/lib/i18n/locales/en.json
+++ b/src/lib/i18n/locales/en.json
@@ -74,6 +74,11 @@
 				"heading": "Activities"
 			},
 			"projects": {
+				"actions": {
+					"fork": "Fork",
+					"star": "Star",
+					"watch": "Watch"
+				},
 				"add_or_import": "{addElementOpen}Add a project{addElementClose} or {importElementOpen}import a project{importElementClose}.",
 				"empty": "No projects added yet.",
 				"heading": "Projects"
diff --git a/src/lib/i18n/locales/he.json b/src/lib/i18n/locales/he.json
index 36013e5..f9b46ed 100644
--- a/src/lib/i18n/locales/he.json
+++ b/src/lib/i18n/locales/he.json
@@ -74,6 +74,11 @@
 				"heading": "פעילות"
 			},
 			"projects": {
+				"actions": {
+					"fork": "",
+					"star": "",
+					"watch": ""
+				},
 				"add_or_import": "",
 				"empty": "עדיין אין כאן פרוייקטים.",
 				"heading": "פרויקטים"
diff --git a/src/lib/i18n/locales/pl.json b/src/lib/i18n/locales/pl.json
index c2c76d4..c7c5437 100644
--- a/src/lib/i18n/locales/pl.json
+++ b/src/lib/i18n/locales/pl.json
@@ -74,6 +74,11 @@
 				"heading": "Aktywność"
 			},
 			"projects": {
+				"actions": {
+					"fork": "",
+					"star": "",
+					"watch": ""
+				},
 				"add_or_import": "{addElementOpen}Dodaj{addElementClose} lub {importElementOpen}zaimportuj projekt{importElementClose}.",
 				"empty": "Nie dodano jeszcze żadnego projektu.",
 				"heading": "Projekty"
diff --git a/tests/components/molecules/Project.test.ts b/tests/components/molecules/Project.test.ts
new file mode 100644
index 0000000..ac566ce
--- /dev/null
+++ b/tests/components/molecules/Project.test.ts
@@ -0,0 +1,141 @@
+/* Component test for Project molecule.
+ * Copyright (C) 2024 André Jaenisch
+ * SPDX-FileCopyrightText: 2024 André Jaenisch
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ *
+ * This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+import '@testing-library/jest-dom';
+import { render, screen } from '@testing-library/svelte';
+import { init, locale, register } from 'svelte-i18n';
+
+import Project from '../../../src/lib/components/molecules/Project.svelte';
+import enMessages from '../../../src/lib/i18n/locales/en.json';
+
+describe('Project.svelte', () => {
+	beforeEach(() => {
+		register('en', () => import('../../../src/lib/i18n/locales/en.json'));
+		init({ fallbackLocale: 'en', initialLocale: 'en' });
+		locale.set('en');
+	});
+
+	it('should mount', () => {
+		// Arrange
+		// Nothing to prepare
+
+		// Act
+		const { container } = render(Project);
+
+		// Assert
+		expect(container).toBeTruthy();
+	});
+
+	it("should show the project's name", () => {
+		// Arrange
+		const collaborators = [];
+		const project = {
+			name: 'Test battery',
+			summary: 'Making sure Anvil is rock solid!'
+		};
+
+		// Act
+		render(Project, { collaborators, project });
+		const projectName = screen.getByText(new RegExp(project.name));
+
+		// Assert
+		expect(projectName).toBeInTheDocument();
+	});
+
+	it("should show the project's summary", () => {
+		// Arrange
+		const collaborators = [];
+		const project = {
+			name: 'Test battery',
+			summary: 'Making sure Anvil is rock solid!'
+		};
+
+		// Act
+		render(Project, { collaborators, project });
+		const projectSummary = screen.getByText(new RegExp(project.summary));
+
+		// Assert
+		expect(projectSummary).toBeInTheDocument();
+	});
+
+	it('should show each collaborator', () => {
+		// Arrange
+		const collaborators = [
+			{
+				preferredUsername: 'Your favourite Project Manager'
+			}
+		];
+		const project = {
+			name: 'Test battery',
+			summary: 'Making sure Anvil is rock solid!'
+		};
+
+		// Act
+		render(Project, { collaborators, project });
+		const renderedCollaborators = screen.getAllByRole('listitem');
+		const renderedCollaborator = screen.getByRole('listitem');
+
+		// Assert
+		expect(renderedCollaborators).toBeDefined();
+		expect(renderedCollaborator).toBeDefined();
+		expect(renderedCollaborators).toHaveLength(collaborators.length);
+		expect(renderedCollaborator).toHaveAttribute('title', collaborators[0].preferredUsername);
+	});
+
+	it('should have a button to fork the project', () => {
+		// Arrange
+		const collaborators = [];
+		const project = {
+			name: 'Test battery',
+			summary: 'Making sure Anvil is rock solid!'
+		};
+
+		// Act
+		render(Project, { collaborators, project });
+		const forkButton = screen.getByRole('button', { name: 'Fork' });
+
+		// Assert
+		expect(forkButton).toBeInTheDocument();
+	});
+
+	it('should have a button to star the project', () => {
+		// Arrange
+		const collaborators = [];
+		const project = {
+			name: 'Test battery',
+			summary: 'Making sure Anvil is rock solid!'
+		};
+
+		// Act
+		render(Project, { collaborators, project });
+		const starButton = screen.getByRole('button', { name: 'Star' });
+
+		// Assert
+		expect(starButton).toBeInTheDocument();
+	});
+
+	it('should have a button to watch the project', () => {
+		// Arrange
+		const collaborators = [];
+		const project = {
+			name: 'Test battery',
+			summary: 'Making sure Anvil is rock solid!'
+		};
+
+		// Act
+		render(Project, { collaborators, project });
+		const watchButton = screen.getByRole('button', { name: 'Watch' });
+
+		// Assert
+		expect(watchButton).toBeInTheDocument();
+	});
+});