feat: implement CI/CD pipeline with GitHub Actions

Author: blink-zero

.github/workflows/ci.yml

@@ -0,0 +1,74 @@
+name: PowerPulse CI/CD
+
+on:
+  push:
+    branches: [ main, develop, 'release/**' ]
+  pull_request:
+    branches: [ main, develop ]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+          cache: 'npm'
+      - name: Install dependencies
+        run: npm run install-all
+      - name: Lint client code
+        run: cd client && npm run lint
+      - name: Lint server code
+        run: cd server && npm run lint
+
+  test:
+    runs-on: ubuntu-latest
+    needs: lint
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+          cache: 'npm'
+      - name: Install dependencies
+        run: npm run install-all
+      - name: Run client tests
+        run: cd client && npm test
+      - name: Run server tests
+        run: cd server && npm test
+
+  build:
+    runs-on: ubuntu-latest
+    needs: test
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+          cache: 'npm'
+      - name: Install dependencies
+        run: npm run install-all
+      - name: Build client
+        run: cd client && npm run build
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v3
+        with:
+          name: build-files
+          path: client/dist
+
+  # Optional: Add deployment job for production releases
+  deploy:
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Download build artifacts
+        uses: actions/download-artifact@v3
+        with:
+          name: build-files
+          path: client/dist
+      # Add deployment steps here (e.g., to GitHub Pages, Docker Hub, or your hosting provider)

CONTRIBUTING.md

@@ -105,13 +105,44 @@ Common types are:
 
 ## Testing Your Stuff
 
-- Try to write tests for new features
-- Run the existing tests before submitting:
-  ```
-  npm test
-  ```
+We have a comprehensive testing setup with Jest for the server and Vitest for the client:
+
+### Client Testing
+- Run client tests: `cd client && npm test`
+- Watch mode: `cd client && npm run test:watch`
+- Coverage report: `cd client && npm run test:coverage`
+
+### Server Testing
+- Run server tests: `cd server && npm test`
+- Watch mode: `cd server && npm run test:watch`
+- Coverage report: `cd server && npm run test:coverage`
+
+### Writing Tests
+- Client tests go in `client/src/test` or alongside components with `.test.jsx` extension
+- Server tests go in `server/tests` with `.test.js` extension
+- Focus on testing functionality, not implementation details
 - Don't worry about 100% coverage - just test the important parts
 
+## Linting
+
+We use ESLint to maintain code quality:
+
+- Lint client code: `cd client && npm run lint`
+- Fix client code: `cd client && npm run lint:fix`
+- Lint server code: `cd server && npm run lint`
+- Fix server code: `cd server && npm run lint:fix`
+
+## CI/CD Pipeline
+
+We use GitHub Actions for our CI/CD pipeline:
+
+- Every PR and push to main/develop branches triggers the pipeline
+- The pipeline runs linting, tests, and builds the application
+- All checks must pass before a PR can be merged
+- Tagged releases are automatically built and prepared for deployment
+
+When you submit a PR, check the GitHub Actions tab to see if your changes pass all checks.
+
 ## Updating Docs
 
 If you're changing how something works:

client/.eslintrc.js

@@ -0,0 +1,33 @@
+module.exports = {
+  env: {
+    browser: true,
+    es2021: true,
+    node: true,
+  },
+  extends: [
+    'eslint:recommended',
+    'plugin:react/recommended',
+    'plugin:react-hooks/recommended',
+  ],
+  parserOptions: {
+    ecmaFeatures: {
+      jsx: true,
+    },
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+  },
+  plugins: ['react', 'react-hooks'],
+  settings: {
+    react: {
+      version: 'detect',
+    },
+  },
+  rules: {
+    'react/react-in-jsx-scope': 'off', // Not needed in React 17+
+    'react/prop-types': 'warn', // Warn about missing prop types
+    'no-unused-vars': 'warn', // Warn about unused variables
+    'react-hooks/rules-of-hooks': 'error', // Enforce Rules of Hooks
+    'react-hooks/exhaustive-deps': 'warn', // Warn about missing dependencies
+    'no-console': ['warn', { allow: ['warn', 'error'] }], // Warn about console.log, but allow console.warn and console.error
+  },
+};

client/package.json

@@ -11,7 +11,12 @@
   "scripts": {
     "dev": "vite",
     "build": "vite build",
-    "preview": "vite preview"
+    "preview": "vite preview",
+    "lint": "eslint src --ext .js,.jsx",
+    "lint:fix": "eslint src --ext .js,.jsx --fix",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage"
   },
   "dependencies": {
     "axios": "^1.7.9",
@@ -24,12 +29,19 @@
     "react-router-dom": "^6.10.0"
   },
   "devDependencies": {
+    "@testing-library/jest-dom": "^6.1.4",
+    "@testing-library/react": "^14.0.0",
     "@types/react": "^18.0.28",
     "@types/react-dom": "^18.0.11",
     "@vitejs/plugin-react": "^3.1.0",
     "autoprefixer": "^10.4.14",
+    "eslint": "^8.38.0",
+    "eslint-plugin-react": "^7.32.2",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "jsdom": "^22.1.0",
     "postcss": "^8.4.21",
     "tailwindcss": "^3.3.1",
-    "vite": "^4.2.0"
+    "vite": "^4.2.0",
+    "vitest": "^0.34.6"
   }
 }

client/src/test/example.test.jsx

