express REST API with cypress tests

Author: ItsWachira

.gitignore

@@ -0,0 +1,6 @@
+
+node_modules
+package-lock.json
+.env
+
+

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Make Use Of
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

controllers/userControllers.js

@@ -0,0 +1,51 @@
+
+const users = [];
+
+
+// Create a new user object and push it into the 'users' array
+exports.registerUser = async (req, res) => {
+  const { username, password } = req.body;
+
+  try {
+    
+    const newUser = { username, password };
+    users.push(newUser);
+
+    res.status(201).send({ message: 'User registered successfully' });
+  } catch (error) {
+    console.error(error);
+    res.status(500).send({ message: 'An error occurred!!' });
+  }
+};
+
+// Retrieve all users
+exports.getUsers = async (req, res) => {
+  try {
+    
+    res.json(users);
+  } catch (error) {
+    console.error(error);
+    res.status(500).send({ message: 'An error occurred!!' });
+  }
+};
+
+// Find a user with the provided username and password
+
+exports.loginUser = async (req, res) => {
+  const { username, password } = req.body;
+
+  try {
+    
+    const user = users.find((u) => u.username === username && u.password === password);
+
+    if (user) {
+      res.status(200).send({ message: 'Login successful' });
+    } else {
+      res.status(401).send({ message: 'Invalid credentials' });
+    }
+  } catch (error) {
+    console.error(error);
+    res.status(500).send({ message: 'An error occurred!!' });
+  }
+};
+

cypress.config.js

@@ -0,0 +1,13 @@
+const { defineConfig } = require("cypress");
+
+module.exports = defineConfig({
+  chromeWebSecurity: false, 
+  e2e: {
+    baseUrl: 'http://localhost:5000',
+    setupNodeEvents(on, config) {
+      
+    },
+  },
+});
+
+

cypress/e2e/user.routes.spec.cy.js

@@ -0,0 +1,42 @@
+
+const baseUrl = Cypress.config().baseUrl;
+
+describe('User Routes', () => {
+  it('registers a new user', () => {  
+    cy.fixture('example').then((testUser) => {  
+      cy.request({
+        method: 'POST',
+        url: `${baseUrl}/v1/api/register`, 
+        body: testUser, 
+      }).then((response) => {  
+        expect(response.status).to.eq(201); 
+        expect(response.body.message).to.eq('User registered successfully');
+      });
+    });
+  });
+
+  it('gets users data and the username matches test data', () => {
+    cy.fixture('example').then((expectedUserData) => {
+      cy.request({
+        method: 'GET',
+        url: `${baseUrl}/v1/api/users`,
+      }).then((response) => {
+        expect(response.status).to.eq(200);
+        const username = response.body[0].username;
+        expect(username).to.eq(expectedUserData.username);
+      });
+    });
+  });
+
+  it('logs in a user', () => { 
+    cy.fixture('example').then((loginData) => {
+      cy.request({
+        method: 'POST',
+        url: `${baseUrl}/v1/api/login`, 
+        body: loginData, 
+      }).then((response) => {
+        expect(response.status).to.eq(200);
+      });
+    });
+  });
+});

cypress/fixtures/example.json

@@ -0,0 +1,4 @@
+{
+  "username": "testuser",
+  "password": "password123"
+}

cypress/support/commands.js

@@ -0,0 +1,25 @@
+// ***********************************************
+// This example commands.js shows you how to
+// create various custom commands and overwrite
+// existing commands.
+//
+// For more comprehensive examples of custom
+// commands please read more here:
+// https://on.cypress.io/custom-commands
+// ***********************************************
+//
+//
+// -- This is a parent command --
+// Cypress.Commands.add('login', (email, password) => { ... })
+//
+//
+// -- This is a child command --
+// Cypress.Commands.add('drag', { prevSubject: 'element'}, (subject, options) => { ... })
+//
+//
+// -- This is a dual command --
+// Cypress.Commands.add('dismiss', { prevSubject: 'optional'}, (subject, options) => { ... })
+//
+//
+// -- This will overwrite an existing command --
+// Cypress.Commands.overwrite('visit', (originalFn, url, options) => { ... })

cypress/support/e2e.js

@@ -0,0 +1,20 @@
+// ***********************************************************
+// This example support/e2e.js is processed and
+// loaded automatically before your test files.
+//
+// This is a great place to put global configuration and
+// behavior that modifies Cypress.
+//
+// You can change the location of this file or turn off
+// automatically serving support files with the
+// 'supportFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/configuration
+// ***********************************************************
+
+// Import commands.js using ES2015 syntax:
+import './commands'
+
+// Alternatively you can use CommonJS syntax:
+// require('./commands')

package.json

@@ -0,0 +1,18 @@
+{
+  "name": "server",
+  "version": "1.0.0",
+  "description": "",
+  "main": "server.js",
+  "scripts": {
+    "test": "npx cypress open"
+  },
+  "author": "Gichuhi Wachira",
+  "license": "ISC",
+  "dependencies": {
+    "cors": "^2.8.5",
+    "express": "^4.18.2"
+  },
+  "devDependencies": {
+    "cypress": "^13.1.0"
+  }
+}

routes/userRoutes.js

@@ -0,0 +1,11 @@
+const express = require('express');
+const router = express.Router();
+const userControllers = require('../controllers/userControllers');
+
+const baseURL = '/v1/api/';
+
+router.post(baseURL + 'register', userControllers.registerUser);
+router.get(baseURL + 'users', userControllers.getUsers);
+router.post(baseURL + 'login', userControllers.loginUser);
+
+module.exports = router;

server.js

@@ -0,0 +1,21 @@
+const express = require('express');
+const cors = require('cors');
+const app = express();
+const port = 5000;
+
+
+app.use(express.json());
+app.use(express.urlencoded({ extended: true }));
+app.use(cors());
+
+
+const userRoutes = require('./routes/userRoutes');
+
+app.use('/', userRoutes);
+
+app.listen(port, () => {
+  console.log(`Server is listening at http://localhost:${port}`);
+});
+
+
+module.exports = app;