thereportstack 1.0.2__py3-none-any.whl

thereportstack/api.py

@@ -0,0 +1,258 @@
+import json
+import os
+import re
+import sys
+
+import requests
+
+DEFAULTS = {
+    "typeOfReport": "pytest",
+    "testEnv": "Not Given",
+    "testType": "Not Given",
+    "tags": [],
+    "browser": "Not Given",
+    "browserVersion": "Not Given",
+    "iterationId": "Batch1",
+    "baseUrl": "http://localhost:4000/api/v1/public",
+}
+
+
+def normalize_tags(tags):
+    """
+    Supports:
+    ["smoke"]
+    ["smoke,regression"]
+    ["@smoke and @wallet"]
+    ["@smoke or @wallet"]
+    """
+    if not tags:
+        return []
+
+    normalized = []
+
+    for raw in tags:
+        raw = str(raw).lower()
+        raw = raw.replace("(", "").replace(")", "")
+        raw = re.sub(r"\s+(and|or)\s+", ",", raw)
+
+        parts = re.split(r"[,\s]+", raw)
+
+        for part in parts:
+            part = part.strip()
+
+            if not part:
+                continue
+
+            if part.startswith("@"):
+                part = part[1:]
+
+            normalized.append(part)
+
+    # remove duplicates while keeping order
+    seen = set()
+    result = []
+
+    for item in normalized:
+        if item not in seen:
+            seen.add(item)
+            result.append(item)
+
+    return result
+
+
+def get_auth_token(config):
+    # 1. token from config.json
+    token = config.get("token")
+    if token:
+        return token
+
+    # 2. token from env variable
+    env_token = os.getenv("DASHBOARD_TOKEN")
+    if env_token:
+        return env_token
+
+    # 3. optional login using email/password if you want later
+    email = config.get("email")
+    password = config.get("password")
+
+    if email and password:
+        base_url = config.get("baseUrl", DEFAULTS["baseUrl"])
+        login_url = f"{base_url}/auth/login"
+
+        response = requests.post(
+            login_url,
+            json={
+                "email": email,
+                "password": password,
+            },
+            timeout=20,
+        )
+
+        response.raise_for_status()
+
+        data = response.json()
+
+        if "token" not in data:
+            raise RuntimeError("Login API did not return token")
+
+        return data["token"]
+
+    raise RuntimeError(
+        "No token found. Add 'token' in config.json or set DASHBOARD_TOKEN"
+    )
+
+
+def get_endpoint(base_url, report_type, project_id):
+    mapping = {
+        "pytest": f"{base_url}/iterations/pyTest/{project_id}",
+        "cucumber": f"{base_url}/iterations/cucumber/{project_id}",
+        "newman": f"{base_url}/iterations/newman/{project_id}",
+        "normal": f"{base_url}/iterations/{project_id}",
+    }
+
+    if report_type not in mapping:
+        raise ValueError(
+            f"Invalid typeOfReport '{report_type}'. "
+            f"Allowed: {', '.join(mapping.keys())}"
+        )
+
+    return mapping[report_type]
+
+
+def publish_report(config):
+    """
+    Called from:
+        thereportstack start
+    Reads all values from thereportstack/config.json
+    """
+
+    report_type = config.get("typeOfReport", DEFAULTS["typeOfReport"])
+    test_env = config.get("testEnv", DEFAULTS["testEnv"])
+    test_type = config.get("testType", DEFAULTS["testType"])
+    browser = config.get("browser", DEFAULTS["browser"])
+    browser_version = config.get("browserVersion", DEFAULTS["browserVersion"])
+    iteration_id = config.get("iterationId", DEFAULTS["iterationId"])
+    tags = normalize_tags(config.get("tags", DEFAULTS["tags"]))
+
+    project_id = config.get("projectId")
+    report_file = config.get("file")
+    base_url = config.get("baseUrl", DEFAULTS["baseUrl"])
+
+    if not project_id:
+        raise RuntimeError("Missing 'projectId' in config.json")
+
+    if not report_file:
+        raise RuntimeError("Missing 'file' in config.json")
+
+    if not os.path.exists(report_file):
+        raise RuntimeError(f"Report file not found: {report_file}")
+
+    file_size_mb = os.path.getsize(report_file) / (1024 * 1024)
+    is_large_file = file_size_mb > 32
+
+    token = get_auth_token(config)
+    endpoint = get_endpoint(base_url, report_type, project_id)
+
+    payload = {
+        "iterationId": iteration_id,
+        "testType": test_type,
+        "testEnvironment": test_env,
+        "browserUsed": browser,
+        "browserVersion": browser_version,
+    }
+
+    # Add tags based on upload method
+    if is_large_file:
+        payload["tags"] = tags
+    else:
+        payload["tags[]"] = tags
+
+    headers = {
+        "Authorization": f"Bearer {token}",
+    }
+
+    print("\nPublishing report...")
+    print(f"Type: {report_type}")
+    print(f"Project: {project_id}")
+    print(f"File: {report_file}")
+    print(f"Endpoint: {endpoint}")
+
+    if is_large_file:
+        print(f"\nLarge file detected ({file_size_mb:.2f}MB). Using Secure Large File Upload...")
+        
+        print("  - Step 1: Getting secure upload link...")
+        init_url = f"{base_url}/iterations/upload/init"
+        init_resp = requests.post(
+            init_url, 
+            json={"fileName": os.path.basename(report_file), "projectId": project_id}, 
+            headers=headers, 
+            timeout=30
+        )
+        
+        if init_resp.status_code >= 300:
+            print("\nFailed to initialize large file upload")
+            print(f"Status Code: {init_resp.status_code}")
+            print(init_resp.text)
+            sys.exit(1)
+            
+        init_data = init_resp.json()
+        upload_url = init_data.get("uploadUrl")
+        file_path_cloud = init_data.get("filePath")
+        
+        if not upload_url or not file_path_cloud:
+            print("\nInvalid response from upload initialization (missing uploadUrl or filePath)")
+            sys.exit(1)
+            
+        print("  - Step 2: Uploading file to cloud storage (this might take a while)...")
+        with open(report_file, "rb") as f:
+            put_resp = requests.put(upload_url, data=f, headers={"Content-Type": "application/json"}, timeout=600)
+            
+        if put_resp.status_code >= 300:
+            print("\nFailed to upload file to cloud storage")
+            print(f"Status Code: {put_resp.status_code}")
+            print(put_resp.text)
+            sys.exit(1)
+            
+        print("  - Step 3: Instructing server to process report...")
+        payload["uploadType"] = "cloud-storage"
+        payload["filePath"] = file_path_cloud
+        
+        print("Payload:")
+        print(json.dumps(payload, indent=2))
+        
+        response = requests.post(
+            endpoint,
+            headers=headers,
+            json=payload,
+            timeout=120,
+        )
+        
+    else:
+        print("Payload:")
+        print(json.dumps(payload, indent=2))
+        
+        with open(report_file, "rb") as report:
+            files = {
+                "files": (
+                    os.path.basename(report_file),
+                    report,
+                    "application/json",
+                )
+            }
+            
+            response = requests.post(
+                endpoint,
+                headers=headers,
+                data=payload,
+                files=files,
+                timeout=60,
+            )
+
+    if response.status_code >= 300:
+        print("\n Upload failed")
+        print(f"Status Code: {response.status_code}")
+        print(response.text)
+        sys.exit(1)
+
+    print("\nReport uploaded successfully")
+    print(response.text)

