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 2022/05/19 05:26:51 UTC
[isis] branch ISIS-3046 updated (dc19022db7 -> f29b78ebc0)
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a change to branch ISIS-3046
in repository https://gitbox.apache.org/repos/asf/isis.git
discard dc19022db7 ISIS-3046: updates docs on mavendeps
add 43972918c8 Merge pull request #943 from apache/ISIS-3057
new f29b78ebc0 ISIS-3046: updates docs on mavendeps
This update added new revisions after undoing existing revisions.
That is to say, some revisions that were in the old version of the
branch are not in the new version. This situation occurs
when a user --force pushes a change and generates a repository
containing something like this:
* -- * -- B -- O -- O -- O (dc19022db7)
\
N -- N -- N refs/heads/ISIS-3046 (f29b78ebc0)
You should already have received notification emails for all of the O
revisions, and so the following emails describe only the N revisions
from the common base, B.
Any revisions marked "omit" are not gone; other references still
refer to them. Any revisions marked "discard" are gone forever.
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
[isis] 01/01: ISIS-3046: updates docs on mavendeps
Posted by da...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch ISIS-3046
in repository https://gitbox.apache.org/repos/asf/isis.git
commit f29b78ebc046b271fb710ae34caa5e2e2d1fed3c
Author: Dan Haywood <da...@haywood-associates.co.uk>
AuthorDate: Thu May 19 06:23:33 2022 +0100
ISIS-3046: updates docs on mavendeps
---
.../components/docs/modules/ROOT/pages/about.adoc | 2 +-
.../ROOT/partials/module-nav/quick-start.adoc | 2 +-
core/adoc/modules/_overview/pages/about.adoc | 66 +++++-----
mavendeps/adoc/modules/mavendeps/pages/about.adoc | 137 ++-------------------
.../modules/parent-pom/attachments/parent-pom.pptx | Bin 51680 -> 49485 bytes
5 files changed, 43 insertions(+), 164 deletions(-)
diff --git a/antora/components/docs/modules/ROOT/pages/about.adoc b/antora/components/docs/modules/ROOT/pages/about.adoc
index cbabb41cc6..6df229612e 100644
--- a/antora/components/docs/modules/ROOT/pages/about.adoc
+++ b/antora/components/docs/modules/ROOT/pages/about.adoc
@@ -33,7 +33,7 @@ link:https://simpleapp.jpa.isis.incode.work[jpa])
_POMs_
* xref:docs:parent-pom:about.adoc[Parent POM]
-* xref:docs:mavendeps:about.adoc[Aggregator POMs]
+* xref:docs:mavendeps:about.adoc[Webapp Aggregator POM]
|
[discrete]
diff --git a/antora/components/docs/modules/ROOT/partials/module-nav/quick-start.adoc b/antora/components/docs/modules/ROOT/partials/module-nav/quick-start.adoc
index e89a19f025..8b799ba66f 100644
--- a/antora/components/docs/modules/ROOT/partials/module-nav/quick-start.adoc
+++ b/antora/components/docs/modules/ROOT/partials/module-nav/quick-start.adoc
@@ -7,6 +7,6 @@
** xref:docs:starters:simpleapp.adoc[SimpleApp]
** xref:docs:parent-pom:about.adoc[Parent POM]
-** xref:docs:mavendeps:about.adoc[Aggregator POMs]
+** xref:docs:mavendeps:about.adoc[Webapp Aggregator POM]
diff --git a/core/adoc/modules/_overview/pages/about.adoc b/core/adoc/modules/_overview/pages/about.adoc
index dbace8a672..91b0b72e79 100644
--- a/core/adoc/modules/_overview/pages/about.adoc
+++ b/core/adoc/modules/_overview/pages/about.adoc
@@ -33,7 +33,7 @@ package "App\n[Software System]" {
.Projects/Modules (App)
[cols="3a,5a", options="header"]
|===
-|Coordinates |Description
+|Coordinates |Description
|Apache Isis Starter Parent
[source,yaml]
@@ -98,7 +98,7 @@ package "Mavendeps\n[Software System]" {
.Projects/Modules (Mavendeps)
[cols="3a,5a", options="header"]
|===
-|Coordinates |Description
+|Coordinates |Description
|Apache Isis Maven Deps
[source,yaml]
@@ -326,7 +326,7 @@ package "Testing\n[Software System]" {
.Projects/Modules (Testing)
[cols="3a,5a", options="header"]
|===
-|Coordinates |Description
+|Coordinates |Description
|Apache Isis Testing
[source,yaml]
@@ -751,7 +751,7 @@ package "Examples\n[Software System]" {
.Projects/Modules (Examples)
[cols="3a,5a", options="header"]
|===
-|Coordinates |Description
+|Coordinates |Description
|Demo - Parent
[source,yaml]
@@ -1085,7 +1085,7 @@ org.apache.isis.valuetypes:isis-valuetypes-markdown-ui-wkt:jar:<managed> +
org.apache.isis.valuetypes:isis-valuetypes-sse-ui-wkt:jar:<managed> +
org.projectlombok:lombok:jar:<managed> +
****
-
+Sudo
|Demo - Web
[source,yaml]
----
@@ -1231,7 +1231,7 @@ package "Root\n[Software System]" {
.Projects/Modules (Root)
[cols="3a,5a", options="header"]
|===
-|Coordinates |Description
+|Coordinates |Description
|Apache Isis (Aggregator)
[source,yaml]
@@ -1311,7 +1311,7 @@ package "Commons\n[Software System]" {
.Projects/Modules (Commons)
[cols="3a,5a", options="header"]
|===
-|Coordinates |Description
+|Coordinates |Description
|Apache Isis Commons
[source,yaml]
@@ -1468,7 +1468,7 @@ package "Core\n[Software System]" {
.Projects/Modules (Core)
[cols="3a,5a", options="header"]
|===
-|Coordinates |Description
+|Coordinates |Description
|Apache Isis Core
[source,yaml]
@@ -2040,7 +2040,7 @@ package "JDO\n[Software System]" {
.Projects/Modules (JDO)
[cols="3a,5a", options="header"]
|===
-|Coordinates |Description
+|Coordinates |Description
|Apache Isis Persistence - JDO
[source,yaml]
@@ -2272,7 +2272,7 @@ package "JPA\n[Software System]" {
.Projects/Modules (JPA)
[cols="3a,5a", options="header"]
|===
-|Coordinates |Description
+|Coordinates |Description
|Apache Isis Persistence - JPA
[source,yaml]
@@ -2413,7 +2413,7 @@ package "Bypass\n[Software System]" {
.Projects/Modules (Bypass)
[cols="3a,5a", options="header"]
|===
-|Coordinates |Description
+|Coordinates |Description
|Apache Isis Security - Bypass
[source,yaml]
@@ -2470,7 +2470,7 @@ package "Keycloak\n[Software System]" {
.Projects/Modules (Keycloak)
[cols="3a,5a", options="header"]
|===
-|Coordinates |Description
+|Coordinates |Description
|Apache Isis Security - Keycloak
[source,yaml]
@@ -2536,7 +2536,7 @@ package "Shiro\n[Software System]" {
.Projects/Modules (Shiro)
[cols="3a,5a", options="header"]
|===
-|Coordinates |Description
+|Coordinates |Description
|Apache Isis Security - Shiro
[source,yaml]
@@ -2601,7 +2601,7 @@ package "Spring\n[Software System]" {
.Projects/Modules (Spring)
[cols="3a,5a", options="header"]
|===
-|Coordinates |Description
+|Coordinates |Description
|Apache Isis Security - Spring
[source,yaml]
@@ -2668,7 +2668,7 @@ package "Common\n[Software System]" {
.Projects/Modules (Common)
[cols="3a,5a", options="header"]
|===
-|Coordinates |Description
+|Coordinates |Description
|Apache Isis Viewer - Common Model
[source,yaml]
@@ -2771,7 +2771,7 @@ package "Restful Objects\n[Software System]" {
.Projects/Modules (Restful Objects)
[cols="3a,5a", options="header"]
|===
-|Coordinates |Description
+|Coordinates |Description
|Apache Isis Viewer - RO
[source,yaml]
@@ -2998,7 +2998,7 @@ package "Wicket\n[Software System]" {
.Projects/Modules (Wicket)
[cols="3a,5a", options="header"]
|===
-|Coordinates |Description
+|Coordinates |Description
|Apache Isis Viewer - Wicket
[source,yaml]
@@ -3196,7 +3196,7 @@ package "Valuetypes\n[Software System]" {
.Projects/Modules (Valuetypes)
[cols="3a,5a", options="header"]
|===
-|Coordinates |Description
+|Coordinates |Description
|Apache Isis Value types
[source,yaml]
@@ -3406,7 +3406,7 @@ package "Asciidoc\n[Software System]" {
.Projects/Modules (Asciidoc)
[cols="3a,5a", options="header"]
|===
-|Coordinates |Description
+|Coordinates |Description
|Apache Isis Val - Asciidoctor (parent)
[source,yaml]
@@ -3652,7 +3652,7 @@ package "Markdown\n[Software System]" {
.Projects/Modules (Markdown)
[cols="3a,5a", options="header"]
|===
-|Coordinates |Description
+|Coordinates |Description
|Apache Isis Val - Markdown (parent)
[source,yaml]
@@ -3859,7 +3859,7 @@ package "SSE\n[Software System]" {
.Projects/Modules (SSE)
[cols="3a,5a", options="header"]
|===
-|Coordinates |Description
+|Coordinates |Description
|Apache Isis Val - Server Sent Events (parent)
[source,yaml]
@@ -4136,7 +4136,7 @@ package "Extensions\n[Software System]" {
.Projects/Modules (Extensions)
[cols="3a,5a", options="header"]
|===
-|Coordinates |Description
+|Coordinates |Description
|Apache Isis Extensions
[source,yaml]
@@ -4677,7 +4677,7 @@ package "Applib: Excel\n[Software System]" {
.Projects/Modules (Applib: Excel)
[cols="3a,5a", options="header"]
|===
-|Coordinates |Description
+|Coordinates |Description
|Apache Isis Ext - Excel (parent)
[source,yaml]
@@ -4862,7 +4862,7 @@ package "Core: Command Log\n[Software System]" {
.Projects/Modules (Core: Command Log)
[cols="3a,5a", options="header"]
|===
-|Coordinates |Description
+|Coordinates |Description
|Apache Isis Ext - Command Log
[source,yaml]
@@ -5002,7 +5002,7 @@ package "Core: Command Replay\n[Software System]" {
.Projects/Modules (Core: Command Replay)
[cols="3a,5a", options="header"]
|===
-|Coordinates |Description
+|Coordinates |Description
|Apache Isis Ext - Command Replay
[source,yaml]
@@ -5121,7 +5121,7 @@ package "Core: Quartz\n[Software System]" {
.Projects/Modules (Core: Quartz)
[cols="3a,5a", options="header"]
|===
-|Coordinates |Description
+|Coordinates |Description
|Apache Isis Ext - Quartz
[source,yaml]
@@ -5245,7 +5245,7 @@ package "Tooling\n[Software System]" {
.Projects/Modules (Tooling)
[cols="3a,5a", options="header"]
|===
-|Coordinates |Description
+|Coordinates |Description
|Apache Isis - Tooling
[source,yaml]
@@ -5547,7 +5547,7 @@ package "Regression Tests\n[Software System]" {
.Projects/Modules (Regression Tests)
[cols="3a,5a", options="header"]
|===
-|Coordinates |Description
+|Coordinates |Description
|Apache Isis - Regression Tests
[source,yaml]
@@ -5862,7 +5862,7 @@ package "Incubator\n[Software System]" {
.Projects/Modules (Incubator)
[cols="3a,5a", options="header"]
|===
-|Coordinates |Description
+|Coordinates |Description
|Apache Isis Incubator
[source,yaml]
@@ -5910,7 +5910,7 @@ package "Kroviz Client\n[Software System]" {
.Projects/Modules (Kroviz Client)
[cols="3a,5a", options="header"]
|===
-|Coordinates |Description
+|Coordinates |Description
|Apache Isis Incubator - Client kroViz
[source,yaml]
@@ -5974,7 +5974,7 @@ package "GraphQL Viewer\n[Software System]" {
.Projects/Modules (GraphQL Viewer)
[cols="3a,5a", options="header"]
|===
-|Coordinates |Description
+|Coordinates |Description
|Apache Isis Inc - Viewer GraphQL
[source,yaml]
@@ -6102,7 +6102,7 @@ package "Vaadin Viewer\n[Software System]" {
.Projects/Modules (Vaadin Viewer)
[cols="3a,5a", options="header"]
|===
-|Coordinates |Description
+|Coordinates |Description
|Apache Isis Inc - Viewer Vaadin
[source,yaml]
@@ -6239,7 +6239,7 @@ package "JavaFX Viewer\n[Software System]" {
.Projects/Modules (JavaFX Viewer)
[cols="3a,5a", options="header"]
|===
-|Coordinates |Description
+|Coordinates |Description
|Apache Isis Inc - Viewer JavaFX
[source,yaml]
diff --git a/mavendeps/adoc/modules/mavendeps/pages/about.adoc b/mavendeps/adoc/modules/mavendeps/pages/about.adoc
index af9670873e..cb45f103f0 100644
--- a/mavendeps/adoc/modules/mavendeps/pages/about.adoc
+++ b/mavendeps/adoc/modules/mavendeps/pages/about.adoc
@@ -1,17 +1,9 @@
-= Aggregator POMs
+= Webapp Aggregator POM
: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 "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-unittests` artifact (rather than have to reference all of JUnit, AssertJ, Spring Boot, Hamcrest, Mockito and so on).
-
-Currently five aggregator POMs are provided.
-
-== Webapp
-
The `isis-mavendeps-webapp` aggregates the main runtime dependencies of a production webapp.
-Note however that it does _not_ include the runtime dependencies for either JDO or JPA; these have their own "mavendeps" POM, discussed xref:#jdo-and-jpa[below].
+Note that it does _not_ include the runtime dependencies for either JDO or JPA; these must be included separately.
To use, add the following :
@@ -33,133 +25,20 @@ For convenience, it includes all of the current components available:
* Apache Isis Core - the xref:refguide:ROOT:about.adoc[Applib] and underlying implementation (xref:core:runtime-services:about.adoc[Runtime Services])
-* Two of the security implementations (xref:security:bypass:about.adoc[Bypass] and xref:security:keycloak:about.adoc[Keycloak])
+* The xref:security:bypass:about.adoc[Bypass] security implementation.
+
-The xref:security:shiro:about.adoc[Shiro] and xref:security:spring:about.adoc[Spring] implementations are omitted, as each of these have additional third-party dependencies.
+Other security implementations (xref:security:shiro:about.adoc[Shiro], xref:security:spring:about.adoc[Spring] and and xref:security:keycloak:about.adoc[Keycloak]) are omitted, as each of these have additional third-party dependencies.
-* All the viewer implementations (xref:vw:ROOT:about.adoc[Wicket], xref:vro:ROOT:about.adoc[Restful Objects])
+* The viewer implementations (xref:vw:ROOT:about.adoc[Wicket], xref:vro:ROOT:about.adoc[Restful Objects])
-// doesn't seem to include these...
-//* All the persistence implementations (xref:pjdo:ROOT:about.adoc[JDO/DataNucleus], xref:pjpa:ROOT:about.adoc[JPA/EclipseLink])
+If you don't need any of these, then use a Maven `<exclusion>`.
-If you don't need any of these (for example, you'll probably only want one security implementation), then you can exclude the others.
+In addition, you will probably need to specify a persistence implementation (xref:pjpa:ROOT:about.adoc[JPA/Eclipselink] or xref:pjdo:ROOT:about.adoc[JDO/DataNucleus]) as well as a security implementation.
Also, remember that adding the class onto the classpath does _not_ make that functionality available (Apache Isis does not currently leverage Spring Boot's link:https://docs.spring.io/spring-boot/docs/current/reference/html/using-spring-boot.html#using-boot-auto-configuration[auto configuration] capabilities).
-So, you must also add in the appropriate `IsisModuleXxx` to your application's top-level link:https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/context/annotation/Configuration.html[@Configuration] (aka "app manifest").
+You must therefore also add in the appropriate `IsisModuleXxx` to your application's top-level link:https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/context/annotation/Configuration.html[@Configuration] (aka "app manifest").
For example, see the xref:docs:starters:simpleapp.adoc#appmanifest[AppManifest for the SimpleApp] starter app.
-== Testing
-
-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]
-.pom.xml
-----
-<dependencies>
- <dependency>
- <groupId>org.apache.isis.mavendeps</groupId>
- <artifactId>isis-mavendeps-unittests</artifactId>
- <type>pom</type>
- <scope>test</scope>
- </dependency>
-</dependencies>
-----
-
-For integration testing, add:
-
-[source,xml]
-.pom.xml
-----
-<dependencies>
- <dependency>
- <groupId>org.apache.isis.mavendeps</groupId>
- <artifactId>isis-mavendeps-integtests</artifactId>
- <type>pom</type>
- <scope>test</scope>
- </dependency>
-</dependencies>
-----
-
-
-The table below summarises the dependencies that each of these aggregator POMs brings in.
-
-.Dependencies of the Aggregator POM for Tests
-[cols="3a,^1a,^1a", options="header"]
-|===
-
-| Dependency
-| mavendeps-
-unittests
-| mavendeps-
-integtests
-
-
-|Apache Isis +
-xref:testing:unittestsupport:about.adoc[unit test support] +
-| Y |
-
-|Apache Isis +
-xref:testing:integtestsupport:about.adoc[integ test support] +
-| | Y
-
-
-| Apache Isis +
-xref:refguide:ROOT:about.adoc[Applib]
-| Y | Y
-
-| Apache Isis +
-xref:security:bypass:about.adoc[Bypass] security
-| | Y
-
-| Apache Isis +
-xref:testing:fakedata:about.adoc[Fake Data]
-| Y | Y
-
-|Apache Isis +
-xref:testing:fixtures:about.adoc[Fixture Scripts]
-| | Y
-
-| link:https://junit.org/junit5/docs/current/user-guide/[JUnit 5 "jupiter"]
-| Y | Y
-
-| link:https://junit.org/junit5/docs/current/user-guide/#migrating-from-junit4[JUnit 5 "vintage"]
-| Y |
-
-| link:https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-testing[Spring Boot Test]
-| Y | Y
-
-| link:http://hamcrest.org/JavaHamcrest/[Hamcrest] (core + library)
-| Y | Y
-
-| link:https://joel-costigliola.github.io/assertj/[AssertJ]
-| Y | Y
-
-| link:https://site.mockito.org/[Mockito]
-| Y | Y
-
-| link:http://jmock.org/[JMock]
-| Y |
-
-| link:https://github.com/approvals/ApprovalTests.Java[Approval tests]
-| Y | Y
-
-| link:http://picocontainer.com/[PicoContainer] +
-(for JMock2 extensions)
-| Y |
-
-| link:https://github.com/google/guava/wiki[Google's Guava]
-| Y |
-
-| link:http://hsqldb.org[HSQLDB]
-| | Y
-
-| link:https://www.h2database.com[H2 Database]
-| | Y
-
-|===
-
diff --git a/starters/adoc/modules/parent-pom/attachments/parent-pom.pptx b/starters/adoc/modules/parent-pom/attachments/parent-pom.pptx
index 75c6453c5e..eff9f26892 100644
Binary files a/starters/adoc/modules/parent-pom/attachments/parent-pom.pptx and b/starters/adoc/modules/parent-pom/attachments/parent-pom.pptx differ