#BE-6910 Testing Setup (#72)

* Add testing setup

* Refactor vitest config, add new test files: AppcircleExitError, ProgramError and writer.

* feat(test): setup vitest and refactor for testability

* test(services): add unit tests for services layer

* test(core): add unit tests for core modules

* test(main): add unit tests for main and program logic

* test: add remaining unit tests and directory structure

* Add unit tests for constants, security, types, and utility functions

* test(main): enhance error handling and edge case coverage in main function and program logic

* feat(tests): enhance unit tests for various edge cases and error handling

* test: remove skipped tests for help, version, and JSON output modes in critical commands

* fix(tests): update import paths and type assertions in integration and unit tests

* feat(login): refactor login handling with dedicated helper functions for improved readability and organization

* test(command-runner): add comprehensive tests for login helper functions and error handling

* feat(logout): implement logout helper functions and integrate with command handling

* Add unit tests for user prompt helpers and workflow ID parameter handling

* refactor(command-runner): modularize command handling and enhance parameter validation with utility functions

* refactor(command-runner): integrate utility functions for parameter resolution and validation, enhancing code modularity and readability

* feat(command-runner): add comprehensive utility functions for command processing, validation, and error handling to improve modularity and testability

* chore(vitest): update test exclusion patterns to improve test coverage by excluding specific utility and type files

* refactor(main): extract command processing and error handling logic into utility functions for improved modularity and testability

* refactor(program): extract help generation and error handling into utility functions for improved modularity and readability

* feat(utilities): introduce utility functions for authentication, build management, file operations, and log processing to enhance modularity and testability

* feat(writer): add command-specific writer functions and utility functions for data transformation and logging to enhance modularity and testability

* feat(api): extract utility functions for API configuration, headers, and logging to enhance modularity and testability

* refactor(writer): consolidate command handling by extracting command-specific writer functions to improve modularity and maintainability

* feat(interactive-runner): enhance parameter handling with validation, path expansion, and modular prompt configuration for improved user interaction

* feat(test-setup): add spies for console.info and console.table to enhance logging control during tests

* feat(tests): add comprehensive unit tests for command runner utilities, enhancing coverage and modularity across various functionalities

* fix(test-setup): ensure console methods exist before mocking to prevent errors during tests

* 2.7.5-alpha.0

* 2.7.5-alpha.1

* refactor(tests): update E2E tests to use source TypeScript file and improve command execution handling

* feat(upload): enhance upload process to update release notes with version ID retrieval

* test(release-notes): add unit tests for release notes update feature including long, multiline, and special character handling

* feat(publish): enforce required parameters for enterprise app version publishing and update documentation

* test(enterprise-utilities): enhance tests for enterprise app version publishing with additional parameters and output validation

* 2.7.5-alpha.2

* feat(auth): add token validation before login to handle expired tokens

* test(e2e): enhance authentication command tests for invalid tokens and logout scenarios

* 2.7.5-alpha.3

* feat: add pr workflow into Jenkinsfile

* feat(upload): add enhanced method to retrieve latest app version ID after upload

* feat(prompt): add support for simple multiline input for release notes

* chore(docs): remove deprecated distribution commands and update migration guide links

* 2.7.5-alpha.4

* refactor: change pr validation stage

* feat: get tags before publish

* refactor: add node version check

* test: skip logout command test when not authenticated

* feat: downgrade vite