thereportstack/cli.py

@@ -0,0 +1,62 @@
+# src/thereportstack/cli.py
+
+import argparse
+from .config import ensure_config_exists, load_config
+from .api import publish_report
+
+
+def main():
+    parser = argparse.ArgumentParser(prog="thereportstack")
+    subparsers = parser.add_subparsers(dest="command")
+
+    init_parser = subparsers.add_parser(
+        "init",
+        help="Create or update config.json"
+    )
+
+    init_parser.add_argument("--typeOfReport")
+    init_parser.add_argument("--projectId")
+    init_parser.add_argument("--file")
+    init_parser.add_argument("--testEnv")
+    init_parser.add_argument("--testType")
+    init_parser.add_argument("--tags", nargs="*")
+    init_parser.add_argument("--browser")
+    init_parser.add_argument("--browserVersion")
+    init_parser.add_argument("--iterationId")
+    init_parser.add_argument("--token")
+    init_parser.add_argument("--email")
+    init_parser.add_argument("--password")
+    init_parser.add_argument("--baseUrl")
+
+    subparsers.add_parser(
+        "start",
+        help="Start automation using config.json"
+    )
+
+    args = parser.parse_args()
+
+    if args.command == "init":
+        config_file = ensure_config_exists(
+            typeOfReport=args.typeOfReport,
+            projectId=args.projectId,
+            file=args.file,
+            testEnv=args.testEnv,
+            testType=args.testType,
+            tags=args.tags,
+            browser=args.browser,
+            browserVersion=args.browserVersion,
+            iterationId=args.iterationId,
+            token=args.token,
+            email=args.email,
+            password=args.password,
+            baseUrl=args.baseUrl,
+        )
+
+        print(f"Config updated: {config_file}")
+
+    elif args.command == "start":
+        config = load_config()
+        publish_report(config)
+
+    else:
+        parser.print_help()

