Add Cypress test automation framework for SauceDemo

Author: JoanEsquivel

.github/workflows/cypress.yml

@@ -11,39 +11,34 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
-      
+        uses: actions/checkout@v3
+        
       - name: Setup Node.js
-        uses: actions/setup-node@v4
+        uses: actions/setup-node@v3
         with:
-          node-version: 20
+          node-version: '18'
+          cache: 'npm'
 
       - name: Install dependencies
         run: npm install
 
       - name: Create cypress.env.json
         run: |
           echo '{
-            "username": "standard_user",
-            "password": "secret_sauce"
+            "users": {
+              "standard": {
+                "username": "standard_user",
+                "password": "secret_sauce"
+              },
+              "locked": {
+                "username": "locked_out_user",
+                "password": "secret_sauce"
+              }
+            }
           }' > cypress.env.json
-      
+        
       - name: Cypress run
-        uses: cypress-io/github-action@v6
+        uses: cypress-io/github-action@v5
         with:
           browser: chrome
-          
-      - name: Upload artifacts
-        uses: actions/upload-artifact@v4
-        if: always()
-        with:
-          name: cypress-report
-          path: cypress/reports/html
-          if-no-files-found: warn
-          
-      - name: Deploy report to GitHub Pages
-        if: success() && github.ref == 'refs/heads/master'
-        uses: peaceiris/actions-gh-pages@v3
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./cypress/reports/html 
+          headless: true 

.gitignore

@@ -1,6 +1,24 @@
+# Dependencies
 node_modules/
-cypress.env.json
+
+# Cypress generated files
 cypress/videos/
 cypress/screenshots/
-dist/
-.DS_Store 
+cypress/downloads/
+
+# Environment variables with sensitive data
+cypress.env.json
+
+# Logs
+*.log
+npm-debug.log*
+
+# Operating System files
+.DS_Store
+Thumbs.db
+
+# IDE and editor files
+.idea/
+.vscode/
+*.swp
+*.swo 

README.md

@@ -1,28 +1,34 @@
-# SauceDemo Cypress Tests
+# SauceDemo Cypress Test Automation
 
-This project contains automated tests for the SauceDemo website using Cypress with TypeScript.
+This project contains automated tests for the [SauceDemo](https://www.saucedemo.com) website using Cypress with TypeScript.
 
 ## Test Scenarios
 
-1. Valid Login (with Logout)
-2. Locked Out User
+The following test scenarios are automated:
+
+1. **Valid Login Scenario** - Verify that a user can successfully log in with valid credentials
+2. **Locked Out User Scenario** - Verify that an appropriate error message is displayed when a locked out user attempts to log in
 
 ## Project Structure
 
 ```
-├── cypress/
-│   ├── e2e/              # Test files
-│   ├── fixtures/         # Test data
-│   ├── pages/            # Page Object Model classes
-│   ├── support/          # Custom commands and configuration
-│   └── reports/          # Generated test reports
-├── cypress.config.ts     # Cypress configuration
-├── cypress.env.json      # Environment variables (not tracked in git)
-├── tsconfig.json         # TypeScript configuration
-├── package.json          # Dependencies and scripts
-└── README.md             # Project documentation
+├── .github/workflows       # GitHub Actions workflow files
+├── cypress/                # Cypress test files
+│   ├── e2e/                # Test specs
+│   ├── fixtures/           # Test data
+│   ├── pages/              # Page objects
+│   └── support/            # Support files and custom commands
+├── .gitignore              # Git ignore file
+├── cypress.config.ts       # Cypress configuration
+├── cypress.env.json        # Environment variables (not committed to Git)
+├── package.json            # Project dependencies and scripts
+└── tsconfig.json           # TypeScript configuration
 ```
 
+## Page Object Model
+
+The tests use the Page Object Model pattern to create a layer of abstraction between the test code and the UI. Page objects are in the `cypress/pages` directory.
+
 ## Installation
 
 1. Clone the repository
@@ -32,28 +38,41 @@ This project contains automated tests for the SauceDemo website using Cypress wi
 npm install
 ```
 
-## Running Tests
+3. Create a `cypress.env.json` file with the following content:
+
+```json
+{
+  "users": {
+    "standard": {
+      "username": "standard_user",
+      "password": "secret_sauce"
+    },
+    "locked": {
+      "username": "locked_out_user",
+      "password": "secret_sauce"
+    }
+  }
+}
+```
+
+## Running the Tests
+
+### Headless Mode
 
 To run tests in headless mode:
 
 ```bash
 npm run cy:run
 ```
 
-To open Cypress GUI:
+### Interactive Mode
+
+To open Cypress in interactive mode:
 
 ```bash
 npm run cy:open
 ```
 
-## Reports
-
-Test reports are generated in the `cypress/reports/html` directory after running tests in headless mode.
-
-## GitHub Actions
-
-This project uses GitHub Actions for continuous integration. The workflow installs dependencies and runs the Cypress tests automatically on push or pull request to the master branch.
-
-## Page Object Model
+## CI/CD
 
-The tests use the Page Object Model pattern to separate test logic from page-specific selectors and actions, making the tests more maintainable and readable. 
+This project includes GitHub Actions workflows for continuous integration. Tests are automatically run on push to the master branch and on pull requests to the master branch.