friday-cli 0.1.5

AI-powered test case generator CLI

FRIDAY - AI Test Case Generator

A Python-based tool that uses Google's Vertex AI and LangChain to automatically generate test cases from Jira/Github and Confluence documentation.

Features

• 🤖 Leverages Google Vertex AI for test case generation
• 📝 Pulls requirements from Jira tickets or github issue
• 📚 Extracts additional context from Confluence pages
• 🔄 Uses LangChain for prompt engineering and chain management
• 💾 Use ChromaDb for Embeddings, vector search, document storage
• { } Outputs structured test cases in JSON/MarkDown format

Prerequisites

• Python 3.13+
• Google Cloud Platform account with Vertex AI enabled
• Jira and Confluence access credentials

Sequence diagram

Installation

1. Clone the repository:

git clone https://github.com/dipjyotimetia/friday.git
cd friday

2. Install dependencies:

chmod +x prerequisites.sh
./prerequisites.sh
poetry install

3. Configure environment variables:

cp .env.example .env
# Edit .env with your credentials

Usage

Run the tool with:

# Install the package
poetry install

# Run interactive setup
friday setup

# Generate test cases from a Jira issue
friday generate --jira-key PROJ-123 --confluence-id 12345 -o test_cases.md

# Generate test cases from a GitHub issue 
friday generate --gh-issue 456 --gh-repo owner/repo --confluence-id 12345 -o test_cases.md

# Crawl multiple pages from same domain
friday crawl https://example.com --provider vertex --persist-dir ./my_data/chroma --max-pages 5

# # Crawl across different domains
friday crawl https://example.com --provider vertex --persist-dir ./my_data/chroma --max-pages 10 --same-domain false

# Show version
friday version

# Show help
friday --help
friday generate --help

Parameters

• --jira-key: Jira issue key (required)
• --confluence-id: Confluence page ID (optional)
• --gh-issue: Github Issue key
• --gh-repo: Github User/Repo
• --output: Output file path for generated test cases (default: test_cases.json)

Example other repo

- uses: dipjyotimetia/friday@v1
  with:
    github_token: ${{ secrets.GITHUB_TOKEN }}
    confluence_id: "optional-confluence-id" 

Development

Run tests:

poetry run pytest tests/ -v

Format Code:

poetry run ruff format

MIT License

Copyright (c) 2025 Dipjyoti Metia

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.