thereportstack/config.py

@@ -0,0 +1,39 @@
+# src/thereportstack/config.py
+
+from pathlib import Path
+import json
+import importlib.resources as resources
+
+APP_DIR = Path.cwd() / "thereportstack"
+CONFIG_FILE = APP_DIR / "config.json"
+
+
+def ensure_config_exists(**kwargs):
+    APP_DIR.mkdir(exist_ok=True)
+
+    if CONFIG_FILE.exists():
+        with open(CONFIG_FILE, "r", encoding="utf-8") as f:
+            config = json.load(f)
+    else:
+        with resources.files("thereportstack").joinpath(
+            "default_config.json"
+        ).open("r", encoding="utf-8") as f:
+            config = json.load(f)
+
+    # Update only fields provided by user
+    for key, value in kwargs.items():
+        if value is not None:
+            config[key] = value
+
+    with open(CONFIG_FILE, "w", encoding="utf-8") as f:
+        json.dump(config, f, indent=2)
+
+    return CONFIG_FILE
+
+
+def load_config():
+    if not CONFIG_FILE.exists():
+        ensure_config_exists()
+
+    with open(CONFIG_FILE, "r", encoding="utf-8") as f:
+        return json.load(f)

thereportstack/default_config.json

@@ -0,0 +1,15 @@
+{
+  "typeOfReport": "pytest",
+  "projectId": "extract the projectId from TheReportStack team",
+  "file": "Path of json file",
+  "testEnv": "",
+  "testType": "",
+  "tags": ["smoke"],
+  "browser": "",
+  "browserVersion": "",
+  "iterationId": "any unique string if you like to give",
+  "token": "",
+  "email": "",
+  "password": "",
+  "baseUrl": "https://app.thereportstack.com/api/v1/public"
+}

thereportstack-1.0.2.dist-info/METADATA

