test: [#310] added tests for a guest user to see the list page when there are no torrents in the index

Author: MMelchor

cypress.config.ts

@@ -1,6 +1,6 @@
 import { defineConfig } from "cypress";
 import { grantAdminRole, deleteUser } from "./cypress/e2e/contexts/user/tasks";
-import { deleteTorrent } from "./cypress/e2e/contexts/torrent/tasks";
+import { deleteTorrent, deleteTorrentsInfoFromDatabase } from "./cypress/e2e/contexts/torrent/tasks";
 import { deleteCategory, addCategory } from "./cypress/e2e/contexts/category/tasks";
 import { DatabaseConfig } from "./cypress/e2e/common/database";
 
@@ -26,6 +26,9 @@ export default defineConfig({
         deleteTorrent: ({ infohash }) => {
           return deleteTorrent(infohash, databaseConfig(config));
         },
+        deleteTorrentsInfoFromDatabase: () => {
+          return deleteTorrentsInfoFromDatabase(databaseConfig(config));
+        },
         // User context
         grantAdminRole: ({ username }) => {
           return grantAdminRole(username, databaseConfig(config));

cypress/e2e/contexts/torrent/commands.ts

@@ -40,3 +40,7 @@ Cypress.Commands.add("delete_torrent_from_database_and_fixture", (torrent_info,
   // Delete the torrent file in the fixtures folder
   cy.exec(`rm ${torrent_info.path}`);
 });
+
+Cypress.Commands.add("clear_torrent_info_from_database", () => {
+  cy.task("deleteTorrentsInfoFromDatabase");
+});

cypress/e2e/contexts/torrent/specs/list/no_torrents_to_display.cy.ts

@@ -0,0 +1,14 @@
+import { baseURL } from "nuxt/dist/core/runtime/nitro/paths";
+
+describe("A guest user", () => {
+  before(() => {
+    // Deletes all torrents and their related info from the database so the test can pass
+    cy.clear_torrent_info_from_database();
+  });
+
+  it("Should be able to see the list page when there are no torrents", () => {
+    cy.visit("/torrents");
+    cy.url().should("match", /\/torrents$/);
+    cy.get("[data-cy=\"no-results-element\"]").invoke("text").should("match", /No results./i);
+  });
+});

cypress/e2e/contexts/torrent/tasks.ts

@@ -20,3 +20,69 @@ function deleteTorrentQuery (infohash: string): DatabaseQuery {
     params: [infohash]
   };
 }
+
+// Task to delete all torrents from the database before running any test
+export const deleteTorrentsInfoFromDatabase = async (db_config: DatabaseConfig): Promise<Boolean> => {
+  try {
+    await runDatabaseQuery(clearTorrentsTableQuery(), db_config);
+    await runDatabaseQuery(clearAnnounceUrlsTableQuery(), db_config);
+    await runDatabaseQuery(clearTorrentFilesTableQuery(), db_config);
+    await runDatabaseQuery(clearTorrentInfoTableQuery(), db_config);
+    await runDatabaseQuery(clearTorrentInfoHashesTableQuery(), db_config);
+    await runDatabaseQuery(clearTagLinkTableQuery(), db_config);
+    await runDatabaseQuery(clearTrackerStatsTableQuery(), db_config);
+    return true;
+  } catch (err) {
+    return await Promise.reject(err);
+  }
+};
+
+// Database query specifications
+function clearTorrentsTableQuery (): DatabaseQuery {
+  return {
+    query: "DELETE FROM torrust_torrents",
+    params: []
+  };
+}
+
+function clearAnnounceUrlsTableQuery (): DatabaseQuery {
+  return {
+    query: "DELETE FROM torrust_torrent_announce_urls",
+    params: []
+  };
+}
+
+function clearTorrentFilesTableQuery (): DatabaseQuery {
+  return {
+    query: "DELETE FROM torrust_torrent_files",
+    params: []
+  };
+}
+
+function clearTorrentInfoTableQuery (): DatabaseQuery {
+  return {
+    query: "DELETE FROM torrust_torrent_info",
+    params: []
+  };
+}
+
+function clearTorrentInfoHashesTableQuery (): DatabaseQuery {
+  return {
+    query: "DELETE FROM torrust_torrent_info_hashes",
+    params: []
+  };
+}
+
+function clearTagLinkTableQuery (): DatabaseQuery {
+  return {
+    query: "DELETE FROM torrust_torrent_tag_links",
+    params: []
+  };
+}
+
+function clearTrackerStatsTableQuery (): DatabaseQuery {
+  return {
+    query: "DELETE FROM torrust_torrent_tracker_stats",
+    params: []
+  };
+}

cypress/support/commands.ts

@@ -2,8 +2,8 @@ import "../e2e/contexts/user/commands";
 import "../e2e/contexts/torrent/commands";
 import "../e2e/contexts/category/commands";
 import "../e2e/common/commands";
-import { TestTorrentInfo } from "cypress/e2e/contexts/torrent/test_torrent_info";
 import { RegistrationForm } from "../e2e/contexts/user/registration";
+import { TestTorrentInfo } from "cypress/e2e/contexts/torrent/test_torrent_info";
 
 declare global {
   namespace Cypress {
@@ -27,6 +27,7 @@ declare global {
       // Torrent context
       upload_torrent(torrent_info: TestTorrentInfo): Chainable<void>
       delete_torrent_from_database_and_fixture(torrent_info: TestTorrentInfo, infohash: string): Chainable<void>
+      clear_torrent_info_from_database(): Chainable<void>;
 
       // Category context
       delete_category_from_database(name: string): Chainable<void>

pages/torrents.vue

@@ -51,7 +51,7 @@
             <Pagination v-model:current-page="currentPage" v-model:page-size="pageSize" :total-results="torrentsTotal" />
           </template>
           <template v-else>
-            <span class="text-neutral-content">No results.</span>
+            <span data-cy="no-results-element" class="text-neutral-content">No results.</span>
           </template>
         </div>
       </div>