@@ -0,0 +1,36 @@
+import { describe, it, expect } from 'vitest';
+import { render, screen } from '@testing-library/react';
+import appConfig from '../config/appConfig';
+
+// This is a simple example test to demonstrate testing setup
+describe('Application Configuration', () => {
+  it('has the correct version number', () => {
+    expect(appConfig.version).toBe('1.8.2');
+  });
+
+  it('has the correct app name', () => {
+    expect(appConfig.appName).toBe('PowerPulse');
+  });
+
+  it('has a valid GitHub URL', () => {
+    expect(appConfig.githubUrl).toMatch(/^https:\/\/github\.com\//);
+  });
+});
+
+// Example of how to test a component (you would need to create this component)
+/*
+import ExampleButton from '../components/ExampleButton';
+
+describe('ExampleButton Component', () => {
+  it('renders correctly', () => {
+    render(<ExampleButton label="Click me" />);
+    expect(screen.getByText('Click me')).toBeInTheDocument();
+  });
+
+  it('has the correct CSS class', () => {
+    render(<ExampleButton label="Click me" />);
+    const button = screen.getByText('Click me');
+    expect(button).toHaveClass('btn');
+  });
+});
+*/

client/src/test/setup.js

@@ -0,0 +1,11 @@
+import { expect, afterEach } from 'vitest';
+import { cleanup } from '@testing-library/react';
+import matchers from '@testing-library/jest-dom/matchers';
+
+// Extend Vitest's expect method with methods from react-testing-library
+expect.extend(matchers);
+
+// Runs a cleanup after each test case (e.g. clearing jsdom)
+afterEach(() => {
+  cleanup();
+});

client/vitest.config.js

@@ -0,0 +1,15 @@
+import { defineConfig } from 'vitest/config';
+import react from '@vitejs/plugin-react';
+
+export default defineConfig({
+  plugins: [react()],
+  test: {
+    globals: true,
+    environment: 'jsdom',
+    setupFiles: ['./src/test/setup.js'],
+    coverage: {
+      reporter: ['text', 'json', 'html'],
+      exclude: ['node_modules/', 'src/test/'],
+    },
+  },
+});

server/.eslintrc.js

@@ -0,0 +1,21 @@
+module.exports = {
+  env: {
+    node: true,
+    es2021: true,
+    jest: true,
+  },
+  extends: ['eslint:recommended'],
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+  },
+  rules: {
+    'no-unused-vars': 'warn', // Warn about unused variables
+    'no-console': 'off', // Allow console in server code
+    'no-process-exit': 'warn', // Warn about process.exit()
+    'no-useless-escape': 'warn', // Warn about unnecessary escape characters
+    'no-empty': 'warn', // Warn about empty blocks
+    'prefer-const': 'warn', // Prefer const over let when possible
+    'no-var': 'warn', // Prefer let/const over var
+  },
+};

server/jest.config.js

@@ -0,0 +1,12 @@
+module.exports = {
+  testEnvironment: 'node',
+  verbose: true,
+  collectCoverage: false,
+  coverageDirectory: 'coverage',
+  coveragePathIgnorePatterns: ['/node_modules/', '/tests/'],
+  testMatch: ['**/__tests__/**/*.js', '**/?(*.)+(spec|test).js'],
+  testPathIgnorePatterns: ['/node_modules/'],
+  transform: {},
+  // Since we're using CommonJS in the server, we don't need to transform
+  // If you switch to ES modules, you might need to add transformers
+};

server/package.json

@@ -11,7 +11,11 @@
   "scripts": {
     "start": "node server.js",
     "dev": "nodemon server.js",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage",
+    "lint": "eslint . --ext .js",
+    "lint:fix": "eslint . --ext .js --fix"
   },
   "keywords": [
     "ups",
@@ -32,6 +36,9 @@
     "sqlite3": "^5.1.6"
   },
   "devDependencies": {
-    "nodemon": "^2.0.22"
+    "eslint": "^8.38.0",
+    "jest": "^29.5.0",
+    "nodemon": "^2.0.22",
+    "supertest": "^6.3.3"
   }
 }

server/tests/example.test.js

@@ -0,0 +1,35 @@
+const { describe, it, expect } = require('@jest/globals');
+
+// This is a simple example test to demonstrate testing setup
+describe('Server Environment', () => {
+  it('has the correct NODE_ENV', () => {
+    // During tests, NODE_ENV should be 'test'
+    expect(process.env.NODE_ENV).not.toBe('production');
+  });
+
+  it('can perform basic assertions', () => {
+    expect(1 + 1).toBe(2);
+    expect('PowerPulse').toContain('Power');
+    expect({ name: 'PowerPulse' }).toHaveProperty('name');
+  });
+});
+
+// Example of how to test an API endpoint (you would implement this)
+/*
+const request = require('supertest');
+const app = require('../app'); // Import your Express app
+
+describe('API Endpoints', () => {
+  it('GET /api/status returns 200', async () => {
+    const response = await request(app).get('/api/status');
+    expect(response.statusCode).toBe(200);
+    expect(response.body).toHaveProperty('status', 'ok');
+  });
+
+  it('GET /api/version returns correct version', async () => {
+    const response = await request(app).get('/api/version');
+    expect(response.statusCode).toBe(200);
+    expect(response.body).toHaveProperty('version', '1.8.2');
+  });
+});
+*/