This is an automated email from the ASF dual-hosted git repository.
tiagobento pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-kie-tools.git
The following commit(s) were added to refs/heads/main by this push:
new 952938f2c34 NO-ISSUE: Make sure README.md files are updated on Test
Scenario-related packages (#2953)
952938f2c34 is described below
commit 952938f2c3499de5120d4105b9c6941f2b51834f
Author: Yeser Amer <[email protected]>
AuthorDate: Tue Mar 4 00:32:15 2025 +0100
NO-ISSUE: Make sure README.md files are updated on Test Scenario-related
packages (#2953)
Co-authored-by: Tiago Bento <[email protected]>
Co-authored-by: Thiago Lugli <[email protected]>
---
packages/scesim-editor-envelope/README.md | 5 ++
packages/scesim-editor/README.md | 98 ++++++++++++++++++++++++-------
packages/scesim-marshaller/README.md | 29 ++++++++-
3 files changed, 109 insertions(+), 23 deletions(-)
diff --git a/packages/scesim-editor-envelope/README.md
b/packages/scesim-editor-envelope/README.md
index 64a8f8018c0..78f47711842 100644
--- a/packages/scesim-editor-envelope/README.md
+++ b/packages/scesim-editor-envelope/README.md
@@ -19,6 +19,11 @@
Package responsible for creating the necessary pumbling for `scesim-editor` to
be used inside an Envelope.
+## How to build it
+
+Like most of the projects of this repository, pnpm and NodeJS are mandatory to
build the project. Please refer to the
+repository main README file to know more about the requested versions and
installation steps.
+
---
Apache KIE (incubating) is an effort undergoing incubation at The Apache
Software
diff --git a/packages/scesim-editor/README.md b/packages/scesim-editor/README.md
index eedff691504..b9ab02ab716 100644
--- a/packages/scesim-editor/README.md
+++ b/packages/scesim-editor/README.md
@@ -17,36 +17,57 @@
# Test Scenario Editor
-This module will host the next generation of Test Scenario Editor (\*.scesim)
files.
-The implementation is currently in PROGRESS, therefore we don't recommend any
usage at the current time.
-
-this README will be updated accordingly to its status.
+This module hosts the Test Scenario Editor
+The scope of this editor is to create, view and edit (\*.scesim) files.
+Test Scenario is a technology that enables Apache KIE users who rely on the
Decision Engine or the Rule Engine to
+test their business logic defined in DMN or DRL files easily and efficiently.
+
+The Test Scenario Editor still doesn't fully support the DRL test case, the
following table clarifies which feature are currently supported:
+
+| x | DRL | DMN |
+| ---------- | ----------- | --- |
+| **Create** | NO | YES |
+| **View** | YES | YES |
+| **Edit** | PARTIALLY\* | YES |
+
+> \* **NOTE** At this time, DRL-based Test Scenario file can be opened and
partially edited, but not created.
+
+The editor is based on the following technology stack:
+
+- [Typescript](https://www.typescriptlang.org/)
+- [React.js](https://react.dev/)
+- [Patternfly](https://www.patternfly.org/)
+- [Zustand](https://zustand-demo.pmnd.rs/) +
[Immer](https://immerjs.github.io/immer/) frameworks to manage the editor's
state
+
+# Project Structure
+
+Below, a brief description of the project's structure:
+
+| Directory | Description
|
+| -------------------- |
----------------------------------------------------------------------------------------------------
|
+| `src` | Source root code. It contains the entrrypoint
´TestScenarioEditor` component. |
+| `src/creation` | It contains the Test Scenario components used to
create a new scesim file (i.e an empty scesim file) |
+| `src/drawer` | It contains the Test Scenario components used in the
right Drawer component of the editor |
+| `src/externalModels` | It contains resources (Context) to manage external
modules (DMN files) |
+| `src/hook` | It contains custom hooks required for this module
|
+| `src/i18n` | It contains the editor's internationalization
resources |
+| `src/mutations` | It contains a set of functions that mutate the
editor's state |
+| `src/resources` | It contains a set of resources (e.g empty scesim
file) |
+| `src/sidebar` | It contains the Test Scenario's left sidebar
component, which acts as the editor menu |
+| `src/store` | It contains the Test Scenario Zunstand + Immer state
and related resources. |
+| `src/store` | It contains the Test Scenario's table component,
inherited by the `boxed-expression-component` |
+| `stories` | It contains the Storybook's stories and the Dev
WebApp showcase |
+| `test-e2e` | It contains the Playwright integration tests
|
## How to build it
Like most of the projects of this repository, pnpm and NodeJS are mandatory to
build the project. Please refer to the
-repository main README file to know more about the requested versions and
installation steps. During the first project build,
-don't forget to bootstrap the project by launching ONE of the following:
-
-- `pnpm bootstrap`
-- `pnpm bootstrap -F @kie-tools/scesim-editor...` if you are interested to
bootstrap this module only.
-
-It's recommended to run a `pnpm bootstrap` every time a change in any direct
or indirect modules' `packages.json` is applied.
-
-To build the project type in your terminal ONE of the below commands:
-
-- `pnpm -F @kie-tools/scesim-editor... build:dev` This is fast, but not as
strict. It skips tests, linters, and some type checks. Recommended for dev
purposes.
-- `pnpm -F @kie-tools/scesim-editor... build:prod` The default command to
build production-ready packages. This is the recommended build for production
purposes
-
-The above command will build `scesim-editor` module AND its direct and
indirect dependencies modules.
-To build the `scesim-editor` module ONLY, you can use ONE of the below
commands:
-
-- `pnpm -F @kie-tools/scesim-editor build:dev` This is fast, but not as
strict. It skips tests, linters, and some type checks. Recommended for dev
purposes.
-- `pnpm -F @kie-tools/scesim-editor build:prod` The default command to build
production-ready packages. This is the recommended build for production purposes
+repository main README file to know more about the requested versions and
installation steps.
## How to launch the Test Scenario Storybook Dev WebApp
After building the project, you can benefit of the Storybook Dev Webapp for
development or testing scope.
+The DevApp code lives in the `stories` directory.
To launch it, simply type in your terminal the following command:
`pnpm -F @kie-tools/scesim-editor start`
@@ -55,6 +76,39 @@ A web server with a Dev Webapp of Test Scenario editor will
be launched, reachab
http://localhost:9902/ or http://172.20.10.3:9902/
+## How to test it
+
+This module relies on [Playwright](https://playwright.dev/) test framework to
perform integration tests.
+The tests live in the `test-e2e` directory.
+
+> **OS different than Ubuntu 22.04**
+>
+> The current test cases in place are targeting Ubuntu 22.04 OS only. To run
the tests in a different OS, a preliminary
+> step is required. This step requires the creation of a containerized Ubuntu
OS environment in which the tests will be performed.
+> To create the container, run the following command:
+>
+> `KIE_TOOLS_BUILD__buildContainerImages=true pnpm -F
@kie-tools/playwright-base image:docker:build`
+>
+> To have more information about this step, please refer to the
[playwrite-base](https://github.com/apache/incubator-kie-tools/tree/main/packages/playwright-base)
module.
+
+To run the tests, run this command in your terminal:
+
+`KIE_TOOLS_BUILD__runEndToEndTests=true pnpm -F @kie-tools/scesim-editor
test-e2e`
+
+In case of any test failure, Playwright will create a useful report with
screenshots and videos attached, worthwhile to investigate unexpected behavior.
To view the Playright report, run the following command:
+
+`pnpm -F @kie-tools/scesim-editor test-e2e:open`
+
+If you need to update the Playright tests' screenshots after your code
changes, the following commands are required:
+
+`pnpm -F @kie-tools/scesim-editor test-e2e:container:shell`
+
+`pnpm -F @kie-tools/scesim-editor test-e2e:run -u`
+
+To improve performance, you can filter which tests will run by adding the -g
flag:
+
+`pnpm -F @kie-tools/scesim-editor test-e2e:run -u -g "test name"`
+
---
Apache KIE (incubating) is an effort undergoing incubation at The Apache
Software
diff --git a/packages/scesim-marshaller/README.md
b/packages/scesim-marshaller/README.md
index bd816da6d9e..680d8245087 100644
--- a/packages/scesim-marshaller/README.md
+++ b/packages/scesim-marshaller/README.md
@@ -15,7 +15,34 @@
under the License.
-->
-## @kie-tools/scesim-marshaller
+## Test Scenario Marshaller
+
+This module contains all the resources required to perform the marshalling and
+unmarshalling operations agains a Test Scenario file (.scesim)
+
+It supports scesim files with 1.8 version only.
+
+# Project Structure
+
+Below, a brief description of the project's structure:
+
+| Directory | Description
|
+| ------------------------ |
------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
|
+| `src` | Source root code. It cointans the index.ts file
which offers the Marshalling/Unmarshalling API
|
+| `src/schemas/scesim-1_8` | It contains the Test Scenario 1.8 XSD Schema.
After a build, this directory will contain the autogenerated code which
cointans TypeScript types and metadata from XSD file(s) to be consumed (please
refer to `@kie-tools/xml-parser-ts` module) |
+| `test` | It contains integration tests to run against a
set of scesim files
|
+| `test-data--manual` | The scesim files used for the integration tests.
|
+
+## How to build it
+
+Like most of the projects of this repository, pnpm and NodeJS are mandatory to
build the project. Please refer to the
+repository main README file to know more about the requested versions and
installation steps.
+
+## How to test it
+
+To run the tests, run this command in your terminal:
+
+`KIE_TOOLS_BUILD__runEndToEndTests=true pnpm -F @kie-tools/scesim-marshaller
test`
---
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
