Skip to content

Create a generic "Hello World" install and run path for first-time users #2532

@jadecarino

Description

@jadecarino

Story

As a first time Galasa user, I want to install and run my first "Hello World" Galasa test using a copy/paste set of commands with working defaults in 5-minutes.

Background

The Getting Started guide is too complex for a first-time user, with 6+ pages to click through to get all the way from installing Galasa to running your first test. Additionally the test project that you create containing the Galasa test to run is probably too complex also. There should be a test class called "TestHelloWorld" or similar, that simply logs "Hello World" from a single @Test method.

The current sample test has manager injections, multiple methods and this is too much for a first test. While this example project is useful and we should keep it as a template for those who are ready to write their first tests, for those who are for the first time looking at Galasa, the first test run should be quick, easy, be described on one page with copy/paste commands, and not contain loads of description.

Tasks

  • Create a new Galasa test project template in the CLI code that is created when galasactl project create is invoked that creates a project containing:
    • One Galasa test file called TestHelloWorld that has one test method with a logger statement that says "Hello World"
  • Write a single page doc for galasa.dev that explains how to install Galasa, initialise a local environment, and run the test, all with copy/paste commands and only necessary supporting information.
  • Restructure/repurpose the original Getting Started documentation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    Status

    📋 5 Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions