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/29 16:12:47 UTC
[isis] 03/04: ISIS-2062: docs
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch ISIS-2062
in repository https://gitbox.apache.org/repos/asf/isis.git
commit 708602420b4f60901e981c29ca6205b488e10bb9
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Wed Jan 29 15:55:23 2020 +0000
ISIS-2062: docs
---
antora/playbooks/site-extensions.yml | 7 +++++--
antora/playbooks/site.yml | 7 ++++---
.../components/extensions => extensions/adoc}/antora.yml | 0
.../extensions => extensions/adoc}/modules/ROOT/nav.adoc | 0
.../adoc}/modules/ROOT/pages/about.adoc | 0
.../adoc}/modules/ROOT/partials/component-nav.adoc | 0
.../adoc}/modules/ROOT/partials/module-nav.adoc | 0
testing/adoc/modules/ROOT/pages/about.adoc | 11 +----------
testing/fakedata/adoc/modules/fakedata/pages/about.adoc | 3 +--
testing/fakedata/adoc/modules/fakedata/partials/intro.adoc | 13 +++++++++++++
testing/fixtures/adoc/modules/fixtures/pages/about.adoc | 4 ----
.../fixtures/pages/fixture-scripts/api-and-usage.adoc | 1 -
.../fixtures/pages/fixture-scripts/sudo-service.adoc | 1 -
.../pages/fixture-scripts/ticking-clock-fixture.adoc | 1 -
14 files changed, 24 insertions(+), 24 deletions(-)
diff --git a/antora/playbooks/site-extensions.yml b/antora/playbooks/site-extensions.yml
index 4d74620..7c35b3a 100644
--- a/antora/playbooks/site-extensions.yml
+++ b/antora/playbooks/site-extensions.yml
@@ -11,11 +11,11 @@ content:
start_path: antora/components/toc # toc
branches: HEAD
+# extensions
- url: .
- start_path: antora/components/extensions # extensions
+ start_path: extensions/adoc # extensions
branches: HEAD
-# extensions
- url: .
start_path: extensions/persistence/jdo/flywayjdo/adoc # extensions
branches: HEAD
@@ -34,6 +34,9 @@ content:
start_path: extensions/vw/exceldownload/adoc # vw
branches: HEAD
- url: .
+ start_path: extensions/vw/fullcalendar/adoc # vw
+ branches: HEAD
+ - url: .
start_path: extensions/vw/pdfjs/adoc # vw
branches: HEAD
diff --git a/antora/playbooks/site.yml b/antora/playbooks/site.yml
index 130870e..b4ca06c 100644
--- a/antora/playbooks/site.yml
+++ b/antora/playbooks/site.yml
@@ -15,9 +15,6 @@ content:
start_path: antora/components/core # core
branches: HEAD
- url: .
- start_path: antora/components/extensions # extensions
- branches: HEAD
- - url: .
start_path: antora/components/incubator # incubator
branches: HEAD
- url: .
@@ -101,6 +98,10 @@ content:
# extensions
- url: .
+ start_path: extensions/adoc # extensions
+ branches: HEAD
+
+ - url: .
start_path: extensions/core/flyway/adoc # userguide
branches: HEAD
diff --git a/antora/components/extensions/antora.yml b/extensions/adoc/antora.yml
similarity index 100%
rename from antora/components/extensions/antora.yml
rename to extensions/adoc/antora.yml
diff --git a/antora/components/extensions/modules/ROOT/nav.adoc b/extensions/adoc/modules/ROOT/nav.adoc
similarity index 100%
rename from antora/components/extensions/modules/ROOT/nav.adoc
rename to extensions/adoc/modules/ROOT/nav.adoc
diff --git a/antora/components/extensions/modules/ROOT/pages/about.adoc b/extensions/adoc/modules/ROOT/pages/about.adoc
similarity index 100%
rename from antora/components/extensions/modules/ROOT/pages/about.adoc
rename to extensions/adoc/modules/ROOT/pages/about.adoc
diff --git a/antora/components/extensions/modules/ROOT/partials/component-nav.adoc b/extensions/adoc/modules/ROOT/partials/component-nav.adoc
similarity index 100%
rename from antora/components/extensions/modules/ROOT/partials/component-nav.adoc
rename to extensions/adoc/modules/ROOT/partials/component-nav.adoc
diff --git a/antora/components/extensions/modules/ROOT/partials/module-nav.adoc b/extensions/adoc/modules/ROOT/partials/module-nav.adoc
similarity index 100%
rename from antora/components/extensions/modules/ROOT/partials/module-nav.adoc
rename to extensions/adoc/modules/ROOT/partials/module-nav.adoc
diff --git a/testing/adoc/modules/ROOT/pages/about.adoc b/testing/adoc/modules/ROOT/pages/about.adoc
index 3546bc3..e7be180 100644
--- a/testing/adoc/modules/ROOT/pages/about.adoc
+++ b/testing/adoc/modules/ROOT/pages/about.adoc
@@ -129,16 +129,7 @@ This defines a pattern (command pattern and composite pattern) with supporting c
== Fake data
-In any given test there are often quite a few variables involved, to initialize the state of the objects, or to act as arguments for invoking a method, or when asserting on post-conditions.
-Sometimes those values are important (eg verifying that an ``Order``'s state went from PENDING to SHIPPED, say), but often they aren't (a customer's name, for example).
-Nevertheless all this data may need to be set up, especially in integration tests.
-
-We want our tests to be easily understood, and we want the reader's eye to be drawn to the values that are significant and ignore those that are not.
-
-One way to do this is to use random (or fake) values for any insignificant data.
-This in effect tells the reader that "any value will do".
-Moreover, if it turns out that any data won't do, and that there's some behaviour that is sensitive to the value, then the test will start to flicker, passing and then failing depending on inputs.
-This is A Good Thing™.
+include::testing:fakedata:partial$intro.adoc[]
Apache Isis provides the link:testing:fakedata:about.adoc[Fake Data] library to assist with this.
diff --git a/testing/fakedata/adoc/modules/fakedata/pages/about.adoc b/testing/fakedata/adoc/modules/fakedata/pages/about.adoc
index 7c761a5..3306169 100644
--- a/testing/fakedata/adoc/modules/fakedata/pages/about.adoc
+++ b/testing/fakedata/adoc/modules/fakedata/pages/about.adoc
@@ -1,5 +1,4 @@
= Fakedata
: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 [...]
-TODO
-
+include::partial$intro.adoc[]
diff --git a/testing/fakedata/adoc/modules/fakedata/partials/intro.adoc b/testing/fakedata/adoc/modules/fakedata/partials/intro.adoc
new file mode 100644
index 0000000..38d484d
--- /dev/null
+++ b/testing/fakedata/adoc/modules/fakedata/partials/intro.adoc
@@ -0,0 +1,13 @@
+: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 [...]
+:partial-page:
+
+In any given test there are often quite a few variables involved, to initialize the state of the objects, or to act as arguments for invoking a method, or when asserting on post-conditions.
+Sometimes those values are important (eg verifying that an ``Order``'s state went from PENDING to SHIPPED, say), but often they aren't (a customer's name, for example).
+Nevertheless all this data may need to be set up, especially in integration tests.
+
+We want our tests to be easily understood, and we want the reader's eye to be drawn to the values that are significant and ignore those that are not.
+
+One way to do this is to use random (or fake) values for any insignificant data.
+This in effect tells the reader that "any value will do".
+Moreover, if it turns out that any data won't do, and that there's some behaviour that is sensitive to the value, then the test will start to flicker, passing and then failing depending on inputs.
+This is A Good Thing™.
diff --git a/testing/fixtures/adoc/modules/fixtures/pages/about.adoc b/testing/fixtures/adoc/modules/fixtures/pages/about.adoc
index 60b925f..7e44470 100644
--- a/testing/fixtures/adoc/modules/fixtures/pages/about.adoc
+++ b/testing/fixtures/adoc/modules/fixtures/pages/about.adoc
@@ -15,10 +15,6 @@ The solution that Apache Isis provides is a small library called *_fixture scrip
A fixture script is basically a command object for executing arbitrary work, where the work in question is almost always invoking one or more business actions.
In other words, the database is populating through the functionality of the domain object model itself.
-[TIP]
-====
-If you want to learn more on this topic (with live coding!), check out this https://skillsmatter.com/skillscasts/5638-to-those-whom-much-is-given-much-is-expected[presentation] given at BDD Exchange 2014.
-====
There is another benefit to Apache Isis' fixture script approach; the fixtures can be (in prototyping mode) run from your application.
This means that fixture scripts can actually help all the way through the development lifecycle:
diff --git a/testing/fixtures/adoc/modules/fixtures/pages/fixture-scripts/api-and-usage.adoc b/testing/fixtures/adoc/modules/fixtures/pages/fixture-scripts/api-and-usage.adoc
index d81b640..2ec15f2 100644
--- a/testing/fixtures/adoc/modules/fixtures/pages/fixture-scripts/api-and-usage.adoc
+++ b/testing/fixtures/adoc/modules/fixtures/pages/fixture-scripts/api-and-usage.adoc
@@ -1,4 +1,3 @@
-[[api-and-usage]]
= API and Usage
: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 [...]
diff --git a/testing/fixtures/adoc/modules/fixtures/pages/fixture-scripts/sudo-service.adoc b/testing/fixtures/adoc/modules/fixtures/pages/fixture-scripts/sudo-service.adoc
index acf8831..a0ee7be 100644
--- a/testing/fixtures/adoc/modules/fixtures/pages/fixture-scripts/sudo-service.adoc
+++ b/testing/fixtures/adoc/modules/fixtures/pages/fixture-scripts/sudo-service.adoc
@@ -1,4 +1,3 @@
-[[sudo-service]]
= `SudoService`
: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 [...]
diff --git a/testing/fixtures/adoc/modules/fixtures/pages/fixture-scripts/ticking-clock-fixture.adoc b/testing/fixtures/adoc/modules/fixtures/pages/fixture-scripts/ticking-clock-fixture.adoc
index 5f312fc..00040ed 100644
--- a/testing/fixtures/adoc/modules/fixtures/pages/fixture-scripts/ticking-clock-fixture.adoc
+++ b/testing/fixtures/adoc/modules/fixtures/pages/fixture-scripts/ticking-clock-fixture.adoc
@@ -1,4 +1,3 @@
-[[ticking-clock-fixture]]
= Ticking Clock Fixture
: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 [...]