@@ -0,0 +1,107 @@
+Metadata-Version: 2.4
+Name: thereportstack
+Version: 1.0.2
+Summary: Automation dashboard report uploader
+Author-email: Your Name <you@example.com>
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.31.0
+
+# TheReportStack CLI
+<br>
+
+<p align="center">
+  <b>A powerful CLI and Python package to seamlessly upload your automated test execution reports to the TheReportStack Dashboard.</b>
+</p>
+
+---
+
+## ⚡ Features
+
+- **Upload Instantly:** Upload PyTest, Cucumber, and Newman JSON reports directly to your TheReportStack Dashboard project.
+- **Smart Tags:** Supports parsing complex tag expressions (e.g. `["@smoke and @wallet"]`).
+- **Flexible Authentication:** Authenticate via project tokens, Environment Variables, or email & password.
+- **Zero Coding Required:** Configure once with a simple json file and trigger from anywhere in your CI/CD pipelines.
+
+## 📦 Installation
+
+Install the package via `pip`:
+
+```bash
+pip install thereportstack
+```
+
+## 🚀 Quick Start
+
+### 1. Initialize Configuration
+Navigate to your project directory and run the initialization command. This creates the configuration structure.
+
+```bash
+thereportstack init
+```
+This generates a `thereportstack/config.json` file in your current directory with default values.
+
+You can also configure the project directly from the command line by passing arguments. This will instantly populate or update the `config.json` file:
+```bash
+thereportstack init --projectId YOUR_PROJECT_ID --tags "smoke" "regression" --typeOfReport pytest
+```
+### 2. Configure Your Project
+Edit the generated `thereportstack/config.json` with your project's specifics.
+
+```json
+{
+  "typeOfReport": "pytest",
+  "projectId": "YOUR_PROJECT_ID",
+  "file": "path/to/report.json",
+  "testEnv": "QA",
+  "testType": "WEB",
+  "tags": ["smoke", "regression"],
+  "browser": "chrome",
+  "browserVersion": "latest",
+  "iterationId": "Batch1",
+  "baseUrl": "https://app.thereportstack.com/api/v1/public"
+}
+```
+
+*Don't want to expose your token in code?* Remove the `"token"` field from the config and export it as an environment variable in your CI/CD tool:
+```bash
+export DASHBOARD_TOKEN="YOUR_API_TOKEN"
+```
+
+### 3. Upload Report
+Once your config is set and your testing framework has generated the JSON report, run:
+
+```bash
+thereportstack start
+```
+
+That's it! 🚀 Your test execution report is now beautifully cataloged on the TheReportStack Dashboard.
+
+## 🔧 Configuration Reference
+
+| Parameter        | Description                                                                                     | Default Value          |
+|------------------|-------------------------------------------------------------------------------------------------|------------------------|
+| `typeOfReport`   | The framework generating the report (`pytest`, `cucumber`, `newman`, `normal`)                  | `pytest`               |
+| `projectId`      | Your unique project ID from the TheReportStack dashboard                                        | `""`                   |
+| `file`           | Relative or absolute path to the generated JSON test report                                     | `report.json`          |
+| `testEnv`        | Environment where the test triggered (`QA`, `Staging`, `Prod`, etc.)                            | `QA`                   |
+| `testType`       | Type of Testing (`WEB`, `API`, `MOBILE`)                                                        | `WEB`                  |
+| `tags`           | Array of strings representing your test suites/scenario tags (`["smoke", "regression"]`)        | `["smoke"]`            |
+| `browser`        | Name of the executed browser (`chrome`, `firefox`, `safari`, `edge`)                            | `chrome`               |
+| `browserVersion` | Version of the browser                             | `latest`               |
+| `token`          | Personal access token. Overridden by the `DASHBOARD_TOKEN` environment variable if present.     | `""`                   |
+
+## 🔑 Authentication Methods
+TheReportStack gives you several options for secure authentication:
+1. **Config Token**: Place `"token": "YOUR_TOKEN"` directly in the `config.json`.
+2. **Environment Variable**: Export `DASHBOARD_TOKEN` on your machine or CI/CD runner.
+3. **Email & Password**: You can provide `"email"` and `"password"` fields in `config.json` and the CLI will automatically securely negotiate an authentication token. (Token/Environment Token takes precedent).
+
+## ✨ Tag Parsing Support
+To make QA tagging flexible, `thereportstack` CLI automatically normalizes boolean-style or nested BDD tags coming from your project definitions before sending them to the dashboard:
+- `["@smoke and @wallet"]`   ➡️  `["smoke", "wallet"]`
+- `["smoke, regression"]`    ➡️  `["smoke", "regression"]`
+- `["(checkout)"]`           ➡️  `["checkout"]`
+
+## 🤝 Support
+If you encounter any issues integrating this into your Python, Node, Java, or Ruby pipelines, please reach out directly to the TheReportStack maintainers.

thereportstack-1.0.2.dist-info/RECORD

@@ -0,0 +1,10 @@
+thereportstack/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+thereportstack/api.py,sha256=Ai4zEP0PCbApxXkJLqs1XM_6cTQ96eriZXyVRzKBLdo,7248
+thereportstack/cli.py,sha256=pR4UFOSa5V3k9Vp4Apqm1mDVkmT_SWHF2n_RV6mW45Y,1801
+thereportstack/config.py,sha256=cZEjDj2748MW2r6WgUw_tBheNbTJbncuqE3UGOYcovQ,994
+thereportstack/default_config.json,sha256=N5OMboXEfIR7xQvMXfNco_VJqj_iNBIFg-EuTvzhbCI,391
+thereportstack-1.0.2.dist-info/METADATA,sha256=ryxPczxEIvhuYyUIv5itUeWIAHMF4Zh8FIIa_a4j-h8,5041
+thereportstack-1.0.2.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
+thereportstack-1.0.2.dist-info/entry_points.txt,sha256=G_YwucqV_1AjdOrSVZfB08HJzCQlgfnb5WS2zRNBoRA,59
+thereportstack-1.0.2.dist-info/top_level.txt,sha256=laVLe1Tkt4P2WYW8JMJfc5p5Ok-dwBlYEQ4be3fNCWY,15
+thereportstack-1.0.2.dist-info/RECORD,,

thereportstack-1.0.2.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (83.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

thereportstack-1.0.2.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+thereportstack = thereportstack.cli:main

thereportstack-1.0.2.dist-info/top_level.txt

@@ -0,0 +1 @@
+thereportstack