Merge pull request #3 from lucas-scandido/ci-cd

[CI/CD] Create CI/CD Pipeline

Author: lucas-scandido

.github/workflows/ci.yml

@@ -0,0 +1,56 @@
+name: Robot Framework Tests
+
+on: push
+
+jobs:
+  api_tests:
+    name: API Test
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+
+      - name: Install Dependencies
+        run: pip install -r requirements.txt
+
+      - name: Run API Tests
+        run: robot -d results/api tests/api
+
+      - name: Upload API Test Results
+        uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: api-test-results
+          path: results/api
+
+  e2e_tests:
+    name: E2E Test
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+
+      - name: Install Dependencies
+        run: pip install -r requirements.txt
+
+      - name: Run E2E Tests
+        run: robot -d results/e2e -v OPTIONS:"add_argument('--headless')" tests/e2e
+
+      - name: Upload E2E Test Results
+        uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: e2e-test-results
+          path: results/e2e

README.md

@@ -1,5 +1,5 @@
-# ServeRest - Automated Tests
-E2E Test Automation Project for the application **[ServeRest](https://serverest.dev/)** using **Robot Framework** with **Selenium Library**.
+# ServeRest - Automated Tests [![Robot Framework Tests](https://github.com/lucas-scandido/challenge-robot-ambev/actions/workflows/ci.yml/badge.svg)](https://github.com/lucas-scandido/challenge-robot-ambev/actions/workflows/ci.yml)
+Test Automation Project for the application **[ServeRest](https://serverest.dev/)** using **Robot Framework** with **Selenium Library**.
 
 # Prerequisites
 1. **[Python](https://www.python.org/downloads/)** version: `>=3.13.1`.
@@ -36,6 +36,9 @@ The project structure was developed based on documentation: [Robot Framework - P
 
 - **Folder Structure:**
 ```
+├── .github/                                            # GitHub specific configurations, such as workflows and other GitHub Actions.   
+    └── workflows                                       # CI Workflows Folder                                     
+        └── ci.yml/                                     # Continuous integration configuration file
 ├── helpers/                                            # Helpers needed to run the tests, including fixtures and locators    
     └── fixtures/                                       # Static data files used during test execution                                    
         └── signup/                                     # Signup Fixtures    
@@ -44,7 +47,7 @@ The project structure was developed based on documentation: [Robot Framework - P
             └── response.json                           # JSON file that stores all response messages returned from the user API                                    
     └── locators/                                       # Locators used to interact with page elements                                  
         └── locators.py                                 # Python file containing the mapped locators   
-├── resources/                                          # Reusable keywords
+├── resources/                                          # Reusable Keywords
     └── api/                                            # API Keywords
         └── users/                                      # API Users Folder
             └── users.resource                          # API Users Keywords

requirements.txt

@@ -2,4 +2,5 @@ robotframework==7.2
 robotframework-faker==5.0.0
 robotframework-jsonlibrary==0.5
 robotframework-requests==0.9.7
-robotframework-seleniumlibrary==6.7.0
+robotframework-seleniumlibrary==6.7.0
+setuptools>=58.0.0

resources/api/api_common.resource

@@ -2,10 +2,10 @@
 Documentation    This file contains API common variables and keywords that are 
 ...              used across all the API test cases.
 
-Library      RequestsLibrary
+Library     RequestsLibrary
 
-Resource     ../../resources/e2e/e2e_common.resource
-Resource     ../../resources/api/users/users.resource
+Resource    ../../resources/e2e/e2e_common.resource
+Resource    ../../resources/api/users/users.resource
 
 *** Variables ***
 ${API_URL}          https://serverest.dev

resources/api/users/users.resource

@@ -2,7 +2,7 @@
 Library    RequestsLibrary
 Library    Collections
 
-Resource     ../../../resources/api/api_common.resource
+Resource    ../../../resources/api/api_common.resource
 
 *** Variables ***
 ${USERS}    /usuarios
@@ -26,9 +26,9 @@ Delete Users
     Send DELETE Request    ${USERS}/${POST_RESPONSE}[_id]    200
 
 Response Should Contain Message
-    [Arguments]    ${response_type}    ${field}    ${expected_message}
-    Dictionary Should Contain Item    ${response_type}    ${field}    ${expected_message}
-    Should Not Be Empty               ${expected_message}
+    [Arguments]    ${response_type}    ${field}            ${expected_message}
+    Dictionary Should Contain Item     ${response_type}    ${field}    ${expected_message}
+    Should Not Be Empty                ${expected_message}
 
 Dictionary Should Contain
     [Arguments]    ${response}    @{expected_keys}

resources/e2e/e2e_common.resource

@@ -11,14 +11,15 @@ Resource     ../../resources/e2e/signup/signup.resource
 Variables    ../../helpers/locators/locators.py
 
 *** Variables ***
+${OPTIONS}          ${None}
 ${BASE_URL}         https://front.serverest.dev
 ${USER_NAME}        Lucas Candido
 ${USER_EMAIL}       beltrano@qa.com.br
 ${USER_PASSWORD}    password2025
 
 *** Keywords ***
 Start Session
-    Open Browser    browser=chrome
+    Open Browser    browser=chrome    options=${OPTIONS}    
 
 Close Session
     Close Browser

resources/e2e/signup/signup.resource

@@ -2,7 +2,7 @@
 Library     SeleniumLibrary
 Library     String
 
-Resource     ../../../resources/e2e/e2e_common.resource
+Resource    ../../../resources/e2e/e2e_common.resource
 
 *** Keywords ***
 Input Name
@@ -34,7 +34,7 @@ Select User As Admin
     END
 
 Submit Registration
-    Button Action                    ${SIGNUP_BUTTON}
+    Button Action    ${SIGNUP_BUTTON}
 
 Alert Success Should Be Displayed
     Wait Until Element Is Visible    ${ALERT}
@@ -45,12 +45,12 @@ Alert Success Should Be Displayed
 
 Alert Error Should Be
     [Arguments]    ${alerts}    ${expected_errors}
-    Wait Until Element Is Visible      ${ALERT}  
+    Wait Until Element Is Visible     ${ALERT}  
     @{errors_list}    Split String    ${expected_errors}    ,
     FOR    ${error}    IN    @{errors_list}
-        ${error}    Strip String    ${error}
-        ${locator}    Set Variable     ${ERROR_MESSAGES.replace('{}', "${alerts}[${error}]")}    
-        Check Element Details          ${locator}    ${alerts}[${error}]
+        ${error}    Strip String      ${error}
+        ${locator}    Set Variable    ${ERROR_MESSAGES.replace('{}', "${alerts}[${error}]")}    
+        Check Element Details    ${locator}    ${alerts}[${error}]
     END
     ${alert_error_color} =    Execute Javascript    
     ...    return window.getComputedStyle(document.querySelector('.alert')).backgroundColor;

tests/api/users/get/get_invalid_users.robot

@@ -12,7 +12,7 @@ Test Teardown     Delete Users
 Suite Teardown    Close Api Session
 Test Template     Search Users With Invalid Data
 
-*** Test Cases ***                   KEY              VALUE               FIELD             MESSAGE 
+*** Test Cases ***                   KEY              VALUE               FIELD            MESSAGE 
 Empty Email                          email            ${EMPTY}            email            emailShouldBeString           
 Invalid Email                        email            ${INVALID_EMAIL}    email            invalidEmail         
 Invalid Email As A Number            email            ${INVALID_DATA}     email            emailShouldBeString           

tests/api/users/get/get_users.robot

@@ -26,6 +26,6 @@ Search Admin User          administrador    true
 *** Keywords ***
 Search Users
     [Arguments]    ${key}    ${value}
-    ${params}      Create Dictionary    ${key}=${value}
+    ${params}      Create Dictionary       ${key}=${value}
     Send GET Request    200    ${USERS}    params=${params}
-    Dictionary List Should Contain    ${GET_RESPONSE}   @{EXPECTED_KEYS}
+    Dictionary List Should Contain         ${GET_RESPONSE}   @{EXPECTED_KEYS}

tests/api/users/post/post_invalid_users.robot

@@ -26,7 +26,7 @@ Invalid Administrator As A Number    ${USER_NAME}       ${USER_EMAIL}       ${US
 *** Keywords ***
 Create User With Invalid Data
     [Arguments]    ${name}    ${email}    ${password}    ${is_admin}    ${field}    ${expected_message}
-    ${body}        Update User Data    ${name}      ${email}    ${password}    ${is_admin}
+    ${body}        Update User Data    ${name}    ${email}    ${password}    ${is_admin}
     ${message}     Get fixture    users    response    errors
     Send POST Request    ${USERS}     ${body}        400
     Response Should Contain Message    ${POST_RESPONSE}    ${field}    ${message}[${expected_message}]