Auto merge of #2120 - Turbo87:mirage-tests, r=locks

Add tests for the mirage mock server implemenation

For the frontend test suite we use a mock API server based on https://www.ember-cli-mirage.com/. Since we want to make sure that our mock server returns consistent results that match what the production server would return, we should also write tests for the mock server.

This PR implements a first few tests for our current mirage setup. The results of those tests are not entirely perfect yet so we will likely have to refactor some of the mirage code, which should become quite a bit safer with these new tests.

r? @locks

Author: bors

tests/mirage/categories-test.js

@@ -0,0 +1,183 @@
+import { setupTest } from 'ember-qunit';
+import { module, test } from 'qunit';
+
+import setupMirage from '../helpers/setup-mirage';
+import fetch from 'fetch';
+
+module('Mirage | Categories', function(hooks) {
+  setupTest(hooks);
+  setupMirage(hooks);
+
+  module('GET /api/v1/categories', function() {
+    test('empty case', async function(assert) {
+      let response = await fetch('/api/v1/categories');
+      assert.equal(response.status, 200);
+
+      let responsePayload = await response.json();
+      assert.deepEqual(responsePayload, {
+        categories: [],
+        meta: {
+          total: 0,
+        },
+      });
+    });
+
+    test('returns a paginated categories list', async function(assert) {
+      this.server.create('category', {
+        category: 'no-std',
+        description: 'Crates that are able to function without the Rust standard library.',
+      });
+      this.server.createList('category', 2);
+
+      let response = await fetch('/api/v1/categories');
+      assert.equal(response.status, 200);
+
+      let responsePayload = await response.json();
+      assert.deepEqual(responsePayload, {
+        categories: [
+          {
+            id: 'category-1',
+            category: 'Category 1',
+            crates_cnt: 0,
+            created_at: '2010-06-16T21:30:45Z',
+            description: 'This is the description for the category called "Category 1"',
+            slug: 'category-1',
+          },
+          {
+            id: 'category-2',
+            category: 'Category 2',
+            crates_cnt: 0,
+            created_at: '2010-06-16T21:30:45Z',
+            description: 'This is the description for the category called "Category 2"',
+            slug: 'category-2',
+          },
+          {
+            id: 'no-std',
+            category: 'no-std',
+            crates_cnt: 0,
+            created_at: '2010-06-16T21:30:45Z',
+            description: 'Crates that are able to function without the Rust standard library.',
+            slug: 'no-std',
+          },
+        ],
+        meta: {
+          total: 3,
+        },
+      });
+    });
+
+    test('never returns more than 10 results', async function(assert) {
+      this.server.createList('category', 25);
+
+      let response = await fetch('/api/v1/categories');
+      assert.equal(response.status, 200);
+
+      let responsePayload = await response.json();
+      assert.equal(responsePayload.categories.length, 10);
+      assert.equal(responsePayload.meta.total, 25);
+    });
+
+    test('supports `page` and `per_page` parameters', async function(assert) {
+      this.server.createList('category', 25, {
+        category: i => `cat-${String(i + 1).padStart(2, '0')}`,
+      });
+
+      let response = await fetch('/api/v1/categories?page=2&per_page=5');
+      assert.equal(response.status, 200);
+
+      let responsePayload = await response.json();
+      assert.equal(responsePayload.categories.length, 5);
+      assert.deepEqual(
+        responsePayload.categories.map(it => it.id),
+        ['cat-06', 'cat-07', 'cat-08', 'cat-09', 'cat-10'],
+      );
+      assert.equal(responsePayload.meta.total, 25);
+    });
+  });
+
+  module('GET /api/v1/categories/:id', function() {
+    test('returns 404 for unknown categories', async function(assert) {
+      let response = await fetch('/api/v1/categories/foo');
+      assert.equal(response.status, 404);
+
+      let responsePayload = await response.json();
+      assert.deepEqual(responsePayload, { errors: [{ detail: 'Not Found' }] });
+    });
+
+    test('returns a category object for known categories', async function(assert) {
+      this.server.create('category', {
+        category: 'no-std',
+        description: 'Crates that are able to function without the Rust standard library.',
+      });
+
+      let response = await fetch('/api/v1/categories/no-std');
+      assert.equal(response.status, 200);
+
+      let responsePayload = await response.json();
+      assert.deepEqual(responsePayload, {
+        category: {
+          id: 'no-std',
+          category: 'no-std',
+          crates_cnt: 0,
+          created_at: '2010-06-16T21:30:45Z',
+          description: 'Crates that are able to function without the Rust standard library.',
+          slug: 'no-std',
+        },
+      });
+    });
+  });
+
+  module('GET /api/v1/category_slugs', function() {
+    test('empty case', async function(assert) {
+      let response = await fetch('/api/v1/category_slugs');
+      assert.equal(response.status, 200);
+
+      let responsePayload = await response.json();
+      assert.deepEqual(responsePayload, {
+        category_slugs: [],
+      });
+    });
+
+    test('returns a category slugs list', async function(assert) {
+      this.server.create('category', {
+        category: 'no-std',
+        description: 'Crates that are able to function without the Rust standard library.',
+      });
+      this.server.createList('category', 2);
+
+      let response = await fetch('/api/v1/category_slugs');
+      assert.equal(response.status, 200);
+
+      let responsePayload = await response.json();
+      assert.deepEqual(responsePayload, {
+        category_slugs: [
+          {
+            description: 'This is the description for the category called "Category 1"',
+            id: 'category-1',
+            slug: 'category-1',
+          },
+          {
+            description: 'This is the description for the category called "Category 2"',
+            id: 'category-2',
+            slug: 'category-2',
+          },
+          {
+            description: 'Crates that are able to function without the Rust standard library.',
+            id: 'no-std',
+            slug: 'no-std',
+          },
+        ],
+      });
+    });
+
+    test('has no pagination', async function(assert) {
+      this.server.createList('category', 25);
+
+      let response = await fetch('/api/v1/category_slugs');
+      assert.equal(response.status, 200);
+
+      let responsePayload = await response.json();
+      assert.equal(responsePayload.category_slugs.length, 25);
+    });
+  });
+});