-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
In README.md, replace ibis-ladybug by just ladybug
- Loading branch information
Martijn Dirkse
committed
Mar 14, 2024
1 parent
57582d0
commit 66af6ba
Showing
1 changed file
with
19 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -34,7 +34,7 @@ See [release notes](RELEASES.md). | |
| Feedback | ||
| ======== | ||
|
|
||
| For bug reports and feature requests create a new issue at <https://github.com/ibissource/ibis-ladybug/issues>. Ladybug | ||
| For bug reports and feature requests create a new issue at <https://github.com/ibissource/ladybug/issues>. Ladybug | ||
| is developed and maintained by [WeAreFrank!](https://wearefrank.nl/). Contact us at <https://wearefrank.nl/en/contact/> | ||
| or send an email to [email protected]. | ||
|
|
||
|
|
@@ -106,7 +106,7 @@ help. | |
|
|
||
| Direct integration of the Ladybug has been done in the Ladybug test webapp: | ||
|
|
||
| - https://github.com/ibissource/ibis-ladybug-test-webapp | ||
| - https://github.com/ibissource/ladybug-test-webapp | ||
|
|
||
| The Quarkus application to demo and test Ladybug: | ||
|
|
||
|
|
@@ -151,13 +151,13 @@ Clone the following projects to your Git folder or any other folder of your choi | |
| - https://github.com/wearefrank/frank-runner (building and running the test webapp with Ladybug) | ||
| - https://github.com/frankframework/frankframework (in case you want to test your Ladybug changes with the Frank!Framework) | ||
|
|
||
| Create skip-replace-inject.txt in the ibis-ladybug folder. You do not have to give it any contents. If you want to understand the purpose of this file, then see `pom.xml`. | ||
| Create skip-replace-inject.txt in the ladybug folder. You do not have to give it any contents. If you want to understand the purpose of this file, then see `pom.xml`. | ||
|
|
||
| Backend development | ||
| ------------------- | ||
|
|
||
| Read the Frank!Runner [README.md](https://github.com/ibissource/frank-runner#frankrunner) to learn how to integrate it | ||
| with your IDE but you can also just start the restart.bat in the frank-runner/specials/ibis-ladybug folder. This should | ||
| with your IDE but you can also just start the restart.bat in the frank-runner/specials/ladybug folder. This should | ||
| build and run the test webapp with Ladybug. When Tomcat has been started by the Frank!Runner browse to: | ||
|
|
||
| - http://localhost | ||
|
|
@@ -168,7 +168,7 @@ To speed up the build copy build-exmaple.properties in this folder to build.prop | |
| properties as describes in the comments in this file. | ||
|
|
||
| You can also enable spring.profiles.active=storage.file to use the file storage and see the reports generated by the | ||
| unit tests of the ibis-ladybug project in the Ladybug GUI. | ||
| unit tests of the ladybug project in the Ladybug GUI. | ||
|
|
||
| Testing backend changes with Frank!Framework | ||
| -------------------------------------------- | ||
|
|
@@ -193,7 +193,7 @@ Please do the following to set up your development environment for the front-end | |
| Testing frontend changes with the test webapp | ||
| --------------------------------------------- | ||
|
|
||
| * Start the backend using `frank-runner/specials/ibis-ladybug` as explained at [Backend development](#backend-development). Wait until Tomcat is up and running. | ||
| * Start the backend using `frank-runner/specials/ladybug` as explained at [Backend development](#backend-development). Wait until Tomcat is up and running. | ||
| * Execute command `ng serve` from within the `ladybug-frontend` checkout. This wil make Node.js serve the Ladybug frontend files and proxy the Ladybug backend api as the src folder contains a proxy.conf.json (this will circumvent CORS related problems as the frontend served by Node.js on port 4200 would call the api on port 80). It is now possible to use both the WebJars packaged Ladybug frontend and the Ladybug frontend served by Node.js. The page on the following url (also mentioned above) contains links to both frontends: `http://localhost`. | ||
|
|
||
| Testing frontend changes with Frank!Framework | ||
|
|
@@ -219,7 +219,7 @@ End-to-end testing is done using [Cypress](https://www.cypress.io/). Cypress is | |
| In case nothing happens after "Compiled successfully" you might need to run `set HTTP_PROXY=` to prevent Cypress from connecting to locahost using your | ||
| proxy. | ||
|
|
||
| When the tests are running, you will see the ibis-ladybug GUI. The GUI will show the effects of the commands that are applied by the tests. | ||
| When the tests are running, you will see the ladybug GUI. The GUI will show the effects of the commands that are applied by the tests. | ||
|
|
||
| Quarkus | ||
| ===== | ||
|
|
@@ -277,35 +277,35 @@ CI/CD | |
|
|
||
| The preceeding sections explained how to change Ladybug. This section explains the CI/CD of Ladybug and it explains how we manage releases. | ||
|
|
||
| First remember that ibis-ladybug is the main project. Project ladybug-frontend is a dependency of ibis-ladybug. The frontend version referenced by ibis-ladybug is specified by the ibis-ladybug `pom.xml` file. It is the value of property `frontend.version`. This property contains a version number that references a WebJar, see [Create and publish NPM package and WebJar](#create-and-publish-npm-package-and-webjar) about creating a WebJar from project ladybug-frontend. This way, a release of ibis-ladybug comes down to releasing the combination of ibis-ladybug and ladybug-frontend. | ||
| First remember that ladybug is the main project. Project ladybug-frontend is a dependency of ladybug. The frontend version referenced by ladybug is specified by the ladybug `pom.xml` file. It is the value of property `frontend.version`. This property contains a version number that references a WebJar, see [Create and publish NPM package and WebJar](#create-and-publish-npm-package-and-webjar) about creating a WebJar from project ladybug-frontend. This way, a release of ladybug comes down to releasing the combination of ladybug and ladybug-frontend. | ||
|
|
||
| WeAreFrank! has two automatic tests for Ladybug. First, our on-premise servers run a Jenkins test. This test checks the build of the ibis-ladybug project, in particular the master branch. Second, there is a GitHub actions test that lives in the ladybug-frontend project. This test does integration tests that exercise the Ladybug front-end. It has been implemented using [Cypress](https://www.cypress.io/). The test checks out ladybug-frontend, ibis-ladybug, the Frank!Runner and ibis-ladybug-test-webapp. Using these checkout directories, Ladybug can be started using the Frank!Runner and its script `specials/ibis-ladybug/restart.sh`, see [How to change and test Ladybug](#how-to-change-and-test-ladybug). | ||
| WeAreFrank! has two automatic tests for Ladybug. First, our on-premise servers run a Jenkins test. This test checks the build of the ladybug project, in particular the master branch. Second, there is a GitHub actions test that lives in the ladybug-frontend project. This test does integration tests that exercise the Ladybug front-end. It has been implemented using [Cypress](https://www.cypress.io/). The test checks out ladybug-frontend, ladybug, the Frank!Runner and ladybug-test-webapp. Using these checkout directories, Ladybug can be started using the Frank!Runner and its script `specials/ladybug/restart.sh`, see [How to change and test Ladybug](#how-to-change-and-test-ladybug). | ||
|
|
||
| The Cypress test is used in two ways. First, it can be triggered if ibis-ladybug is updated. Project ibis-ladybug has a GitHub action that triggers the Cypress test of the front-end. This can happen because the Cypress test can be triggered by a `workflow_dispatch` event, see [test script](.github/workflows/start-frontend-test.yml). In this scenario, the following four inputs are provided: | ||
| The Cypress test is used in two ways. First, it can be triggered if ladybug is updated. Project ladybug has a GitHub action that triggers the Cypress test of the front-end. This can happen because the Cypress test can be triggered by a `workflow_dispatch` event, see [test script](.github/workflows/start-frontend-test.yml). In this scenario, the following four inputs are provided: | ||
|
|
||
| * frontendCommitToCheckout: ladybug-frontend commit to checkout, typically a reference to a tag. | ||
| * backendCommitToCheckout: ibis-ladybug commit to checkout, typically a branch name. | ||
| * useRealFrontend: `true`, because we do not want to use the checkout of ladybug-frontend, but the WebJar contained in ibis-ladybug. | ||
| * backendCommitToCheckout: ladybug commit to checkout, typically a branch name. | ||
| * useRealFrontend: `true`, because we do not want to use the checkout of ladybug-frontend, but the WebJar contained in ladybug. | ||
| * mergeMasterToBranch: `true`, for the backend directs the test to merge the master into the checkout. This way, a pull request of the backend is emulated. | ||
|
|
||
| This scenario does not work on forks of the ibis-ladybug project. A fork does not have rights to trigger tests within the `ibissource/ladybug-frontend` project. A commit on `ibissource/ibis-ladybug` triggers the front-end test. GitHub will not show the success or failure of the front-end test. Please browse to https://github.com/ibissource/ladybug-frontend and go to "Actions". Check the latest test run there. | ||
| This scenario does not work on forks of the ladybug project. A fork does not have rights to trigger tests within the `wearefrank/ladybug-frontend` project. A commit on `wearefrank/ladybug` triggers the front-end test. GitHub will not show the success or failure of the front-end test. Please browse to https://github.com/ibissource/ladybug-frontend and go to "Actions". Check the latest test run there. | ||
|
|
||
| The second use of the Cypress test is testing the front-end. The Cypress test is triggered by every commit and every pull request update of the ladybug-frontend project. The input arguments are not set, causing the new commit (or merge commit for a PR) to be checked out for ladybug-frontend. For ibis-ladybug the master is checked out. Input `useRealFrontend` is undefined, which is equivalent to `false`. This means that the front-end comes from the checkout of ladybug-frontend; the WebJar inside ibis-ladybug is ignored. Finally, `mergeMasterToBranch` is undefined (`false`). This scenario also works on forks of `ladybug-frontend`. | ||
| The second use of the Cypress test is testing the front-end. The Cypress test is triggered by every commit and every pull request update of the ladybug-frontend project. The input arguments are not set, causing the new commit (or merge commit for a PR) to be checked out for ladybug-frontend. For ladybug the master is checked out. Input `useRealFrontend` is undefined, which is equivalent to `false`. This means that the front-end comes from the checkout of ladybug-frontend; the WebJar inside ladybug is ignored. Finally, `mergeMasterToBranch` is undefined (`false`). This scenario also works on forks of `ladybug-frontend`. | ||
|
|
||
| Here is how to use the CI/CD of Ladybug: | ||
|
|
||
| ### Update the backend only | ||
|
|
||
| After a push on project `ibissource/ibis-ladybug`, open https://github.com/ibissource/ladybug-frontend and go to "Actions". Check the success or failure state of the latest GitHub action. The test exercises the front-end that is referenced by the backend, an integration test. The test logs which WebJar version of the front-end is used and what branch of the backend; please check these to see whether the test run corresponds to your commit. | ||
| After a push on project `wearefrank/ladybug`, open https://github.com/wearefrank/ladybug-frontend and go to "Actions". Check the success or failure state of the latest GitHub action. The test exercises the front-end that is referenced by the backend, an integration test. The test logs which WebJar version of the front-end is used and what branch of the backend; please check these to see whether the test run corresponds to your commit. | ||
|
|
||
| When the master of ibissource/ibis-ladybug has been changed, check the success or failure of our Jenkins test that runs on an on-premise server. That test checks the build of project ibis-ladybug. | ||
| When the master of wearefrank/ladybug has been changed, check the success or failure of our Jenkins test that runs on an on-premise server. That test checks the build of project ladybug. | ||
|
|
||
| ### Update the front-end | ||
|
|
||
| When updating the front-end, work on a branch that is allowed to live on a fork of the ladybug-frontend project. The Cypress test is executed for every commit. If you turn your work into a pull request, the success or failure status of the Cypress test will be shown in the pull request. As long as the updated front-end code is not referenced by the ibis-ladybug project, it is not part of Ladybug. | ||
| When updating the front-end, work on a branch that is allowed to live on a fork of the ladybug-frontend project. The Cypress test is executed for every commit. If you turn your work into a pull request, the success or failure status of the Cypress test will be shown in the pull request. As long as the updated front-end code is not referenced by the ladybug project, it is not part of Ladybug. | ||
|
|
||
| ### Update front-end and backend | ||
|
|
||
| Update the front-end and the backend simultaneously on your development PC. The front-end changes will fail in CI/CD because they are tested against the master of the backend. Rely on the Cypress test on your development PC and on the Maven build of ibis-ladybug to test your work. When you trust your work, release the front-end in a WebJar as explained in [Create and publish NPM package and WebJar](#create-and-publish-npm-package-and-webjar). Please note that the released commit may live on another branch than master. Ensure that the commit and the tag are pushed to GitHub project ibissource/ladybug-frontend. Then update `pom.xml` of ibis-ladybug to reference the new WebJar; do so on a branch pushed to ibissource/ibis-ladybug. This update of the backend triggers the GitHub actions front-end test as explained earlier. Check that the latest run of the front-end test succeeds. | ||
| Update the front-end and the backend simultaneously on your development PC. The front-end changes will fail in CI/CD because they are tested against the master of the backend. Rely on the Cypress test on your development PC and on the Maven build of ladybug to test your work. When you trust your work, release the front-end in a WebJar as explained in [Create and publish NPM package and WebJar](#create-and-publish-npm-package-and-webjar). Please note that the released commit may live on another branch than master. Ensure that the commit and the tag are pushed to GitHub project ibissource/ladybug-frontend. Then update `pom.xml` of ladybug to reference the new WebJar; do so on a branch pushed to wearefrank/ladybug. This update of the backend triggers the GitHub actions front-end test as explained earlier. Check that the latest run of the front-end test succeeds. | ||
|
|
||
| At this point, you can merge your work on ibis-ladybug to its master branch. After this merge, additional pushes on your ladybug-frontend branch will succeed in CI/CD because the corresponding backend changes are in the backend master. You can merge your front-end changes to master if the GitHub actions test succeeds. | ||
| At this point, you can merge your work on ladybug to its master branch. After this merge, additional pushes on your ladybug-frontend branch will succeed in CI/CD because the corresponding backend changes are in the backend master. You can merge your front-end changes to master if the GitHub actions test succeeds. | ||