You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2020/01/31 19:25:47 UTC
[isis] 02/09: ISIS-2062: docs
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git
commit 5dc6cea83069e9f7a233c672b968fe398439748b
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Fri Jan 31 16:05:25 2020 +0000
ISIS-2062: docs
---
mavendeps/adoc/modules/mavendeps/pages/about.adoc | 56 ++++++++++------------
.../modules/mavendeps/partials/module-nav.adoc | 2 +-
.../adoc/modules/ROOT/partials/component-nav.adoc | 2 -
.../modules/parent-pom/partials/module-nav.adoc | 2 +-
.../adoc/modules/specsupport/pages/about.adoc | 12 ++---
5 files changed, 34 insertions(+), 40 deletions(-)
diff --git a/mavendeps/adoc/modules/mavendeps/pages/about.adoc b/mavendeps/adoc/modules/mavendeps/pages/about.adoc
index 81ae386..3da2ec8 100644
--- a/mavendeps/adoc/modules/mavendeps/pages/about.adoc
+++ b/mavendeps/adoc/modules/mavendeps/pages/about.adoc
@@ -1,21 +1,20 @@
-= Convenience POMs
+= Aggregator POMs
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-The framework provides a number of "convenience" POMs that act as aggregators of other dependencies.
+The framework provides a number of "aggregator" POMs that act as a convenient way to aggregate together various common dependencies.
-For example, when writing unit tests for your domain app,
-it can simply depend on the `isis-mavendeps-unittesting` artifact (rather than have to reference all of JUnit, AssertJ, Spring Boot, Hamcrest, Mockito and so on).
+For example, when writing unit tests for your domain app, it can simply depend on the `isis-mavendeps-unittests` artifact (rather than have to reference all of JUnit, AssertJ, Spring Boot, Hamcrest, Mockito and so on).
-Currently five convenience POMs are provided.
+Currently five aggregator POMs are provided.
-== isis-mavendeps-webapp
+== Webapp
The `isis-mavendeps-webapp` aggregates the main runtime dependencies of a production webapp.
To use, add the following :
[source,xml]
-.webapp/pom.xml
+.pom.xml
----
<dependencies>
<dependency>
@@ -49,15 +48,12 @@ For example, see the xref:starters:simpleapp:about.adoc#appmanifest[AppManifest
== Testing and BDD Specs
-Three convenience POMs are provided to support xref:testing:unittestsupport:about.adoc[unit testing], xref:testing:integtestsupport:about.adoc[integ testing] or running xref:testing:specsupport:about.adoc[BDD (Cucumber) specs].
-
-NOTE: in fact, these convenience POMs are just thin wrappers around the corresponding `isis-testing-xxx-applib` modules.
-We've added them for consistency.
+Three aggregator POMs are provided to support xref:testing:unittestsupport:about.adoc[unit testing], xref:testing:integtestsupport:about.adoc[integ testing] or running xref:testing:specsupport:about.adoc[BDD (Cucumber) specs].
To use them when unit testing, add:
[source,xml]
-.webapp/pom.xml
+.pom.xml
----
<dependencies>
<dependency>
@@ -72,7 +68,7 @@ To use them when unit testing, add:
For integration testing, add:
[source,xml]
-.webapp/pom.xml
+.pom.xml
----
<dependencies>
<dependency>
@@ -87,7 +83,7 @@ For integration testing, add:
For BDD (Cucumber) specs, within an integration testing context:
[source,xml]
-.webapp/pom.xml
+.pom.xml
----
<dependencies>
<dependency>
@@ -99,9 +95,9 @@ For BDD (Cucumber) specs, within an integration testing context:
</dependencies>
----
-The table below summarises the dependencies that each of these convenience POMs brings in.
+The table below summarises the dependencies that each of these aggregator POMs brings in.
-.Dependencies of the Convenience POM for Tests/Specs
+.Dependencies of the Aggregator POM for Tests/Specs
[cols="3a,^1a,^1a,^1a", options="header"]
|===
@@ -116,19 +112,19 @@ integspecs
|Apache Isis' own xref:testing:unittestsupport:about.adoc[unit test support] +
with JMock2 extensions to mock classes
-| Y | - | -
+| Y | |
|Apache Isis' own xref:testing:integtestsupport:about.adoc[integ test support]
-| - | Y | Y
+| | Y | Y
|Apache Isis' own xref:testing:specsupport:about.adoc[BDD spec support]
-| - | - | Y
+| | | Y
| link:https://junit.org/junit5/docs/current/user-guide/[JUnit 5 "jupiter"]
| Y | Y | Y
| link:https://junit.org/junit5/docs/current/user-guide/#migrating-from-junit4[JUnit 5 "vintage"]
-| Y | - | -
+| Y | |
| link:https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-testing[Spring Boot Test]
| Y | Y | Y
@@ -143,41 +139,41 @@ with JMock2 extensions to mock classes
| Y | Y | Y
| link:http://jmock.org/[JMock]
-| Y | - | -
+| Y | |
| link:https://github.com/approvals/ApprovalTests.Java[Approval tests]
| Y | Y | Y
| link:http://picocontainer.com/[PicoContainer] +
(for JMock2 extensions)
-| Y | - | -
+| Y | |
| Apache Isis xref:refguide:ROOT:about.adoc[Applib]
| Y | Y | Y
| Apache Isis xref:core:runtime-services:about.adoc[Runtime Services]
-| - | Y | Y
+| | Y | Y
| Apache Isis xref:security:bypass:about.adoc[Bypass] security
-| - | Y | Y
+| | Y | Y
| Apache Isis xref:pjdo:ROOT:about.adoc[JDO/DataNucleus]
-| - | Y | Y
+| | Y | Y
| Apache Isis xref:testing:fakedata:about.adoc[Fake Data]
| Y | Y | Y
| Apache Isis xref:testing:fixtures:about.adoc[Fixture Scripts]
-| - | Y | Y
+| | Y | Y
| link:https://github.com/google/guava/wiki[Google's Guava]
-| Y | - | -
+| Y | |
| link:http://hsqldb.org[HSQLDB]
-| - | Y | Y
+| | Y | Y
| link:https://www.h2database.com[H2 Database]
-| - | Y | Y
+| | Y | Y
|===
@@ -200,7 +196,7 @@ All you need to do is include this dependency in the webapp module:
To use, add the following :
[source,xml]
-.webapp/pom.xml
+.pom.xml
----
<dependencies>
<dependency>
diff --git a/mavendeps/adoc/modules/mavendeps/partials/module-nav.adoc b/mavendeps/adoc/modules/mavendeps/partials/module-nav.adoc
index 9276264..5eb488f 100644
--- a/mavendeps/adoc/modules/mavendeps/partials/module-nav.adoc
+++ b/mavendeps/adoc/modules/mavendeps/partials/module-nav.adoc
@@ -1 +1 @@
-** xref:starters:mavendeps:about.adoc[Convenience POMs]
+* xref:starters:mavendeps:about.adoc[Aggregator POMs]
diff --git a/starters/adoc/modules/ROOT/partials/component-nav.adoc b/starters/adoc/modules/ROOT/partials/component-nav.adoc
index de8307e..077098f 100644
--- a/starters/adoc/modules/ROOT/partials/component-nav.adoc
+++ b/starters/adoc/modules/ROOT/partials/component-nav.adoc
@@ -3,8 +3,6 @@ include::starters:ROOT:partial$module-nav.adoc[]
include::starters:helloworld:partial$module-nav.adoc[]
include::starters:simpleapp:partial$module-nav.adoc[]
-* Resources
-
include::starters:parent-pom:partial$module-nav.adoc[]
include::starters:mavendeps:partial$module-nav.adoc[]
diff --git a/starters/adoc/modules/parent-pom/partials/module-nav.adoc b/starters/adoc/modules/parent-pom/partials/module-nav.adoc
index 53b2005..7ec7a9d 100644
--- a/starters/adoc/modules/parent-pom/partials/module-nav.adoc
+++ b/starters/adoc/modules/parent-pom/partials/module-nav.adoc
@@ -1,4 +1,4 @@
-** xref:starters:parent-pom:about.adoc[Parent POM]
+* xref:starters:parent-pom:about.adoc[Parent POM]
diff --git a/testing/specsupport/adoc/modules/specsupport/pages/about.adoc b/testing/specsupport/adoc/modules/specsupport/pages/about.adoc
index 8fd70eb..8cb70ea 100644
--- a/testing/specsupport/adoc/modules/specsupport/pages/about.adoc
+++ b/testing/specsupport/adoc/modules/specsupport/pages/about.adoc
@@ -156,16 +156,16 @@ With the bootstrapping and infrastructure taken care of, let's look at the actua
[source,gherkin]
.SimpleObjectSpec_listAllAndCreate.feature
----
-@DomainAppDemo //<1>
-Feature: List and Create New Simple Objects //<2>
+Feature: List and Create New Simple Objects //<1>
- Scenario: Existing simple objects can be listed and new ones created //<2>
+ @DomainAppDemo //<2>
+ Scenario: Existing simple objects can be listed and new ones created //<1>
Given there are initially 10 simple objects //<3>
When I create a new simple object //<3>
Then there are 11 simple objects //<3>
----
-<1> Tag indicates the fixture to be run
-<2> Provide context, but not actually executed
+<1> Provide context, but not actually executed
+<2> Tag indicates the fixture to be run
<3> Map onto step definitions
We need a step definition to match the Cucumber tag to a xref:testing:fixtures:about.adoc[fixture script].
@@ -222,7 +222,7 @@ public class SimpleObjectsStepDef {
}
----
<1> injected domain service being interacted with
-<2> regex to match to feature file specification
+<2> regex to match to feature file specification.
<3> code that interacts with the domain service.
This is done using the xref:testing:integtestsupport:about.adoc#wrapper-factory[WrapperFactory] to simulate the UI.
<4> supporting domain services