* Feature/be 6412 (#76) (#75)

* feat(config): add HOOK_HOSTNAME configuration option and update related documentation

* feat(command-runner): introduce build execution modes and user prompt for selecting execution mode during build start

* feat(build-logs): implement real-time build logs feature with enhanced logging, progress tracking, and file output support

* feat: add step summary execution mode and enhance build log processing

* feat: validate PAT token format and improve logout command error handling

* Add new unit tests

* feat: exclude 'src/types/build-logs.ts' from coverage reporting

* Add unit tests for command runner functionalities

* 2.7.5-alpha.5

* feat: skip tests for handling invalid PAT token and user login status

* feat: add execution mode parameter to build command for enhanced monitoring options

* feat: enhance execution mode handling by prompting user in interactive mode

* feat: skip test for handling login with empty token string

* feat: implement execution mode tests and skip specific logout tests in E2E suite

* 2.7.5-alpha.6

* refactor: update downloadBuildLogs function calls to use object destructuring for path parameter

* fix: set default hook hostname to 'https://hook.appcircle.io' if not provided in environment variables

* refactor: update execution mode terminology to 'monitoring preference' for clarity and consistency across documentation and code

* refactor: improve duration formatting logic in command runner for better readability and consistency

* refactor: enhance step management in command runner to prevent duplicate displays and improve status handling

* refactor: rename execution mode to monitor mode and update related documentation and code for improved clarity and consistency

* refactor: update console log messages for build log downloads to improve clarity

* feat: add build status utilities and enhance artifact download error handling

* feat: add verbose mode option to build log rendering for enhanced output control

* refactor: enhance log processing and message handling for verbose mode, including improved deduplication and flushing of buffered messages

* fix: ensure SSE connection is closed before prompting for log download on build failure

* 2.7.5-alpha.7

* refactor: update authentication method from Personal Access Token to Personal Access Key in CLI and documentation

* feat: add legacy PAT login support for backward compatibility and update related tests

* feat: add hidden property to commands and update error message handling in TerminalRenderer

* 2.7.5-alpha.8

* fix: update build monitor and execution mode options to include numbering for improved clarity

* 2.7.5-alpha.9

Co-authored-by: Fuat Guzel <39780609+fuatguzel@users.noreply.github.com>

* refactor: add fancy icons into jenkinsfile (#74)

* refactor: add fancy icons into jenkinsfile

* refactor: add fancy icons into jenkinsfile

* refactor: add fancy icons into jenkinsfile

* refactor: add fancy icons into jenkinsfile

* refactor: add .

---------

Co-authored-by: Ozer <ozer@Ozers-MacBook-Pro.local>
Co-authored-by: Fuat Guzel <fuatguzel754@gmail.com>

* refactor: add numbering to build monitoring preference options for clarity in unit tests

---------

Co-authored-by: Burak Yıldırım <burak_yildirim_official@hotmail.com>
Co-authored-by: Ozer <ozer@Ozers-MacBook-Pro.local>
Co-authored-by: ozeryilm <ozer@appcircle.io>

Author: 4 people

Jenkinsfile

@@ -4,13 +4,55 @@ pipeline {
         NPM_AUTH_TOKEN = credentials('Appcircle-CLI-NPM-Cred')
     }
     stages {
+        stage('PR Validation') {
+            when {
+                changeRequest()
+            }
+            steps {
+                sh '''#!/bin/bash
+                # shellcheck shell=bash
+                set -x
+                set -euo pipefail
+                
+                echo "🔨 Starting PR Validation Pipeline 🔨"
+                echo "=================================="
+                
+                echo "📦 Installing dependencies.. ."
+                yarn install
+                
+                echo "⚙️  Running TypeScript compilation..."
+                if ! npm run build; then
+                    echo "❌ TypeScript compilation failed! 😢"
+                    exit 1
+                fi
+                echo "✅ TypeScript compilation successful! 🎉"
+                
+                echo "🧪 Running unit tests..."
+                if ! npm test; then
+                    echo "❌ Unit tests failed! 💔"
+                    exit 1
+                fi
+                echo "✅ Unit tests passed! 🌟"
+                
+                echo "=================================="
+                echo "🎯 PR validation complete - All checks passed! 🚀"
+                '''
+            }
+        }
 
         stage('Publish') {
+            when {
+                not { changeRequest() }
+            }
             steps {
                 sh '''#!/bin/bash
                 # shellcheck shell=bash
                 set -x
                 set -euo pipefail
+
+                node --version
+                
+                git fetch --tags --force
                 tag=$(git describe --tags --abbrev=0)
                 echo "Tag: ${tag}"
 

README.md

@@ -98,6 +98,8 @@ appcircle <command> <subcommand> ... <subcommand> [options] -o json
 
 - `AUTH_HOSTNAME`: Specifies the host where your IAM (identity access management) server endpoint is located. [See also](#configuring-your-appcircle-cli-environment) for more details.
 
+- `HOOK_HOSTNAME`: Specifies the host where the webhook endpoint is located. [See also](#configuring-your-appcircle-cli-environment) for more details.
+
 ## Interactive Mode
 
 Appcircle CLI incorporates a GUI that allows users to interactively access its features. To view all features in interactive mode, execute the following command:
@@ -153,9 +155,9 @@ CURL_LOGGING= appcircle
 
 You can authenticate with Appcircle using either Personal Access Token or API Key:
 
-#### Using Personal Access Token
-- [Generate a personal access token from the Appcircle dashboard](https://docs.appcircle.io/appcircle-api/api-authentication#generatingmanaging-the-personal-api-tokens)
-- Using the Appcircle CLI, create a full access API token using the following command: `appcircle login pat --token="YOUR PERSONAL ACCESS TOKEN"`.
+#### Using Personal Access Key
+- [Generate a personal access key from the Appcircle dashboard](https://docs.appcircle.io/appcircle-api/api-authentication#generatingmanaging-the-personal-api-tokens)
+- Using the Appcircle CLI, create a full access API token using the following command: `appcircle login personal-access-key --secret="YOUR PERSONAL ACCESS KEY"`.
 
 #### Using API Key
 - [Create an API Key from the Appcircle dashboard](https://docs.appcircle.io/appcircle-api/api-authentication#api-keys)

docs/build/start.md

@@ -32,6 +32,7 @@ appcircle build start [options]
   --download-logs           Automatically download build logs after completion
   --download-artifacts      Automatically download build artifacts after completion
   --path <string>           Download path for logs and artifacts (default: ~/Downloads)
+  --monitor <mode>          Build monitoring preference: none, summary (default), steps, or verbose
 ```
 
 ## Options inherited from parent commands
@@ -75,6 +76,27 @@ appcircle build start --profileId <uuid> --branch "main" --workflowId <uuid>
 - **Optional**: If not provided, uses the first available configuration for the profile
 - **Example**: `--configurationId <uuid>` or `--configuration "Debug Configuration"`
 
+### Monitor Mode Selection
+The `--monitor` parameter controls how the build process is monitored and displayed:
+
+- **`none`**: No monitoring. Just return Task/Build ID and exit immediately
+- **`summary`** (default): Wait until completion, show final status + total duration in one line
+- **`steps`**: Wait until completion, show step-by-step progress (started/finished) minimally
+- **`verbose`**: Wait until completion, stream detailed logs line by line in real-time
+
+**Real-time Log Features:**
+- All monitor modes (except `none`) provide real-time log streaming from the build process
+- Logs are displayed as they are generated, providing immediate feedback on build progress
+- The system automatically handles log formatting and step transitions for better readability
+
+**Backward Compatibility:**
+- The legacy `--execution-mode` parameter is still supported for backward compatibility
+- Legacy modes are automatically mapped to new monitor modes:
+  - `normal` → `summary`
+  - `detailed` → `verbose`
+  - `step-summary` → `steps`
+  - `skip` → `none`
+
 ## Usage Examples
 
 ### Basic Usage
@@ -121,6 +143,21 @@ appcircle build start --profileId <uuid> --commitId <uuid> --workflowId <uuid> -
 appcircle build start --profile "My Android App" --branchId 6ba7b810-9dad-11d1-80b4-00c04fd430c8 --workflow "Default Push Workflow"
 ```
 
+#### 9. Build with Different Execution Modes
+```bash
+# Normal mode (default) - standard monitoring with real-time logs
+appcircle build start --profileId <uuid> --commitId <uuid> --workflowId <uuid>
+
+# Verbose mode - enhanced monitoring with detailed progress tracking
+appcircle build start --profileId <uuid> --commitId <uuid> --workflowId <uuid> --monitor verbose
+
+# Steps mode - clean table showing only steps and durations
+appcircle build start --profileId <uuid> --commitId <uuid> --workflowId <uuid> --monitor steps
+
+# None mode - return task ID immediately without monitoring
+appcircle build start --profileId <uuid> --commitId <uuid> --workflowId <uuid> --monitor none
+```
+
 ## Common Scenarios
 
 ### Scenario 1: Build Latest Commit from Branch
@@ -147,6 +184,15 @@ appcircle build start --profileId <uuid> --commitId <uuid> --workflowId <uuid> -
 appcircle build start --profileId <uuid> --commitId <uuid> --workflowId <uuid> --download-logs --download-artifacts
 ```
 
+### Scenario 5: Real-time Build Monitoring
+```bash
+# For development - watch build progress in real-time with detailed logs
+appcircle build start --profileId <uuid> --commitId <uuid> --workflowId <uuid> --monitor verbose
+
+# For CI/CD - get clean step summary without verbose logs
+appcircle build start --profileId <uuid> --commitId <uuid> --workflowId <uuid> --monitor steps
+```
+
 ## Notes
 
 - **Commit vs Branch**: When you provide `--commitId`, the system doesn't need branch information since the commit is already specified. When you provide `--branchId`, the system automatically uses the latest commit from that branch.
@@ -157,6 +203,12 @@ appcircle build start --profileId <uuid> --commitId <uuid> --workflowId <uuid> -
 
 - **Auto Download**: The `--download-logs` and `--download-artifacts` parameters automatically download files after build completion. Use `--path` to specify a custom download location.
 
+- **Monitoring Preferences**: The `--monitor` parameter allows you to control how build progress is displayed. The default `summary` mode provides real-time build status and duration, while `verbose` mode offers full verbose log streaming, `steps` shows step-by-step progress, and `none` returns only the task ID.
+
+- **Real-time Logs**: All monitor modes (except `none`) provide real-time log streaming, allowing you to monitor build progress as it happens. The system automatically formats logs and handles step transitions for better readability.
+
+- **Backward Compatibility**: The legacy `--execution-mode` parameter is still supported and automatically maps to the new monitor modes for seamless migration.
+
 ## Learn More
 
 - Use `appcircle build profile list` to get available profiles with their UUIDs and names

docs/config/get.md

@@ -10,14 +10,15 @@ appcircle config get <key>
 ```plaintext
 $ appcircle config get API_HOSTNAME
 $ appcircle config get AUTH_HOSTNAME
+$ appcircle config get HOOK_HOSTNAME
 $ appcircle config get AC_ACCESS_TOKEN
 ```
 
 ## Arguments
 
 | Argument                                                                                                                                 | Description                                             |
 | --------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- |
-| `key`                                                                                                        | Config key [API_HOSTNAME, AUTH_HOSTNAME, AC_ACCESS_TOKEN]                                           
+| `key`                                                                                                        | Config key [API_HOSTNAME, AUTH_HOSTNAME, HOOK_HOSTNAME, AC_ACCESS_TOKEN]                                           
 
 ## Options inherited from parent commands
 

docs/config/set.md

@@ -9,13 +9,14 @@ appcircle config set <key> <value>
 
 ```plaintext
 $ appcircle config set AUTH_HOSTNAME https://auth.example.com
+$ appcircle config set HOOK_HOSTNAME https://hook.example.com
 ```
 
 ## Arguments
 
 | Argument                                                                                                                                 | Description                                             |
 | --------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- |
-| `key`                                                                                                        | Config key [API_HOSTNAME, AUTH_HOSTNAME, AC_ACCESS_TOKEN] |
+| `key`                                                                                                        | Config key [API_HOSTNAME, AUTH_HOSTNAME, HOOK_HOSTNAME, AC_ACCESS_TOKEN] |
 `value` |     Config value                                   
 
 ## Options inherited from parent commands