Skip to content

feat: Automatically open Microcks Dashboard in the browser for better DX #423

@Manar-Elhabbal7

Description

@Manar-Elhabbal7

Reason/Context

Currently, when a developer starts Microcks or runs a test, they have to manually click the URL in the console to open the browser. This adds friction to the development loop. It makes the CLI feel more modern and integrated
with the developer's workstation

Description

This enhancement introduces a mechanism to automatically launch the system's default web browser when the CLI
outputs a link to the Microcks UI.

Changes to be introduced:

    1. Centralized Browser Utility: A new package pkg/util to handle cross-platform browser launching with safety
      checks.
    1. Environment Awareness: The CLI will detect if it is running in a headless environment (CI/CD) or if the user
      has globally disabled browser launching via environment variables (MICROCKS_NO_BROWSER).
    1. Command Updates:
      • microcks start will open the main dashboard.
      • microcks test will open the specific Test Result page.
    1. User Control: A new flag --launch-browser (defaulting to true) will be added to relevant commands to allow
      manual overrides.

Implementation ideas

  • Use the github.com/skratchdot/open-golang/open library (already present in the project) for cross-platform
    support.
    • Implement a LaunchBrowser(url string, enabled bool) function that checks for os.Getenv("CI") before attempting
      to open the browser.
    • Split the work into three logical PRs:
      1. Core utility + microcks start integration.
      2. microcks test integration for direct Test Result links.
      3. Refactor existing login --sso logic and add permanent configuration settings in config.yaml.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions