Versions Compared

Old Version 3

changes.mady.by.user Sathwik A Bangera

Saved on

compared with

New Version Current

changes.mady.by.user Sathwik A Bangera

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Table of content

  1. Overview
  2. Technology Stack
  3. Project Structure
  4. Authentication Mechanism
  5. GitHub Workflows
  6. Environment Management
  7. How to Add New Collections
  8. How to Execute Tests from GitHub
  9. Reporting System
  10. Security Best Practices

1. Overview1. Overview

Purpose

This project automates API testing using Postman collections, executed through GitHub Actions CI/CD pipelines with the following capabilities:

    • Execute Postman collections automatically
    • Support multiple environments (dev / test / stage)
    • Secure authentication using Azure AD OAuth2
    • Dynamic runtime parameters
    • Automated reporting using Allure Reports
    • Hosting execution reports on GitHub Pages

2. Technology Stack

Repository link: https://github.com/EG-A-S/EGZP-Automation-Testing: Test repo for EGZP PartnerPortal

Component

Technology

API Testing Tool

Postman Collections

Execution Engine

Postman CLI & Newman

CI/CD Platform

GitHub Actions

Authentication

Azure AD Client Credentials

Reporting

Allure Reports

Environment Config

Postman Environment JSON

Scripting

Shell scripts (Bash)

...

  • Cloud-based collection execution
  • Secure Azure AD authentication
  • Dynamic input support
  • Ideal for quick on-demand runs

When to Use

  • For ad-hoc sanity test executions
  • For debugging specific collections

...

8. How to Execute Tests from GitHub

Steps:

  1. Go to GitHub Repository
  2. Open "Actions" tab
  3. Choose workflow (a or b): 

      ...

        1. Run Workorder Collections with ID

        OR 

      ...

        1. Run Workorder Collections with JSON File
      2. Click "Run Workflow"
        Image Added
      3. Provide required inputs
      4. View execution logs and report

      9. Reporting System

      9.1 Tool Used

      • Allure Reports

      9.2 What It Provides

      • Pass/Fail dashboard
      • API request logs
      • Execution history
      • Shareable HTML reports

      9.3 Hosting

      Reports are automatically published to: https://eg-a-s.github.io/EGZP-Automation-Testing/

      10. Security Best Practices

      • No tokens stored in code
      • All credentials in GitHub Secrets
      • Azure AD token generated per run
      • Short-lived bearer tokens
      • No sensitive data in environment files

      ...