# Nexus-Console

**Repository Path**: heibachuanqi/Nexus-Console

## Basic Information

- **Project Name**: Nexus-Console
- **Description**: UI-AUTO：专注于UI自动化测试的开源项目，提供高效的测试框架和工具，支持多种平台和语言，助力开发者提升测试效率与质量。
- **Primary Language**: Unknown
- **License**: AGPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2026-10-15
- **Last Updated**: 2026-10-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Nexus-Console

[中文](README.zh-CN.md) | English

**UI automation engine for the Nexus Testing Platform.**

> Nexus-Console is the browser-automation core of the Nexus platform: a Playwright-based, config-driven UI testing engine evolved from the ui-test project.

## Repository and release boundary

The canonical repository name is Nexus-Console. GitHub and Gitee point to the same master branch:

- [GitHub](https://github.com/Abovetheclouds306/Nexus-Console)
- [Gitee](https://gitee.com/YunAbove/Nexus-Console)

The V1.0 framework baseline is complete: reusable browser, session, and data capabilities are separated from business flows, the framework regression is green, and the key UI flows have been verified. Full environment-dependent business-chain acceptance and further wait/assertion hardening are V2.0 work.

## Features

| Feature | Description |
|---|---|
| Page Object architecture | Locator and behavior encapsulation in pages/ |
| Browser automation | Playwright, browser lifecycle, login, and session management |
| Config-driven execution | Environment variables → local config → defaults |
| Dynamic test data | UserFactory, TestContext, and DataFactory in fixtures/ |
| Agent-assisted testing | Docs2tests, fixer, and explorer tools in agent/ and ai_agent/ |
| Explicit UI exploration boundary | `ai_agent/ui_explore.py` requires `UI_EXPLORER_BASE_URL`, rejects remote plaintext HTTP, and waits on observable URL conditions |
| One-click initialization | python scripts/init.py |

## Architecture

    Scenario / pytest entry
            ↓
    Config layer (environment → local yaml → example)
            ↓
    Playwright browser layer + fixture/data layer
            ↓
    Page Object layer (pages/)
            ↓
    Tests → business assertions → report

## Quick Start

    # 1. Clone from either remote
    git clone https://github.com/Abovetheclouds306/Nexus-Console.git
    # git clone https://gitee.com/YunAbove/Nexus-Console.git
    cd Nexus-Console

    # 2. Install browser dependencies
    python -m venv .venv
    # Windows: .venv\Scripts\activate
    pip install -r requirements.txt
    python -m playwright install chromium

    # 3. Initialize local config/config.yaml from the example
    python scripts/init.py

    # 4. Configure credentials and environment
    #    Edit config/config.yaml locally or set UI_TEST_* environment variables.
    #    The Agent UI explorer additionally requires UI_EXPLORER_BASE_URL.

    # 5. Run framework-only checks first
    python -m pytest -c framework-tests.ini

    # 6. Run one real UI flow only when integration is explicitly enabled
    python -m pytest -m integration tests/<module>/test_<feature>_flow.py -q

    # 7. Run UI business smoke tests (requires a reachable environment)
    python -m pytest -m smoke -v

Start with the framework-only profile when changing shared utilities. The default `pytest` command
keeps business UI tests marked `integration` out of the run; supply `-m integration` explicitly
before starting a real browser or writing test-environment data. Review the selected flow and
cleanup policy before running it.

## Project Structure

    Nexus-Console/
    ├── pages/                 # Page Objects: locators and behavior
    ├── tests/                 # pytest UI and flow tests
    ├── fixtures/              # UserFactory, TestContext, and DataFactory
    ├── config/                # local config loader and settings
    ├── utils/                 # browser, DB, log, and flow utilities
    ├── agent/                 # AI agent loop
    ├── ai_agent/              # docs2tests, fixer, and explorer
    ├── auto_test_suite/       # framework-level test assets
    └── scripts/init.py        # local initializer

## Roadmap

- **V2.0 business coverage** — complete the remaining real UI chains, including the approval/suspend combination flow, when environment data and dependencies are available.
- **V2.0 stability** — converge legacy-page bridges, replace remaining fixed waits, strengthen business-state assertions, and improve failure evidence.
- **Optional later work** — additional browser engines and broader parallel execution are not V2.0 mandatory gates.

## Documentation and safety

- [Repository operating rules](AGENTS.md)
- [Documentation and data policy](DOCS_POLICY.md)
- Business-specific documents, screenshots, logs, and generated reports stay in the local workspace according to DOCS_POLICY.md; they are not part of the public clone.
- Never commit .env, config/config.yaml, cached tokens, screenshots, or logs.
- Keep test_data/ and reusable fixtures intact during cleanup.

## License

AGPL-3.0