This is an automated email from the ASF dual-hosted git repository. clebertsuconic pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/activemq-website.git
commit e5b239f32b4678c2d2859e37c999d662f8c71e4a Author: Clebert Suconic <[email protected]> AuthorDate: Mon Feb 6 10:29:50 2023 -0500 updating hacking guide --- .../documentation/hacking-guide/building.html | 2 +- .../hacking-guide/code-coverage-report.html | 4 +- .../artemis/documentation/hacking-guide/code.html | 19 +++++----- .../documentation/hacking-guide/formatting.html | 2 +- .../documentation/hacking-guide/history.html | 4 +- .../artemis/documentation/hacking-guide/ide.html | 4 +- .../hacking-guide/images/activemq-logo.png | Bin 0 -> 29377 bytes .../artemis/documentation/hacking-guide/index.html | 4 +- .../documentation/hacking-guide/maintainers.html | 42 ++++++++++----------- .../documentation/hacking-guide/notice.html | 2 +- .../documentation/hacking-guide/search_index.json | 2 +- .../artemis/documentation/hacking-guide/tests.html | 26 +++++++++---- .../hacking-guide/validating-releases.html | 2 +- 13 files changed, 63 insertions(+), 50 deletions(-) diff --git a/src/components/artemis/documentation/hacking-guide/building.html b/src/components/artemis/documentation/hacking-guide/building.html index c3f3eb4ea..2d1ea4e78 100644 --- a/src/components/artemis/documentation/hacking-guide/building.html +++ b/src/components/artemis/documentation/hacking-guide/building.html @@ -361,7 +361,7 @@ simply run</p> <script> var gitbook = gitbook || []; gitbook.push(function() { - gitbook.page.hasChanged({"page":{"title":"Building","level":"1.5","depth":1,"next":{"title":"Tests","level":"1.6","depth":1,"path":"tests.md","ref":"tests.md","articles":[]},"previous":{"title":"IDE Integration","level":"1.4","depth":1,"path":"ide.md","ref":"ide.md","articles":[]},"dir":"ltr"},"config":{"plugins":[],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print [...] + gitbook.page.hasChanged({"page":{"title":"Building","level":"1.5","depth":1,"next":{"title":"Tests","level":"1.6","depth":1,"path":"tests.md","ref":"tests.md","articles":[]},"previous":{"title":"IDE Integration","level":"1.4","depth":1,"path":"ide.md","ref":"ide.md","articles":[]},"dir":"ltr"},"config":{"plugins":[],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print [...] }); </script> </div> diff --git a/src/components/artemis/documentation/hacking-guide/code-coverage-report.html b/src/components/artemis/documentation/hacking-guide/code-coverage-report.html index fe83824f0..99575be84 100644 --- a/src/components/artemis/documentation/hacking-guide/code-coverage-report.html +++ b/src/components/artemis/documentation/hacking-guide/code-coverage-report.html @@ -284,7 +284,7 @@ you need to get data about what lines of code were executed during testing. These information are collected by JaCoCo agent and stored in JaCoCo exec files. All you need to do is run the tests with <code>jacoco</code> maven profile.</p> -<pre><code>mvn test -Ptests,extra-tests,jacoco +<pre><code>mvn test -Ptests,jacoco </code></pre><h2 id="generate-jacoco-reports">Generate JaCoCo reports</h2> <pre><code>mvn verify -Pjacoco-generate-report -DskipTests </code></pre><p>For generating JaCoCo reports only run the maven build @@ -341,7 +341,7 @@ in one place, you can do it by command below.</p> <script> var gitbook = gitbook || []; gitbook.push(function() { - gitbook.page.hasChanged({"page":{"title":"Code coverage report","level":"1.7","depth":1,"next":{"title":"Code Formatting","level":"1.8","depth":1,"path":"formatting.md","ref":"formatting.md","articles":[]},"previous":{"title":"Tests","level":"1.6","depth":1,"path":"tests.md","ref":"tests.md","articles":[]},"dir":"ltr"},"config":{"plugins":[],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook. [...] + gitbook.page.hasChanged({"page":{"title":"Code coverage report","level":"1.7","depth":1,"next":{"title":"Code Formatting","level":"1.8","depth":1,"path":"formatting.md","ref":"formatting.md","articles":[]},"previous":{"title":"Tests","level":"1.6","depth":1,"path":"tests.md","ref":"tests.md","articles":[]},"dir":"ltr"},"config":{"plugins":[],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook. [...] }); </script> </div> diff --git a/src/components/artemis/documentation/hacking-guide/code.html b/src/components/artemis/documentation/hacking-guide/code.html index af1ea348c..23edd2876 100644 --- a/src/components/artemis/documentation/hacking-guide/code.html +++ b/src/components/artemis/documentation/hacking-guide/code.html @@ -342,7 +342,8 @@ example:</p> <li><p>Make the changes and commit one or more times</p> <pre><code> $ git commit </code></pre><p><a name="commitMessageDetails"></a> When you commit your changes you will need to supply a commit message. We follow the - 50/72 git commit message format. An ActiveMQ Artemis commit message should be formatted in the following manner:</p> + 50/72 git commit message format as recommended in the <a href="https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project"; target="_blank">official Git book</a>. + An ActiveMQ Artemis commit message should be formatted in the following manner:</p> <ol> <li>Add the first line with the summary, using maximum 50 characters. Start the summary with the jira key (ARTEMIS-XXX) followed by a brief description of the change. Use the prefix <code>NO-JIRA</code> only for a very small insignificant change, @@ -362,16 +363,16 @@ should be wrapped at 72 characters.</li> </code></pre></li> <li><p>Occasionally you'll want to push your commit(s) to GitHub for safe-keeping and/or sharing with others.</p> <pre><code> git push origin my_cool_feature -</code></pre><p>Note that git push references the branch you are pushing and defaults to <code>master</code>, not your working branch.</p> +</code></pre><p>Note that git push references the branch you are pushing and defaults to <code>main</code>, not your working branch.</p> </li> <li><p>Discuss your planned changes (if you want feedback)</p> <p>On mailing list - <a href="http://activemq.apache.org/mailing-lists.html"; target="_blank">http://activemq.apache.org/mailing-lists.html</a> On IRC - irc://irc.freenode.org/apache-activemq or <a href="https://webchat.freenode.net/?channels=apache-activemq"; target="_blank">https://webchat.freenode.net/?channels=apache-activemq</a></p> </li> -<li><p>Once you're finished coding your feature/fix then rebase your branch against the latest master (applies your patches -on top of master)</p> +<li><p>Once you're finished coding your feature/fix then rebase your branch against the latest main (applies your patches +on top of main)</p> <pre><code> git fetch upstream - git rebase -i upstream/master + git rebase -i upstream/main # if you have conflicts fix them and rerun rebase # The -f, forces the push, alters history, see note below git push -f origin my_cool_feature @@ -388,14 +389,14 @@ history (and thus, they will then need to rebase on top of your branch once you <li>An email will automatically be sent to the ActiveMQ developer list.</li> <li>As part of the review you may see an automated test run comment on your request.</li> <li>After review a maintainer will merge your PR into the canonical git repository at which point those changes will -be synced with the GitHub mirror repository (i.e. your <code>master</code>) and your PR will be closed by the <code>asfgit</code> bot.</li> +be synced with the GitHub mirror repository (i.e. your <code>main</code>) and your PR will be closed by the <code>asfgit</code> bot.</li> </ol> </li> </ol> <h2 id="other-common-tasks">Other common tasks</h2> <ol> <li><p>Pulling updates from upstream</p> -<pre><code> $ git pull --rebase upstream master +<pre><code> $ git pull --rebase upstream main </code></pre><p>(<code>--rebase</code> will automatically move your local commits, if any, on top of the latest branch you pull from; you can leave it off if you do not have any local commits).</p> <p>One last option, which some prefer, is to avoid using pull altogether, and just use fetch + rebase (this is of course @@ -411,7 +412,7 @@ more typing). For example:</p> Writing objects: 100% (100/100), 10.67 KiB, done. Total 100 (delta 47), reused 100 (delta 47) To [email protected]:<your-user-name>/apache-artemis.git - 3382570..1fa25df master -> master + 3382570..1fa25df main -> main </code></pre><p>You might need to say -f to force the changes.</p> </li> </ol> @@ -468,7 +469,7 @@ section of the top level pom). This allows ActiveMQ Artemis developers to keep <script> var gitbook = gitbook || []; gitbook.push(function() { - gitbook.page.hasChanged({"page":{"title":"Working with the Code","level":"1.3","depth":1,"next":{"title":"IDE Integration","level":"1.4","depth":1,"path":"ide.md","ref":"ide.md","articles":[]},"previous":{"title":"Legal Notice","level":"1.2","depth":1,"path":"notice.md","ref":"notice.md","articles":[]},"dir":"ltr"},"config":{"plugins":[],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css" [...] + gitbook.page.hasChanged({"page":{"title":"Working with the Code","level":"1.3","depth":1,"next":{"title":"IDE Integration","level":"1.4","depth":1,"path":"ide.md","ref":"ide.md","articles":[]},"previous":{"title":"Legal Notice","level":"1.2","depth":1,"path":"notice.md","ref":"notice.md","articles":[]},"dir":"ltr"},"config":{"plugins":[],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css" [...] }); </script> </div> diff --git a/src/components/artemis/documentation/hacking-guide/formatting.html b/src/components/artemis/documentation/hacking-guide/formatting.html index 2cd8d260c..21623cfde 100644 --- a/src/components/artemis/documentation/hacking-guide/formatting.html +++ b/src/components/artemis/documentation/hacking-guide/formatting.html @@ -335,7 +335,7 @@ etc/ide-settings/editorconfig.ini. Copy it to your Artemis top level directory a <script> var gitbook = gitbook || []; gitbook.push(function() { - gitbook.page.hasChanged({"page":{"title":"Code Formatting","level":"1.8","depth":1,"next":{"title":"Validating releases","level":"1.9","depth":1,"path":"validating-releases.md","ref":"validating-releases.md","articles":[]},"previous":{"title":"Code coverage report","level":"1.7","depth":1,"path":"code-coverage-report.md","ref":"code-coverage-report.md","articles":[]},"dir":"ltr"},"config":{"plugins":[],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"st [...] + gitbook.page.hasChanged({"page":{"title":"Code Formatting","level":"1.8","depth":1,"next":{"title":"Validating releases","level":"1.9","depth":1,"path":"validating-releases.md","ref":"validating-releases.md","articles":[]},"previous":{"title":"Code coverage report","level":"1.7","depth":1,"path":"code-coverage-report.md","ref":"code-coverage-report.md","articles":[]},"dir":"ltr"},"config":{"plugins":[],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"st [...] }); </script> </div> diff --git a/src/components/artemis/documentation/hacking-guide/history.html b/src/components/artemis/documentation/hacking-guide/history.html index e1103bb0f..4a4aebb89 100644 --- a/src/components/artemis/documentation/hacking-guide/history.html +++ b/src/components/artemis/documentation/hacking-guide/history.html @@ -294,7 +294,7 @@ <p>For more information please visit the <a href="https://github.com/hornetq/hornetq/tree/apache-donation"; target="_blank">HornetQ GitHub project</a>.</p> <h1 id="rebasing-original-donation">Rebasing original donation</h1> <p>It may be useful to look at the donation history combined with the artemis history. It is the case when eventually looking at old changes.</p> -<p>For that there is a script that will rebase master against the donation branch under master/scripts:</p> +<p>For that there is a script that will rebase main against the donation branch under main/scripts:</p> <ul> <li>rebase-donation.sh</li> </ul> @@ -337,7 +337,7 @@ <script> var gitbook = gitbook || []; gitbook.push(function() { - gitbook.page.hasChanged({"page":{"title":"History","level":"1.11","depth":1,"previous":{"title":"Notes for Maintainers","level":"1.10","depth":1,"path":"maintainers.md","ref":"maintainers.md","articles":[]},"dir":"ltr"},"config":{"plugins":[],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"highlight":{},"search":{},"lunr":{"maxIndexSize":1 [...] + gitbook.page.hasChanged({"page":{"title":"History","level":"1.11","depth":1,"previous":{"title":"Notes for Maintainers","level":"1.10","depth":1,"path":"maintainers.md","ref":"maintainers.md","articles":[]},"dir":"ltr"},"config":{"plugins":[],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"highlight":{},"search":{},"lunr":{"maxIndexSize":1 [...] }); </script> </div> diff --git a/src/components/artemis/documentation/hacking-guide/ide.html b/src/components/artemis/documentation/hacking-guide/ide.html index 6bb6439a4..b96cc97b5 100644 --- a/src/components/artemis/documentation/hacking-guide/ide.html +++ b/src/components/artemis/documentation/hacking-guide/ide.html @@ -280,7 +280,7 @@ <h1 id="ide-integration">IDE Integration</h1> <p>There a few files useful for IDE integration under ./etc/ide-settings on a checked out folder. This folder is not part of the source distribution, but it can be easily obtained:</p> <ul> -<li><a href="https://github.com/apache/activemq-artemis/tree/master/etc/ide-settings"; target="_blank">https://github.com/apache/activemq-artemis/tree/master/etc/ide-settings</a></li> +<li><a href="https://github.com/apache/activemq-artemis/tree/main/etc/ide-settings"; target="_blank">https://github.com/apache/activemq-artemis/tree/main/etc/ide-settings</a></li> </ul> <h2 id="intellij-idea">IntelliJ IDEA</h2> <h3 id="importing-the-project">Importing the Project</h3> @@ -425,7 +425,7 @@ feature. A good introduction to it can be found at a <script> var gitbook = gitbook || []; gitbook.push(function() { - gitbook.page.hasChanged({"page":{"title":"IDE Integration","level":"1.4","depth":1,"next":{"title":"Building","level":"1.5","depth":1,"path":"building.md","ref":"building.md","articles":[]},"previous":{"title":"Working with the Code","level":"1.3","depth":1,"path":"code.md","ref":"code.md","articles":[]},"dir":"ltr"},"config":{"plugins":[],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.cs [...] + gitbook.page.hasChanged({"page":{"title":"IDE Integration","level":"1.4","depth":1,"next":{"title":"Building","level":"1.5","depth":1,"path":"building.md","ref":"building.md","articles":[]},"previous":{"title":"Working with the Code","level":"1.3","depth":1,"path":"code.md","ref":"code.md","articles":[]},"dir":"ltr"},"config":{"plugins":[],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.cs [...] }); </script> </div> diff --git a/src/components/artemis/documentation/hacking-guide/images/activemq-logo.png b/src/components/artemis/documentation/hacking-guide/images/activemq-logo.png new file mode 100644 index 000000000..76b344d65 Binary files /dev/null and b/src/components/artemis/documentation/hacking-guide/images/activemq-logo.png differ diff --git a/src/components/artemis/documentation/hacking-guide/index.html b/src/components/artemis/documentation/hacking-guide/index.html index 8a6827843..12e1e475d 100644 --- a/src/components/artemis/documentation/hacking-guide/index.html +++ b/src/components/artemis/documentation/hacking-guide/index.html @@ -275,7 +275,7 @@ <section class="normal markdown-section"> - <p><img src="images/artemis-logo.png" alt="ActiveMQ Artemis logo"></p> + <p><img src="images/activemq-logo.png" alt="ActiveMQ Artemis logo"></p> <h1 id="apache-activemq-artemis-hacking-guide">Apache ActiveMQ Artemis Hacking Guide</h1> <p>This hacking guide outlines how developers can get involved in contributing to the Apache ActiveMQ Artemis project.</p> @@ -317,7 +317,7 @@ <script> var gitbook = gitbook || []; gitbook.push(function() { - gitbook.page.hasChanged({"page":{"title":"Introduction","level":"1.1","depth":1,"next":{"title":"Legal Notice","level":"1.2","depth":1,"path":"notice.md","ref":"notice.md","articles":[]},"dir":"ltr"},"config":{"plugins":[],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecia [...] + gitbook.page.hasChanged({"page":{"title":"Introduction","level":"1.1","depth":1,"next":{"title":"Legal Notice","level":"1.2","depth":1,"path":"notice.md","ref":"notice.md","articles":[]},"dir":"ltr"},"config":{"plugins":[],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecia [...] }); </script> </div> diff --git a/src/components/artemis/documentation/hacking-guide/maintainers.html b/src/components/artemis/documentation/hacking-guide/maintainers.html index b089a5075..7314b3709 100644 --- a/src/components/artemis/documentation/hacking-guide/maintainers.html +++ b/src/components/artemis/documentation/hacking-guide/maintainers.html @@ -286,7 +286,7 @@ confident that the changes that are being committed will not break the build.</p <p>What does it mean to be reasonably confident? If the developer has run the same maven commands that the pull-request builds are running they can be reasonably confident. Currently the <a href="https://builds.apache.org/job/ActiveMQ-Artemis-PR-Build/"; target="_blank">PR build</a> runs this command:</p> -<pre><code>mvn -Pfast-tests -Pextra-tests install +<pre><code>mvn -Pfast-tests install </code></pre><p>However, if the changes are significant, touches a wide area of code, or even if the developer just wants a second opinion they are encouraged to engage other members of the community to obtain an additional review prior to pushing. This can easily be done via a pull request on GitHub, a patch file attached to an email or JIRA, commit to a branch @@ -339,18 +339,18 @@ if you choose. Just be sure to edit all references to the remote repo name so it <li><p>Checkout the pull request you wish to review</p> <pre><code> $ git checkout pr/105 -B 105 </code></pre></li> -<li><p>Rebase the branch against master, so the merge would happen at the top of the current master</p> -<pre><code> $ git pull --rebase apache master +<li><p>Rebase the branch against main, so the merge would happen at the top of the current main</p> +<pre><code> $ git pull --rebase apache main </code></pre></li> -<li><p>Once you've reviewed the change and are ready to merge checkout <code>master</code>.</p> -<pre><code> $ git checkout master +<li><p>Once you've reviewed the change and are ready to merge checkout <code>main</code>.</p> +<pre><code> $ git checkout main </code></pre></li> -<li><p>Ensure you are up to date on your master also.</p> -<pre><code> $ git pull --rebase apache master +<li><p>Ensure you are up to date on your main also.</p> +<pre><code> $ git pull --rebase apache main </code></pre></li> -<li><p>We actually recommend checking out master again, to make sure you wouldn't add any extra commits by accident:</p> +<li><p>We actually recommend checking out main again, to make sure you wouldn't add any extra commits by accident:</p> <pre><code> $ git fetch apache - $ git checkout apache/master -B master + $ git checkout apache/main -B main </code></pre></li> <li><p>Create a new merge commit from the pull-request. IMPORTANT: The commit message here should be something like: "This closes #105" where "105" is the pull request ID. The "#105" shows up as a link in the GitHub UI for navigating to @@ -359,7 +359,7 @@ to eventual rebases.</p> <pre><code> $ git merge --no-ff 105 -m "This closes #105" </code></pre></li> <li><p>Push to the canonical Apache repo.</p> -<pre><code> $ git push apache master +<pre><code> $ git push apache main </code></pre></li> </ol> <h2 id="using-the-automated-script">Using the automated script</h2> @@ -376,31 +376,31 @@ the merging process. This will execute the exact steps described on this previou $ ./scripts/merge-PR.sh 175 ARTEMIS-229 address on Security Interface </code></pre><p>The previous example was taken from a real case that generated this <a href="https://github.com/apache/activemq-artemis/commit/e85bb3ca4a75b0f1dfbe717ff90b34309e2de794"; target="_blank">merge commit on #175</a>.</p> <ul> -<li>After this you can push to the canonical Apache repo.<pre><code>$ git push apache master +<li>After this you can push to the canonical Apache repo.<pre><code>$ git push apache main </code></pre></li> </ul> <h2 id="use-a-separate-branch-for-your-changes">Use a separate branch for your changes</h2> -<p>It is recommended that you work away from master for two reasons:</p> +<p>It is recommended that you work away from main for two reasons:</p> <ol> <li><p>When you send a PR, your PR branch could be rebased during the process and your commit ID changed. You might get unexpected conflicts while rebasing your old branch.</p> </li> <li><p>You could end up pushing things upstream that you didn't intend to. Minimize your risks by working on a branch -away from master.</p> +away from main.</p> </li> </ol> <h2 id="notes">Notes:</h2> <p>The GitHub mirror repository (i.e. <code>upstream</code>) is cloning the canonical Apache repository. Because of this there may be a slight delay between when a commit is pushed to the Apache repo and when that commit is reflected in the GitHub mirror. This may cause some difficulty when trying to push a PR to <code>apache</code> that has been merged on the out-of-date GitHub mirror. -You can wait for the mirror to update before performing the steps above or you can change your local master branch to -track the master branch on the canonical Apache repository rather than the master branch on the GitHub mirror:</p> -<pre><code>$ git branch master -u apache/master +You can wait for the mirror to update before performing the steps above or you can change your local main branch to +track the main branch on the canonical Apache repository rather than the main branch on the GitHub mirror:</p> +<pre><code>$ git branch main -u apache/main </code></pre><p>Where <code>apache</code> points to the canonical Apache repository.</p> -<p>If you'd like your local master branch to always track <code>upstream/master</code> (i.e. the GitHub mirror) then another way to -achieve this is to add another branch that tracks <code>apache/master</code> and push from that branch e.g.</p> -<pre><code>$ git checkout master -$ git branch apache_master --track apache/master +<p>If you'd like your local main branch to always track <code>upstream/main</code> (i.e. the GitHub mirror) then another way to +achieve this is to add another branch that tracks <code>apache/main</code> and push from that branch e.g.</p> +<pre><code>$ git checkout main +$ git branch apache_main --track apache/main $ git pull $ git merge --no-ff pr/105 $ git push @@ -447,7 +447,7 @@ $ git push <script> var gitbook = gitbook || []; gitbook.push(function() { - gitbook.page.hasChanged({"page":{"title":"Notes for Maintainers","level":"1.10","depth":1,"next":{"title":"History","level":"1.11","depth":1,"path":"history.md","ref":"history.md","articles":[]},"previous":{"title":"Validating releases","level":"1.9","depth":1,"path":"validating-releases.md","ref":"validating-releases.md","articles":[]},"dir":"ltr"},"config":{"plugins":[],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/m [...] + gitbook.page.hasChanged({"page":{"title":"Notes for Maintainers","level":"1.10","depth":1,"next":{"title":"History","level":"1.11","depth":1,"path":"history.md","ref":"history.md","articles":[]},"previous":{"title":"Validating releases","level":"1.9","depth":1,"path":"validating-releases.md","ref":"validating-releases.md","articles":[]},"dir":"ltr"},"config":{"plugins":[],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/m [...] }); </script> </div> diff --git a/src/components/artemis/documentation/hacking-guide/notice.html b/src/components/artemis/documentation/hacking-guide/notice.html index 6efb3c29f..a6fefde0a 100644 --- a/src/components/artemis/documentation/hacking-guide/notice.html +++ b/src/components/artemis/documentation/hacking-guide/notice.html @@ -333,7 +333,7 @@ limitations under the License.</p> <script> var gitbook = gitbook || []; gitbook.push(function() { - gitbook.page.hasChanged({"page":{"title":"Legal Notice","level":"1.2","depth":1,"next":{"title":"Working with the Code","level":"1.3","depth":1,"path":"code.md","ref":"code.md","articles":[]},"previous":{"title":"Introduction","level":"1.1","depth":1,"path":"README.md","ref":"README.md","articles":[]},"dir":"ltr"},"config":{"plugins":[],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css", [...] + gitbook.page.hasChanged({"page":{"title":"Legal Notice","level":"1.2","depth":1,"next":{"title":"Working with the Code","level":"1.3","depth":1,"path":"code.md","ref":"code.md","articles":[]},"previous":{"title":"Introduction","level":"1.1","depth":1,"path":"README.md","ref":"README.md","articles":[]},"dir":"ltr"},"config":{"plugins":[],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css", [...] }); </script> </div> diff --git a/src/components/artemis/documentation/hacking-guide/search_index.json b/src/components/artemis/documentation/hacking-guide/search_index.json index ae4e1c2f3..2fe993353 100644 --- a/src/components/artemis/documentation/hacking-guide/search_index.json +++ b/src/components/artemis/documentation/hacking-guide/search_index.json @@ -1 +1 @@ -{"index":{"version":"0.5.12","fields":[{"name":"title","boost":10},{"name":"keywords","boost":15},{"name":"body","boost":1}],"ref":"url","documentStore":{"store":{"./":["activemq","apach","artemi","contribut","develop","guid","hack","introduct","involv","outlin","project."],"notice.html":["\"a","\"license\");","(asf)","(the","2.0","addit","agre","agreements.","apach","applic","asf","basis,","complianc","condit","contributor","copi","copyright","distribut","except","express","file","found [...] \ No newline at end of file +{"index":{"version":"0.5.12","fields":[{"name":"title","boost":10},{"name":"keywords","boost":15},{"name":"body","boost":1}],"ref":"url","documentStore":{"store":{"./":["activemq","apach","artemi","contribut","develop","guid","hack","introduct","involv","outlin","project."],"notice.html":["\"a","\"license\");","(asf)","(the","2.0","addit","agre","agreements.","apach","applic","asf","basis,","complianc","condit","contributor","copi","copyright","distribut","except","express","file","found [...] \ No newline at end of file diff --git a/src/components/artemis/documentation/hacking-guide/tests.html b/src/components/artemis/documentation/hacking-guide/tests.html index faebe9329..3a788702d 100644 --- a/src/components/artemis/documentation/hacking-guide/tests.html +++ b/src/components/artemis/documentation/hacking-guide/tests.html @@ -290,20 +290,32 @@ <p>The broker is comprised of POJOs so it's simple to configure and run a broker instance and test particular functionality. Even complex test-cases involving multiple clustered brokers are relatively easy to write. Almost every test in the test-suite follows this pattern - configure broker, start broker, test functionality, stop broker.</p> -<p>The test-suite uses JUnit to manage test execution and life-cycle. Most tests extend <a href="https://github.com/apache/activemq-artemis/blob/master/artemis-server/src/test/java/org/apache/activemq/artemis/tests/util/ActiveMQTestBase.java"; target="_blank"><code>org.apache.activemq.artemis.tests.util.ActiveMQTestBase</code></a> +<p>The test-suite uses JUnit to manage test execution and life-cycle. Most tests extend <a href="https://github.com/apache/activemq-artemis/blob/main/artemis-server/src/test/java/org/apache/activemq/artemis/tests/util/ActiveMQTestBase.java"; target="_blank"><code>org.apache.activemq.artemis.tests.util.ActiveMQTestBase</code></a> which contains JUnit setup and tear-down methods as well as a wealth of utility functions to configure, start, manage, and stop brokers as well as perform other common tasks.</p> -<p>Check out <a href="https://github.com/apache/activemq-artemis/blob/master/tests/integration-tests/src/test/java/org/apache/activemq/artemis/tests/integration/SimpleTest.java"; target="_blank"><code>org.apache.activemq.artemis.tests.integration.SimpleTest</code></a>. +<p>Check out <a href="https://github.com/apache/activemq-artemis/blob/main/tests/integration-tests/src/test/java/org/apache/activemq/artemis/tests/integration/SimpleTest.java"; target="_blank"><code>org.apache.activemq.artemis.tests.integration.SimpleTest</code></a>. It's a very simple test-case that extends <code>org.apache.activemq.artemis.tests.util.ActiveMQTestBase</code> and uses its methods to configure a server, run a test, and then <code>super.tearDown()</code> cleans it up once the test completes. The test-case includes comments to explain everything. As the name implies, this is a simple test-case that demonstrates the most basic functionality of the test-suite. A simple test like this takes less than a second to run on modern hardware.</p> <p>Although <code>org.apache.activemq.artemis.tests.integration.SimpleTest</code> is simple it could be simpler still by extending -<a href="https://github.com/apache/activemq-artemis/blob/master/artemis-server/src/test/java/org/apache/activemq/artemis/tests/util/SingleServerTestBase.java"; target="_blank"><code>org.apache.activemq.artemis.tests.util.SingleServerTestBase</code></a>. +<a href="https://github.com/apache/activemq-artemis/blob/main/artemis-server/src/test/java/org/apache/activemq/artemis/tests/util/SingleServerTestBase.java"; target="_blank"><code>org.apache.activemq.artemis.tests.util.SingleServerTestBase</code></a>. This class does all the setup of a simple server automatically and provides the test-case with a <code>ServerLocator</code>, -<code>ClientSessionFactory</code>, and <code>ClientSession</code> instance. <a href="https://github.com/apache/activemq-artemis/blob/master//tests/integration-tests/src/test/java/org/apache/activemq/artemis/tests/integration/SingleServerSimpleTest.java"; target="_blank"><code>org.apache.activemq.artemis.tests.integration.SingleServerSimpleTest</code></a> +<code>ClientSessionFactory</code>, and <code>ClientSession</code> instance. <a href="https://github.com/apache/activemq-artemis/blob/main//tests/integration-tests/src/test/java/org/apache/activemq/artemis/tests/integration/SingleServerSimpleTest.java"; target="_blank"><code>org.apache.activemq.artemis.tests.integration.SingleServerSimpleTest</code></a> is an example based on <code>org.apache.activemq.artemis.tests.integration.SimpleTest</code> but extends <code>org.apache.activemq.artemis.tests.util.SingleServerTestBase</code> which eliminates all the setup and class variables which are provided by <code>SingleServerTestBase</code> itself.</p> +<h2 id="writing-web-tests">Writing Web Tests</h2> +<p>The broker has a web console based on <a href="https://github.com/hawtio/hawtio"; target="_blank">hawtio</a> and the <code>smoke-tests</code> are used to test it. +For instance, the <a href="https://github.com/apache/activemq-artemis/blob/main/tests/smoke-tests/src/test/java/org/apache/activemq/artemis/tests/smoke/console/ConsoleTest.java"; target="_blank">ConsoleTest</a> +checks the web console using the <a href="https://github.com/SeleniumHQ/selenium"; target="_blank">selenium framework</a>. +The tests can be executed using a remote server, local browsers or <a href="https://www.testcontainers.org/modules/webdriver_containers"; target="_blank">testcontainers</a>. +To use a remote server set the <code>webdriver.remote.server</code> property with the URL +of the server, ie -Dwebdriver.remote.server=<a href="http://localhost:4444/wd/hub"; target="_blank">http://localhost:4444/wd/hub</a> +To use your local Google Chrome browser download the <a href="https://chromedriver.chromium.org/"; target="_blank">WebDriver for Chrome</a> and set +the <code>webdriver.chrome.driver</code> property with the WebDriver path, ie <code>-Dwebdriver.chrome.driver=/home/artemis/chromedriver_linux64/chromedriver</code>. +To use your local Firefox browser download the <a href="https://github.com/mozilla/geckodriver/"; target="_blank">WebDriver for Firefox</a> and set +the <code>webdriver.gecko.driver</code> property with the WebDriver path, ie <code>-Dwebdriver.gecko.driver=/home/artemis/geckodriver-linux64/geckodriver</code>. +To use <a href="https://www.testcontainers.org/modules/webdriver_containers"; target="_blank">testcontainers</a> install docker.</p> <h2 id="keys-for-writing-good-tests">Keys for writing good tests</h2> <h3 id="use-logdebug">Use log.debug</h3> <ul> @@ -311,7 +323,7 @@ which eliminates all the setup and class variables which are provided by <code>S </ul> <p>On your classes, import the following:</p> <pre><code class="lang-java"><span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MyTest</span> </span>{ - <span class="hljs-keyword">private</span> <span class="hljs-keyword">static</span> <span class="hljs-keyword">final</span> org.jboss.logging.Logger log = org.jboss.logging.Logger.getLogger($CLASS_NAME$.class); + <span class="hljs-keyword">private</span> <span class="hljs-keyword">static</span> <span class="hljs-keyword">final</span> org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger($CLASS_NAME$.class); <span class="hljs-meta">@Test</span> <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">test</span><span class="hljs-params">()</span> </span>{ @@ -327,7 +339,7 @@ which eliminates all the setup and class variables which are provided by <code>S <p>An important task for any test-case is to clean up all the resources it creates when it runs. This includes the server instance itself and any resources created to connect to it (e.g. instances of <code>ServerLocator</code>, <code>ClientSessionFactory</code>, <code>ClientSession</code>, etc.). This task is typically completed in the test's <code>tearDown()</code> method. However, <code>ActiveMQTestBase</code> -(and other classes which extend it) simplifies this process. As <a href="https://github.com/apache/activemq-artemis/blob/master/tests/integration-tests/src/test/java/org/apache/activemq/artemis/tests/integration/SimpleTest.java"; target="_blank"><code>org.apache.activemq.artemis.tests.integration.SimpleTest</code></a> +(and other classes which extend it) simplifies this process. As <a href="https://github.com/apache/activemq-artemis/blob/main/tests/integration-tests/src/test/java/org/apache/activemq/artemis/tests/integration/SimpleTest.java"; target="_blank"><code>org.apache.activemq.artemis.tests.integration.SimpleTest</code></a> demonstrates, there are several methods you can use when creating your test which will ensure proper clean up <em>automatically</em> when the test is torn down. These include:</p> <ul> @@ -394,7 +406,7 @@ testing infrastructure to test your particular case.</p> <script> var gitbook = gitbook || []; gitbook.push(function() { - gitbook.page.hasChanged({"page":{"title":"Tests","level":"1.6","depth":1,"next":{"title":"Code coverage report","level":"1.7","depth":1,"path":"code-coverage-report.md","ref":"code-coverage-report.md","articles":[]},"previous":{"title":"Building","level":"1.5","depth":1,"path":"building.md","ref":"building.md","articles":[]},"dir":"ltr"},"config":{"plugins":[],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","eb [...] + gitbook.page.hasChanged({"page":{"title":"Tests","level":"1.6","depth":1,"next":{"title":"Code coverage report","level":"1.7","depth":1,"path":"code-coverage-report.md","ref":"code-coverage-report.md","articles":[]},"previous":{"title":"Building","level":"1.5","depth":1,"path":"building.md","ref":"building.md","articles":[]},"dir":"ltr"},"config":{"plugins":[],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","eb [...] }); </script> </div> diff --git a/src/components/artemis/documentation/hacking-guide/validating-releases.html b/src/components/artemis/documentation/hacking-guide/validating-releases.html index 6c3fbd739..689da41a5 100644 --- a/src/components/artemis/documentation/hacking-guide/validating-releases.html +++ b/src/components/artemis/documentation/hacking-guide/validating-releases.html @@ -375,7 +375,7 @@ You can do this by running these examples after the .m2 profile installations fo <script> var gitbook = gitbook || []; gitbook.push(function() { - gitbook.page.hasChanged({"page":{"title":"Validating releases","level":"1.9","depth":1,"next":{"title":"Notes for Maintainers","level":"1.10","depth":1,"path":"maintainers.md","ref":"maintainers.md","articles":[]},"previous":{"title":"Code Formatting","level":"1.8","depth":1,"path":"formatting.md","ref":"formatting.md","articles":[]},"dir":"ltr"},"config":{"plugins":[],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi [...] + gitbook.page.hasChanged({"page":{"title":"Validating releases","level":"1.9","depth":1,"next":{"title":"Notes for Maintainers","level":"1.10","depth":1,"path":"maintainers.md","ref":"maintainers.md","articles":[]},"previous":{"title":"Code Formatting","level":"1.8","depth":1,"path":"formatting.md","ref":"formatting.md","articles":[]},"dir":"ltr"},"config":{"plugins":[],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi [...] }); </script> </div>
