Quick Start Idelium JSON Import

Quick Start Idelium JSON Import

This guide explains how to import the native Idelium JSON example that tests the public demo page at https://idelium.org/demo/.

The JSON import is the recommended way to load reviewed, source-controlled Idelium tests into a project. It creates the test and its reusable steps from a single file, so the imported scenario can be added to a test cycle and executed from the CLI.

Before you begin

Start the demo stack with Start IAS:

cd idelium-docker
./quickstart-demo.sh

Then open https://localhost and sign in with the local demo administrator:

Email: admin@idelium.org
Password: admin

Install Idelium CLI on the workstation that will execute the test:

python3 -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip
python -m pip install idelium

Download the import file

Use the ready-made example stored in the Docker repository:

https://raw.githubusercontent.com/idelium/idelium-docker/main/docs/examples/idelium-demo-test-import.json

If you already have the repository checked out locally, the file is available at:

idelium-docker/docs/examples/idelium-demo-test-import.json

What the JSON imports

The example creates an Idelium test named:

Idelium demo full component coverage

It opens:

https://idelium.org/demo/

and validates the main component families exposed by the demo page, including:

• page loading and hero content;
• logo and console summary visibility;
• form inputs, range controls, textarea, and validation messages;
• table sorting and status rows;
• iframe handling;
• modal/dialog interactions;
• dynamic UI state and reset flows.

The imported steps use stable data-testid selectors where available, making the example suitable for repeatable local checks and CI-oriented demonstrations.

Import the test in Idelium Web

1. Open Projects and select the target project.
2. Open Tests.
3. Select the Import Idelium JSON tab.
4. Upload idelium-demo-test-import.json.
5. Review the generated action list.
6. Click Import Test.
7. Confirm that the imported test appears in the Tests list.

After import, each reusable step can be inspected from Steps and each test composition can be reviewed from Tests.

Create a test cycle

1. Open Test Cycles.
2. Select Create Test Cycle.
3. Drag the imported test from the available tests column to the selected tests column.
4. Reorder selected tests with drag and drop when more than one test is selected.
5. Save the cycle and note the test cycle identifier.

Configure the CLI key

Download the API key from API Key in Idelium Web and store it in the protected CLI key file:

install -m 600 /dev/null ~/.idelium

Copy the key into ~/.idelium using a secure editor or secret-management tool. Do not print API keys or pass them directly in shell history.

Run the imported cycle

Use the project and cycle identifiers from your local Idelium instance:

idelium \
  --idProject=<project-id> \
  --idCycle=<cycle-id> \
  --environment=demo \
  --ideliumwsBaseurl=https://localhost

For the local demo certificate, either trust the generated certificate in your workstation trust store or run the CLI with the explicit development-only flag:

idelium \
  --idProject=<project-id> \
  --idCycle=<cycle-id> \
  --environment=demo \
  --ideliumwsBaseurl=https://localhost \
  --insecure

--insecure disables TLS verification and must only be used for local demo environments.

Review the results

Open Test Performed from Idelium Web.

Use the execution workspace to inspect:

• the selected test cycle;
• each performed run;
• every executed test;
• step-by-step pass/fail status;
• execution duration and diagnostic messages;
• screenshots and structured Postman details when the test contains API steps.

If a step fails, the CLI marks the performed cycle as failed and stores the step-level diagnostic so the run does not remain pending.

Import format summary

The native Idelium JSON format uses this structure:

{
  "schema": "idelium.test-import.v1",
  "name": "Idelium demo full component coverage",
  "description": "Open https://idelium.org/demo/ and exercise the demo page.",
  "steps": [
    {
      "name": "Open Idelium demo page",
      "failedExit": true,
      "attachScreenshot": true,
      "steps": [
        {
          "stepType": "open_browser",
          "url": "https://idelium.org/demo/",
          "xpath": "//*",
          "note": "Open the Idelium demo page"
        }
      ]
    }
  ]
}

The top-level steps array defines reusable Idelium steps. Each reusable step contains executable actions in its nested steps array.