From b9711ac3eecd3d5be3d36899f96ede1577be4475 Mon Sep 17 00:00:00 2001 From: David Whitlock Date: Sat, 24 Jun 2017 11:04:34 -0700 Subject: [PATCH 1/3] Address #175 by configuring the Javadoc Maven plugin to generate documentation for all members regardless of their visibility. --- gwt-parent/gwt-originals-parent/airline-gwt/pom.xml | 1 + gwt-parent/gwt-originals-parent/apptbook-gwt/pom.xml | 1 + gwt-parent/gwt-originals-parent/phonebill-gwt/pom.xml | 1 + .../src/main/resources/archetype-resources/pom.xml | 1 + .../src/main/resources/archetype-resources/pom.xml | 1 + .../src/main/resources/archetype-resources/pom.xml | 1 + .../src/main/resources/archetype-resources/pom.xml | 1 + .../src/main/resources/archetype-resources/pom.xml | 1 + .../src/main/resources/archetype-resources/pom.xml | 1 + .../src/main/resources/archetype-resources/pom.xml | 1 + .../src/main/resources/archetype-resources/pom.xml | 1 + projects-parent/originals-parent/airline-web/pom.xml | 1 + projects-parent/originals-parent/airline/pom.xml | 1 + projects-parent/originals-parent/apptbook-web/pom.xml | 1 + projects-parent/originals-parent/phonebill-web/pom.xml | 1 + projects-parent/originals-parent/phonebill/pom.xml | 1 + 16 files changed, 16 insertions(+) diff --git a/gwt-parent/gwt-originals-parent/airline-gwt/pom.xml b/gwt-parent/gwt-originals-parent/airline-gwt/pom.xml index d47b20b44..4a38bd203 100644 --- a/gwt-parent/gwt-originals-parent/airline-gwt/pom.xml +++ b/gwt-parent/gwt-originals-parent/airline-gwt/pom.xml @@ -198,6 +198,7 @@ Summer2017 false + private diff --git a/gwt-parent/gwt-originals-parent/apptbook-gwt/pom.xml b/gwt-parent/gwt-originals-parent/apptbook-gwt/pom.xml index 322896514..e65b685f4 100644 --- a/gwt-parent/gwt-originals-parent/apptbook-gwt/pom.xml +++ b/gwt-parent/gwt-originals-parent/apptbook-gwt/pom.xml @@ -199,6 +199,7 @@ Summer2017 false + private diff --git a/gwt-parent/gwt-originals-parent/phonebill-gwt/pom.xml b/gwt-parent/gwt-originals-parent/phonebill-gwt/pom.xml index e6e5b6752..ff6cf9d5b 100644 --- a/gwt-parent/gwt-originals-parent/phonebill-gwt/pom.xml +++ b/gwt-parent/gwt-originals-parent/phonebill-gwt/pom.xml @@ -198,6 +198,7 @@ Summer2017 false + private diff --git a/projects-parent/archetypes-parent/airline-archetype/src/main/resources/archetype-resources/pom.xml b/projects-parent/archetypes-parent/airline-archetype/src/main/resources/archetype-resources/pom.xml index 0e777c976..a4dd1bb97 100644 --- a/projects-parent/archetypes-parent/airline-archetype/src/main/resources/archetype-resources/pom.xml +++ b/projects-parent/archetypes-parent/airline-archetype/src/main/resources/archetype-resources/pom.xml @@ -141,6 +141,7 @@ Summer2017 false + private diff --git a/projects-parent/archetypes-parent/airline-gwt-archetype/src/main/resources/archetype-resources/pom.xml b/projects-parent/archetypes-parent/airline-gwt-archetype/src/main/resources/archetype-resources/pom.xml index a631296dd..b47baf8a3 100644 --- a/projects-parent/archetypes-parent/airline-gwt-archetype/src/main/resources/archetype-resources/pom.xml +++ b/projects-parent/archetypes-parent/airline-gwt-archetype/src/main/resources/archetype-resources/pom.xml @@ -197,6 +197,7 @@ Summer2017 false + private diff --git a/projects-parent/archetypes-parent/airline-web-archetype/src/main/resources/archetype-resources/pom.xml b/projects-parent/archetypes-parent/airline-web-archetype/src/main/resources/archetype-resources/pom.xml index 9f441abb7..377750c63 100644 --- a/projects-parent/archetypes-parent/airline-web-archetype/src/main/resources/archetype-resources/pom.xml +++ b/projects-parent/archetypes-parent/airline-web-archetype/src/main/resources/archetype-resources/pom.xml @@ -202,6 +202,7 @@ Summer2017 false + private diff --git a/projects-parent/archetypes-parent/apptbook-gwt-archetype/src/main/resources/archetype-resources/pom.xml b/projects-parent/archetypes-parent/apptbook-gwt-archetype/src/main/resources/archetype-resources/pom.xml index db1d3be99..f70e445d4 100644 --- a/projects-parent/archetypes-parent/apptbook-gwt-archetype/src/main/resources/archetype-resources/pom.xml +++ b/projects-parent/archetypes-parent/apptbook-gwt-archetype/src/main/resources/archetype-resources/pom.xml @@ -211,6 +211,7 @@ Summer2017 false + private diff --git a/projects-parent/archetypes-parent/apptbook-web-archetype/src/main/resources/archetype-resources/pom.xml b/projects-parent/archetypes-parent/apptbook-web-archetype/src/main/resources/archetype-resources/pom.xml index f0b098942..6174fd4f1 100644 --- a/projects-parent/archetypes-parent/apptbook-web-archetype/src/main/resources/archetype-resources/pom.xml +++ b/projects-parent/archetypes-parent/apptbook-web-archetype/src/main/resources/archetype-resources/pom.xml @@ -202,6 +202,7 @@ Summer2017 false + private diff --git a/projects-parent/archetypes-parent/phonebill-archetype/src/main/resources/archetype-resources/pom.xml b/projects-parent/archetypes-parent/phonebill-archetype/src/main/resources/archetype-resources/pom.xml index 720e610e9..8ea3888c1 100644 --- a/projects-parent/archetypes-parent/phonebill-archetype/src/main/resources/archetype-resources/pom.xml +++ b/projects-parent/archetypes-parent/phonebill-archetype/src/main/resources/archetype-resources/pom.xml @@ -136,6 +136,7 @@ Summer2017 false + private diff --git a/projects-parent/archetypes-parent/phonebill-gwt-archetype/src/main/resources/archetype-resources/pom.xml b/projects-parent/archetypes-parent/phonebill-gwt-archetype/src/main/resources/archetype-resources/pom.xml index 16d912de3..6e47deb21 100644 --- a/projects-parent/archetypes-parent/phonebill-gwt-archetype/src/main/resources/archetype-resources/pom.xml +++ b/projects-parent/archetypes-parent/phonebill-gwt-archetype/src/main/resources/archetype-resources/pom.xml @@ -198,6 +198,7 @@ Summer2017 false + private diff --git a/projects-parent/archetypes-parent/phonebill-web-archetype/src/main/resources/archetype-resources/pom.xml b/projects-parent/archetypes-parent/phonebill-web-archetype/src/main/resources/archetype-resources/pom.xml index 076b81829..24f78fe34 100644 --- a/projects-parent/archetypes-parent/phonebill-web-archetype/src/main/resources/archetype-resources/pom.xml +++ b/projects-parent/archetypes-parent/phonebill-web-archetype/src/main/resources/archetype-resources/pom.xml @@ -203,6 +203,7 @@ Summer2017 false + private diff --git a/projects-parent/originals-parent/airline-web/pom.xml b/projects-parent/originals-parent/airline-web/pom.xml index bac403000..766b51c2c 100644 --- a/projects-parent/originals-parent/airline-web/pom.xml +++ b/projects-parent/originals-parent/airline-web/pom.xml @@ -203,6 +203,7 @@ Summer2017 false + private diff --git a/projects-parent/originals-parent/airline/pom.xml b/projects-parent/originals-parent/airline/pom.xml index 6fc440595..88d94abf0 100644 --- a/projects-parent/originals-parent/airline/pom.xml +++ b/projects-parent/originals-parent/airline/pom.xml @@ -140,6 +140,7 @@ Summer2017 false + private diff --git a/projects-parent/originals-parent/apptbook-web/pom.xml b/projects-parent/originals-parent/apptbook-web/pom.xml index 650fbf038..96837ef24 100644 --- a/projects-parent/originals-parent/apptbook-web/pom.xml +++ b/projects-parent/originals-parent/apptbook-web/pom.xml @@ -201,6 +201,7 @@ Summer2017 false + private diff --git a/projects-parent/originals-parent/phonebill-web/pom.xml b/projects-parent/originals-parent/phonebill-web/pom.xml index 593ecba8f..7cec3fe19 100644 --- a/projects-parent/originals-parent/phonebill-web/pom.xml +++ b/projects-parent/originals-parent/phonebill-web/pom.xml @@ -201,6 +201,7 @@ Summer2017 false + private diff --git a/projects-parent/originals-parent/phonebill/pom.xml b/projects-parent/originals-parent/phonebill/pom.xml index f27bd40cd..7f9080626 100644 --- a/projects-parent/originals-parent/phonebill/pom.xml +++ b/projects-parent/originals-parent/phonebill/pom.xml @@ -135,6 +135,7 @@ Summer2017 false + private From 28d5ce797093c84350be66aa5be46e30ac1d2f26 Mon Sep 17 00:00:00 2001 From: David Whitlock Date: Sat, 24 Jun 2017 12:19:10 -0700 Subject: [PATCH 2/3] Add an integration test for the PhoneBill project archetype that verifies that the JavaDoc is generated when the project is graded. --- .../src/main/resources/archetype-resources/pom.xml | 3 +++ .../resources/projects/javadoc/archetype.properties | 5 +++++ .../src/test/resources/projects/javadoc/goal.txt | 1 + .../src/test/resources/projects/javadoc/verify.groovy | 11 +++++++++++ 4 files changed, 20 insertions(+) create mode 100644 projects-parent/archetypes-parent/phonebill-archetype/src/test/resources/projects/javadoc/archetype.properties create mode 100644 projects-parent/archetypes-parent/phonebill-archetype/src/test/resources/projects/javadoc/goal.txt create mode 100644 projects-parent/archetypes-parent/phonebill-archetype/src/test/resources/projects/javadoc/verify.groovy diff --git a/projects-parent/archetypes-parent/phonebill-archetype/src/main/resources/archetype-resources/pom.xml b/projects-parent/archetypes-parent/phonebill-archetype/src/main/resources/archetype-resources/pom.xml index 8ea3888c1..cf65cc3af 100644 --- a/projects-parent/archetypes-parent/phonebill-archetype/src/main/resources/archetype-resources/pom.xml +++ b/projects-parent/archetypes-parent/phonebill-archetype/src/main/resources/archetype-resources/pom.xml @@ -122,6 +122,9 @@ grader + + ${grader} + diff --git a/projects-parent/archetypes-parent/phonebill-archetype/src/test/resources/projects/javadoc/archetype.properties b/projects-parent/archetypes-parent/phonebill-archetype/src/test/resources/projects/javadoc/archetype.properties new file mode 100644 index 000000000..f9cc500b7 --- /dev/null +++ b/projects-parent/archetypes-parent/phonebill-archetype/src/test/resources/projects/javadoc/archetype.properties @@ -0,0 +1,5 @@ +package=it.pkg.javadoc +version=0.1-SNAPSHOT +groupId=javadoc.archetype.it +artifactId=javadoc +grader=true diff --git a/projects-parent/archetypes-parent/phonebill-archetype/src/test/resources/projects/javadoc/goal.txt b/projects-parent/archetypes-parent/phonebill-archetype/src/test/resources/projects/javadoc/goal.txt new file mode 100644 index 000000000..780912245 --- /dev/null +++ b/projects-parent/archetypes-parent/phonebill-archetype/src/test/resources/projects/javadoc/goal.txt @@ -0,0 +1 @@ +javadoc:javadoc \ No newline at end of file diff --git a/projects-parent/archetypes-parent/phonebill-archetype/src/test/resources/projects/javadoc/verify.groovy b/projects-parent/archetypes-parent/phonebill-archetype/src/test/resources/projects/javadoc/verify.groovy new file mode 100644 index 000000000..91326382e --- /dev/null +++ b/projects-parent/archetypes-parent/phonebill-archetype/src/test/resources/projects/javadoc/verify.groovy @@ -0,0 +1,11 @@ +File buildLog = new File(basedir, "project/javadoc/build.log"); +if (!buildLog.isFile()) { + throw new FileNotFoundException("Couldn't find build log: " + buildLog) +} + +String logText = buildLog.text + +def expectedJavaDoc = "The main class for the CS410J Phone Bill Project" +if (!logText.contains(expectedJavaDoc)) { + throw new IllegalStateException("Didn't find expected JavaDoc: " + expectedJavaDoc) +} From 292833814caa262853a84687567d66dfcb2cce87 Mon Sep 17 00:00:00 2001 From: David Whitlock Date: Sat, 24 Jun 2017 17:06:40 -0700 Subject: [PATCH 3/3] Continue to address issue #175 by adding archetype integration tests that make sure that the Grader javadoc is generated as expected. --- .../gwt-originals-parent/airline-gwt/pom.xml | 3 ++ .../gwt-originals-parent/apptbook-gwt/pom.xml | 3 ++ .../phonebill-gwt/pom.xml | 3 ++ .../resources/archetype-resources/pom.xml | 3 ++ .../projects/javadoc/archetype.properties | 5 ++++ .../test/resources/projects/javadoc/goal.txt | 1 + .../resources/projects/javadoc/verify.groovy | 11 +++++++ .../resources/archetype-resources/pom.xml | 3 ++ .../projects/javadoc/archetype.properties | 5 ++++ .../test/resources/projects/javadoc/goal.txt | 1 + .../resources/projects/javadoc/verify.groovy | 11 +++++++ .../resources/archetype-resources/pom.xml | 3 ++ .../projects/javadoc/archetype.properties | 5 ++++ .../test/resources/projects/javadoc/goal.txt | 1 + .../resources/projects/javadoc/verify.groovy | 11 +++++++ .../resources/archetype-resources/pom.xml | 3 ++ .../projects/javadoc/archetype.properties | 5 ++++ .../test/resources/projects/javadoc/goal.txt | 1 + .../resources/projects/javadoc/verify.groovy | 13 +++++++++ .../resources/archetype-resources/pom.xml | 3 ++ .../projects/javadoc/archetype.properties | 5 ++++ .../test/resources/projects/javadoc/goal.txt | 1 + .../resources/projects/javadoc/verify.groovy | 11 +++++++ .../resources/archetype-resources/pom.xml | 3 ++ .../projects/javadoc/archetype.properties | 5 ++++ .../test/resources/projects/javadoc/goal.txt | 1 + .../resources/projects/javadoc/verify.groovy | 11 +++++++ .../resources/archetype-resources/pom.xml | 3 ++ .../projects/javadoc/archetype.properties | 5 ++++ .../test/resources/projects/javadoc/goal.txt | 1 + .../resources/projects/javadoc/verify.groovy | 11 +++++++ .../resources/archetype-resources/pom.xml | 3 ++ .../projects/javadoc/archetype.properties | 5 ++++ .../test/resources/projects/javadoc/goal.txt | 1 + .../resources/projects/javadoc/verify.groovy | 11 +++++++ .../resources/archetype-resources/pom.xml | 29 +++++++++++++++++++ .../projects/javadoc/archetype.properties | 5 ++++ .../test/resources/projects/javadoc/goal.txt | 1 + .../resources/projects/javadoc/verify.groovy | 11 +++++++ .../originals-parent/airline-web/pom.xml | 3 ++ .../originals-parent/airline/pom.xml | 3 ++ .../originals-parent/apptbook-web/pom.xml | 3 ++ .../originals-parent/apptbook/pom.xml | 3 ++ .../originals-parent/phonebill-web/pom.xml | 3 ++ .../originals-parent/phonebill/pom.xml | 3 ++ .../originals-parent/student/pom.xml | 29 +++++++++++++++++++ 46 files changed, 264 insertions(+) create mode 100644 projects-parent/archetypes-parent/airline-archetype/src/test/resources/projects/javadoc/archetype.properties create mode 100644 projects-parent/archetypes-parent/airline-archetype/src/test/resources/projects/javadoc/goal.txt create mode 100644 projects-parent/archetypes-parent/airline-archetype/src/test/resources/projects/javadoc/verify.groovy create mode 100644 projects-parent/archetypes-parent/airline-gwt-archetype/src/test/resources/projects/javadoc/archetype.properties create mode 100644 projects-parent/archetypes-parent/airline-gwt-archetype/src/test/resources/projects/javadoc/goal.txt create mode 100644 projects-parent/archetypes-parent/airline-gwt-archetype/src/test/resources/projects/javadoc/verify.groovy create mode 100644 projects-parent/archetypes-parent/airline-web-archetype/src/test/resources/projects/javadoc/archetype.properties create mode 100644 projects-parent/archetypes-parent/airline-web-archetype/src/test/resources/projects/javadoc/goal.txt create mode 100644 projects-parent/archetypes-parent/airline-web-archetype/src/test/resources/projects/javadoc/verify.groovy create mode 100644 projects-parent/archetypes-parent/apptbook-archetype/src/test/resources/projects/javadoc/archetype.properties create mode 100644 projects-parent/archetypes-parent/apptbook-archetype/src/test/resources/projects/javadoc/goal.txt create mode 100644 projects-parent/archetypes-parent/apptbook-archetype/src/test/resources/projects/javadoc/verify.groovy create mode 100644 projects-parent/archetypes-parent/apptbook-gwt-archetype/src/test/resources/projects/javadoc/archetype.properties create mode 100644 projects-parent/archetypes-parent/apptbook-gwt-archetype/src/test/resources/projects/javadoc/goal.txt create mode 100644 projects-parent/archetypes-parent/apptbook-gwt-archetype/src/test/resources/projects/javadoc/verify.groovy create mode 100644 projects-parent/archetypes-parent/apptbook-web-archetype/src/test/resources/projects/javadoc/archetype.properties create mode 100644 projects-parent/archetypes-parent/apptbook-web-archetype/src/test/resources/projects/javadoc/goal.txt create mode 100644 projects-parent/archetypes-parent/apptbook-web-archetype/src/test/resources/projects/javadoc/verify.groovy create mode 100644 projects-parent/archetypes-parent/phonebill-gwt-archetype/src/test/resources/projects/javadoc/archetype.properties create mode 100644 projects-parent/archetypes-parent/phonebill-gwt-archetype/src/test/resources/projects/javadoc/goal.txt create mode 100644 projects-parent/archetypes-parent/phonebill-gwt-archetype/src/test/resources/projects/javadoc/verify.groovy create mode 100644 projects-parent/archetypes-parent/phonebill-web-archetype/src/test/resources/projects/javadoc/archetype.properties create mode 100644 projects-parent/archetypes-parent/phonebill-web-archetype/src/test/resources/projects/javadoc/goal.txt create mode 100644 projects-parent/archetypes-parent/phonebill-web-archetype/src/test/resources/projects/javadoc/verify.groovy create mode 100644 projects-parent/archetypes-parent/student-archetype/src/test/resources/projects/javadoc/archetype.properties create mode 100644 projects-parent/archetypes-parent/student-archetype/src/test/resources/projects/javadoc/goal.txt create mode 100644 projects-parent/archetypes-parent/student-archetype/src/test/resources/projects/javadoc/verify.groovy diff --git a/gwt-parent/gwt-originals-parent/airline-gwt/pom.xml b/gwt-parent/gwt-originals-parent/airline-gwt/pom.xml index 4a38bd203..1cadb517f 100644 --- a/gwt-parent/gwt-originals-parent/airline-gwt/pom.xml +++ b/gwt-parent/gwt-originals-parent/airline-gwt/pom.xml @@ -184,6 +184,9 @@ grader + + ${grader} + diff --git a/gwt-parent/gwt-originals-parent/apptbook-gwt/pom.xml b/gwt-parent/gwt-originals-parent/apptbook-gwt/pom.xml index e65b685f4..a9fbb16e4 100644 --- a/gwt-parent/gwt-originals-parent/apptbook-gwt/pom.xml +++ b/gwt-parent/gwt-originals-parent/apptbook-gwt/pom.xml @@ -185,6 +185,9 @@ grader + + ${grader} + diff --git a/gwt-parent/gwt-originals-parent/phonebill-gwt/pom.xml b/gwt-parent/gwt-originals-parent/phonebill-gwt/pom.xml index ff6cf9d5b..07c71a891 100644 --- a/gwt-parent/gwt-originals-parent/phonebill-gwt/pom.xml +++ b/gwt-parent/gwt-originals-parent/phonebill-gwt/pom.xml @@ -184,6 +184,9 @@ grader + + ${grader} + diff --git a/projects-parent/archetypes-parent/airline-archetype/src/main/resources/archetype-resources/pom.xml b/projects-parent/archetypes-parent/airline-archetype/src/main/resources/archetype-resources/pom.xml index a4dd1bb97..9f9c68d3b 100644 --- a/projects-parent/archetypes-parent/airline-archetype/src/main/resources/archetype-resources/pom.xml +++ b/projects-parent/archetypes-parent/airline-archetype/src/main/resources/archetype-resources/pom.xml @@ -127,6 +127,9 @@ grader + + ${grader} + diff --git a/projects-parent/archetypes-parent/airline-archetype/src/test/resources/projects/javadoc/archetype.properties b/projects-parent/archetypes-parent/airline-archetype/src/test/resources/projects/javadoc/archetype.properties new file mode 100644 index 000000000..f9cc500b7 --- /dev/null +++ b/projects-parent/archetypes-parent/airline-archetype/src/test/resources/projects/javadoc/archetype.properties @@ -0,0 +1,5 @@ +package=it.pkg.javadoc +version=0.1-SNAPSHOT +groupId=javadoc.archetype.it +artifactId=javadoc +grader=true diff --git a/projects-parent/archetypes-parent/airline-archetype/src/test/resources/projects/javadoc/goal.txt b/projects-parent/archetypes-parent/airline-archetype/src/test/resources/projects/javadoc/goal.txt new file mode 100644 index 000000000..780912245 --- /dev/null +++ b/projects-parent/archetypes-parent/airline-archetype/src/test/resources/projects/javadoc/goal.txt @@ -0,0 +1 @@ +javadoc:javadoc \ No newline at end of file diff --git a/projects-parent/archetypes-parent/airline-archetype/src/test/resources/projects/javadoc/verify.groovy b/projects-parent/archetypes-parent/airline-archetype/src/test/resources/projects/javadoc/verify.groovy new file mode 100644 index 000000000..8734fe4f7 --- /dev/null +++ b/projects-parent/archetypes-parent/airline-archetype/src/test/resources/projects/javadoc/verify.groovy @@ -0,0 +1,11 @@ +File buildLog = new File(basedir, "project/javadoc/build.log"); +if (!buildLog.isFile()) { + throw new FileNotFoundException("Couldn't find build log: " + buildLog) +} + +String logText = buildLog.text + +def expectedJavaDoc = "The main class for the CS410J airline Project" +if (!logText.contains(expectedJavaDoc)) { + throw new IllegalStateException("Didn't find expected JavaDoc: " + expectedJavaDoc) +} diff --git a/projects-parent/archetypes-parent/airline-gwt-archetype/src/main/resources/archetype-resources/pom.xml b/projects-parent/archetypes-parent/airline-gwt-archetype/src/main/resources/archetype-resources/pom.xml index b47baf8a3..33f427eaa 100644 --- a/projects-parent/archetypes-parent/airline-gwt-archetype/src/main/resources/archetype-resources/pom.xml +++ b/projects-parent/archetypes-parent/airline-gwt-archetype/src/main/resources/archetype-resources/pom.xml @@ -183,6 +183,9 @@ grader + + ${grader} + diff --git a/projects-parent/archetypes-parent/airline-gwt-archetype/src/test/resources/projects/javadoc/archetype.properties b/projects-parent/archetypes-parent/airline-gwt-archetype/src/test/resources/projects/javadoc/archetype.properties new file mode 100644 index 000000000..f9cc500b7 --- /dev/null +++ b/projects-parent/archetypes-parent/airline-gwt-archetype/src/test/resources/projects/javadoc/archetype.properties @@ -0,0 +1,5 @@ +package=it.pkg.javadoc +version=0.1-SNAPSHOT +groupId=javadoc.archetype.it +artifactId=javadoc +grader=true diff --git a/projects-parent/archetypes-parent/airline-gwt-archetype/src/test/resources/projects/javadoc/goal.txt b/projects-parent/archetypes-parent/airline-gwt-archetype/src/test/resources/projects/javadoc/goal.txt new file mode 100644 index 000000000..780912245 --- /dev/null +++ b/projects-parent/archetypes-parent/airline-gwt-archetype/src/test/resources/projects/javadoc/goal.txt @@ -0,0 +1 @@ +javadoc:javadoc \ No newline at end of file diff --git a/projects-parent/archetypes-parent/airline-gwt-archetype/src/test/resources/projects/javadoc/verify.groovy b/projects-parent/archetypes-parent/airline-gwt-archetype/src/test/resources/projects/javadoc/verify.groovy new file mode 100644 index 000000000..418caaf7e --- /dev/null +++ b/projects-parent/archetypes-parent/airline-gwt-archetype/src/test/resources/projects/javadoc/verify.groovy @@ -0,0 +1,11 @@ +File buildLog = new File(basedir, "project/javadoc/build.log"); +if (!buildLog.isFile()) { + throw new FileNotFoundException("Couldn't find build log: " + buildLog) +} + +String logText = buildLog.text + +def expectedJavaDoc = "A basic GWT class that makes sure that we can send an airline back" +if (!logText.contains(expectedJavaDoc)) { + throw new IllegalStateException("Didn't find expected JavaDoc: " + expectedJavaDoc) +} diff --git a/projects-parent/archetypes-parent/airline-web-archetype/src/main/resources/archetype-resources/pom.xml b/projects-parent/archetypes-parent/airline-web-archetype/src/main/resources/archetype-resources/pom.xml index 377750c63..7df6c6519 100644 --- a/projects-parent/archetypes-parent/airline-web-archetype/src/main/resources/archetype-resources/pom.xml +++ b/projects-parent/archetypes-parent/airline-web-archetype/src/main/resources/archetype-resources/pom.xml @@ -188,6 +188,9 @@ grader + + ${grader} + diff --git a/projects-parent/archetypes-parent/airline-web-archetype/src/test/resources/projects/javadoc/archetype.properties b/projects-parent/archetypes-parent/airline-web-archetype/src/test/resources/projects/javadoc/archetype.properties new file mode 100644 index 000000000..f9cc500b7 --- /dev/null +++ b/projects-parent/archetypes-parent/airline-web-archetype/src/test/resources/projects/javadoc/archetype.properties @@ -0,0 +1,5 @@ +package=it.pkg.javadoc +version=0.1-SNAPSHOT +groupId=javadoc.archetype.it +artifactId=javadoc +grader=true diff --git a/projects-parent/archetypes-parent/airline-web-archetype/src/test/resources/projects/javadoc/goal.txt b/projects-parent/archetypes-parent/airline-web-archetype/src/test/resources/projects/javadoc/goal.txt new file mode 100644 index 000000000..780912245 --- /dev/null +++ b/projects-parent/archetypes-parent/airline-web-archetype/src/test/resources/projects/javadoc/goal.txt @@ -0,0 +1 @@ +javadoc:javadoc \ No newline at end of file diff --git a/projects-parent/archetypes-parent/airline-web-archetype/src/test/resources/projects/javadoc/verify.groovy b/projects-parent/archetypes-parent/airline-web-archetype/src/test/resources/projects/javadoc/verify.groovy new file mode 100644 index 000000000..c8a7444cb --- /dev/null +++ b/projects-parent/archetypes-parent/airline-web-archetype/src/test/resources/projects/javadoc/verify.groovy @@ -0,0 +1,11 @@ +File buildLog = new File(basedir, "project/javadoc/build.log"); +if (!buildLog.isFile()) { + throw new FileNotFoundException("Couldn't find build log: " + buildLog) +} + +String logText = buildLog.text + +def expectedJavaDoc = "A helper class for accessing the rest client." +if (!logText.contains(expectedJavaDoc)) { + throw new IllegalStateException("Didn't find expected JavaDoc: " + expectedJavaDoc) +} diff --git a/projects-parent/archetypes-parent/apptbook-archetype/src/main/resources/archetype-resources/pom.xml b/projects-parent/archetypes-parent/apptbook-archetype/src/main/resources/archetype-resources/pom.xml index ba9cace5c..243919b4f 100644 --- a/projects-parent/archetypes-parent/apptbook-archetype/src/main/resources/archetype-resources/pom.xml +++ b/projects-parent/archetypes-parent/apptbook-archetype/src/main/resources/archetype-resources/pom.xml @@ -127,6 +127,9 @@ grader + + ${grader} + diff --git a/projects-parent/archetypes-parent/apptbook-archetype/src/test/resources/projects/javadoc/archetype.properties b/projects-parent/archetypes-parent/apptbook-archetype/src/test/resources/projects/javadoc/archetype.properties new file mode 100644 index 000000000..f9cc500b7 --- /dev/null +++ b/projects-parent/archetypes-parent/apptbook-archetype/src/test/resources/projects/javadoc/archetype.properties @@ -0,0 +1,5 @@ +package=it.pkg.javadoc +version=0.1-SNAPSHOT +groupId=javadoc.archetype.it +artifactId=javadoc +grader=true diff --git a/projects-parent/archetypes-parent/apptbook-archetype/src/test/resources/projects/javadoc/goal.txt b/projects-parent/archetypes-parent/apptbook-archetype/src/test/resources/projects/javadoc/goal.txt new file mode 100644 index 000000000..780912245 --- /dev/null +++ b/projects-parent/archetypes-parent/apptbook-archetype/src/test/resources/projects/javadoc/goal.txt @@ -0,0 +1 @@ +javadoc:javadoc \ No newline at end of file diff --git a/projects-parent/archetypes-parent/apptbook-archetype/src/test/resources/projects/javadoc/verify.groovy b/projects-parent/archetypes-parent/apptbook-archetype/src/test/resources/projects/javadoc/verify.groovy new file mode 100644 index 000000000..378c6e9ed --- /dev/null +++ b/projects-parent/archetypes-parent/apptbook-archetype/src/test/resources/projects/javadoc/verify.groovy @@ -0,0 +1,13 @@ +package projects.javadoc + +File buildLog = new File(basedir, "project/javadoc/build.log"); +if (!buildLog.isFile()) { + throw new FileNotFoundException("Couldn't find build log: " + buildLog) +} + +String logText = buildLog.text + +def expectedJavaDoc = "The main class for the CS410J appointment book Project" +if (!logText.contains(expectedJavaDoc)) { + throw new IllegalStateException("Didn't find expected JavaDoc: " + expectedJavaDoc) +} diff --git a/projects-parent/archetypes-parent/apptbook-gwt-archetype/src/main/resources/archetype-resources/pom.xml b/projects-parent/archetypes-parent/apptbook-gwt-archetype/src/main/resources/archetype-resources/pom.xml index f70e445d4..d08007055 100644 --- a/projects-parent/archetypes-parent/apptbook-gwt-archetype/src/main/resources/archetype-resources/pom.xml +++ b/projects-parent/archetypes-parent/apptbook-gwt-archetype/src/main/resources/archetype-resources/pom.xml @@ -197,6 +197,9 @@ grader + + ${grader} + diff --git a/projects-parent/archetypes-parent/apptbook-gwt-archetype/src/test/resources/projects/javadoc/archetype.properties b/projects-parent/archetypes-parent/apptbook-gwt-archetype/src/test/resources/projects/javadoc/archetype.properties new file mode 100644 index 000000000..f9cc500b7 --- /dev/null +++ b/projects-parent/archetypes-parent/apptbook-gwt-archetype/src/test/resources/projects/javadoc/archetype.properties @@ -0,0 +1,5 @@ +package=it.pkg.javadoc +version=0.1-SNAPSHOT +groupId=javadoc.archetype.it +artifactId=javadoc +grader=true diff --git a/projects-parent/archetypes-parent/apptbook-gwt-archetype/src/test/resources/projects/javadoc/goal.txt b/projects-parent/archetypes-parent/apptbook-gwt-archetype/src/test/resources/projects/javadoc/goal.txt new file mode 100644 index 000000000..780912245 --- /dev/null +++ b/projects-parent/archetypes-parent/apptbook-gwt-archetype/src/test/resources/projects/javadoc/goal.txt @@ -0,0 +1 @@ +javadoc:javadoc \ No newline at end of file diff --git a/projects-parent/archetypes-parent/apptbook-gwt-archetype/src/test/resources/projects/javadoc/verify.groovy b/projects-parent/archetypes-parent/apptbook-gwt-archetype/src/test/resources/projects/javadoc/verify.groovy new file mode 100644 index 000000000..4d091ca6c --- /dev/null +++ b/projects-parent/archetypes-parent/apptbook-gwt-archetype/src/test/resources/projects/javadoc/verify.groovy @@ -0,0 +1,11 @@ +File buildLog = new File(basedir, "project/javadoc/build.log"); +if (!buildLog.isFile()) { + throw new FileNotFoundException("Couldn't find build log: " + buildLog) +} + +String logText = buildLog.text + +def expectedJavaDoc = "A basic GWT class that makes sure that we can send an appointment book" +if (!logText.contains(expectedJavaDoc)) { + throw new IllegalStateException("Didn't find expected JavaDoc: " + expectedJavaDoc) +} diff --git a/projects-parent/archetypes-parent/apptbook-web-archetype/src/main/resources/archetype-resources/pom.xml b/projects-parent/archetypes-parent/apptbook-web-archetype/src/main/resources/archetype-resources/pom.xml index 6174fd4f1..7ed675694 100644 --- a/projects-parent/archetypes-parent/apptbook-web-archetype/src/main/resources/archetype-resources/pom.xml +++ b/projects-parent/archetypes-parent/apptbook-web-archetype/src/main/resources/archetype-resources/pom.xml @@ -188,6 +188,9 @@ grader + + ${grader} + diff --git a/projects-parent/archetypes-parent/apptbook-web-archetype/src/test/resources/projects/javadoc/archetype.properties b/projects-parent/archetypes-parent/apptbook-web-archetype/src/test/resources/projects/javadoc/archetype.properties new file mode 100644 index 000000000..f9cc500b7 --- /dev/null +++ b/projects-parent/archetypes-parent/apptbook-web-archetype/src/test/resources/projects/javadoc/archetype.properties @@ -0,0 +1,5 @@ +package=it.pkg.javadoc +version=0.1-SNAPSHOT +groupId=javadoc.archetype.it +artifactId=javadoc +grader=true diff --git a/projects-parent/archetypes-parent/apptbook-web-archetype/src/test/resources/projects/javadoc/goal.txt b/projects-parent/archetypes-parent/apptbook-web-archetype/src/test/resources/projects/javadoc/goal.txt new file mode 100644 index 000000000..780912245 --- /dev/null +++ b/projects-parent/archetypes-parent/apptbook-web-archetype/src/test/resources/projects/javadoc/goal.txt @@ -0,0 +1 @@ +javadoc:javadoc \ No newline at end of file diff --git a/projects-parent/archetypes-parent/apptbook-web-archetype/src/test/resources/projects/javadoc/verify.groovy b/projects-parent/archetypes-parent/apptbook-web-archetype/src/test/resources/projects/javadoc/verify.groovy new file mode 100644 index 000000000..5872baba4 --- /dev/null +++ b/projects-parent/archetypes-parent/apptbook-web-archetype/src/test/resources/projects/javadoc/verify.groovy @@ -0,0 +1,11 @@ +File buildLog = new File(basedir, "project/javadoc/build.log"); +if (!buildLog.isFile()) { + throw new FileNotFoundException("Couldn't find build log: " + buildLog) +} + +String logText = buildLog.text + +def expectedJavaDoc = "A helper class for accessing the rest client" +if (!logText.contains(expectedJavaDoc)) { + throw new IllegalStateException("Didn't find expected JavaDoc: " + expectedJavaDoc) +} diff --git a/projects-parent/archetypes-parent/phonebill-gwt-archetype/src/main/resources/archetype-resources/pom.xml b/projects-parent/archetypes-parent/phonebill-gwt-archetype/src/main/resources/archetype-resources/pom.xml index 6e47deb21..b62dac8ea 100644 --- a/projects-parent/archetypes-parent/phonebill-gwt-archetype/src/main/resources/archetype-resources/pom.xml +++ b/projects-parent/archetypes-parent/phonebill-gwt-archetype/src/main/resources/archetype-resources/pom.xml @@ -184,6 +184,9 @@ grader + + ${grader} + diff --git a/projects-parent/archetypes-parent/phonebill-gwt-archetype/src/test/resources/projects/javadoc/archetype.properties b/projects-parent/archetypes-parent/phonebill-gwt-archetype/src/test/resources/projects/javadoc/archetype.properties new file mode 100644 index 000000000..f9cc500b7 --- /dev/null +++ b/projects-parent/archetypes-parent/phonebill-gwt-archetype/src/test/resources/projects/javadoc/archetype.properties @@ -0,0 +1,5 @@ +package=it.pkg.javadoc +version=0.1-SNAPSHOT +groupId=javadoc.archetype.it +artifactId=javadoc +grader=true diff --git a/projects-parent/archetypes-parent/phonebill-gwt-archetype/src/test/resources/projects/javadoc/goal.txt b/projects-parent/archetypes-parent/phonebill-gwt-archetype/src/test/resources/projects/javadoc/goal.txt new file mode 100644 index 000000000..780912245 --- /dev/null +++ b/projects-parent/archetypes-parent/phonebill-gwt-archetype/src/test/resources/projects/javadoc/goal.txt @@ -0,0 +1 @@ +javadoc:javadoc \ No newline at end of file diff --git a/projects-parent/archetypes-parent/phonebill-gwt-archetype/src/test/resources/projects/javadoc/verify.groovy b/projects-parent/archetypes-parent/phonebill-gwt-archetype/src/test/resources/projects/javadoc/verify.groovy new file mode 100644 index 000000000..dda0254b4 --- /dev/null +++ b/projects-parent/archetypes-parent/phonebill-gwt-archetype/src/test/resources/projects/javadoc/verify.groovy @@ -0,0 +1,11 @@ +File buildLog = new File(basedir, "project/javadoc/build.log"); +if (!buildLog.isFile()) { + throw new FileNotFoundException("Couldn't find build log: " + buildLog) +} + +String logText = buildLog.text + +def expectedJavaDoc = "A basic GWT class that makes sure that we can send an Phone Bill back" +if (!logText.contains(expectedJavaDoc)) { + throw new IllegalStateException("Didn't find expected JavaDoc: " + expectedJavaDoc) +} diff --git a/projects-parent/archetypes-parent/phonebill-web-archetype/src/main/resources/archetype-resources/pom.xml b/projects-parent/archetypes-parent/phonebill-web-archetype/src/main/resources/archetype-resources/pom.xml index 24f78fe34..ae591e5b9 100644 --- a/projects-parent/archetypes-parent/phonebill-web-archetype/src/main/resources/archetype-resources/pom.xml +++ b/projects-parent/archetypes-parent/phonebill-web-archetype/src/main/resources/archetype-resources/pom.xml @@ -189,6 +189,9 @@ grader + + ${grader} + diff --git a/projects-parent/archetypes-parent/phonebill-web-archetype/src/test/resources/projects/javadoc/archetype.properties b/projects-parent/archetypes-parent/phonebill-web-archetype/src/test/resources/projects/javadoc/archetype.properties new file mode 100644 index 000000000..f9cc500b7 --- /dev/null +++ b/projects-parent/archetypes-parent/phonebill-web-archetype/src/test/resources/projects/javadoc/archetype.properties @@ -0,0 +1,5 @@ +package=it.pkg.javadoc +version=0.1-SNAPSHOT +groupId=javadoc.archetype.it +artifactId=javadoc +grader=true diff --git a/projects-parent/archetypes-parent/phonebill-web-archetype/src/test/resources/projects/javadoc/goal.txt b/projects-parent/archetypes-parent/phonebill-web-archetype/src/test/resources/projects/javadoc/goal.txt new file mode 100644 index 000000000..780912245 --- /dev/null +++ b/projects-parent/archetypes-parent/phonebill-web-archetype/src/test/resources/projects/javadoc/goal.txt @@ -0,0 +1 @@ +javadoc:javadoc \ No newline at end of file diff --git a/projects-parent/archetypes-parent/phonebill-web-archetype/src/test/resources/projects/javadoc/verify.groovy b/projects-parent/archetypes-parent/phonebill-web-archetype/src/test/resources/projects/javadoc/verify.groovy new file mode 100644 index 000000000..c8a7444cb --- /dev/null +++ b/projects-parent/archetypes-parent/phonebill-web-archetype/src/test/resources/projects/javadoc/verify.groovy @@ -0,0 +1,11 @@ +File buildLog = new File(basedir, "project/javadoc/build.log"); +if (!buildLog.isFile()) { + throw new FileNotFoundException("Couldn't find build log: " + buildLog) +} + +String logText = buildLog.text + +def expectedJavaDoc = "A helper class for accessing the rest client." +if (!logText.contains(expectedJavaDoc)) { + throw new IllegalStateException("Didn't find expected JavaDoc: " + expectedJavaDoc) +} diff --git a/projects-parent/archetypes-parent/student-archetype/src/main/resources/archetype-resources/pom.xml b/projects-parent/archetypes-parent/student-archetype/src/main/resources/archetype-resources/pom.xml index 9b7e26cad..501b8ed17 100644 --- a/projects-parent/archetypes-parent/student-archetype/src/main/resources/archetype-resources/pom.xml +++ b/projects-parent/archetypes-parent/student-archetype/src/main/resources/archetype-resources/pom.xml @@ -117,4 +117,33 @@ test + + + + grader + + ${grader} + + + + + org.apache.maven.plugins + maven-javadoc-plugin + 2.9 + + edu.pdx.cs410J.grader.APIDocumentationDoclet + + edu.pdx.cs410J + grader + Summer2017 + + false + private + + + + + + + diff --git a/projects-parent/archetypes-parent/student-archetype/src/test/resources/projects/javadoc/archetype.properties b/projects-parent/archetypes-parent/student-archetype/src/test/resources/projects/javadoc/archetype.properties new file mode 100644 index 000000000..f9cc500b7 --- /dev/null +++ b/projects-parent/archetypes-parent/student-archetype/src/test/resources/projects/javadoc/archetype.properties @@ -0,0 +1,5 @@ +package=it.pkg.javadoc +version=0.1-SNAPSHOT +groupId=javadoc.archetype.it +artifactId=javadoc +grader=true diff --git a/projects-parent/archetypes-parent/student-archetype/src/test/resources/projects/javadoc/goal.txt b/projects-parent/archetypes-parent/student-archetype/src/test/resources/projects/javadoc/goal.txt new file mode 100644 index 000000000..780912245 --- /dev/null +++ b/projects-parent/archetypes-parent/student-archetype/src/test/resources/projects/javadoc/goal.txt @@ -0,0 +1 @@ +javadoc:javadoc \ No newline at end of file diff --git a/projects-parent/archetypes-parent/student-archetype/src/test/resources/projects/javadoc/verify.groovy b/projects-parent/archetypes-parent/student-archetype/src/test/resources/projects/javadoc/verify.groovy new file mode 100644 index 000000000..a60308b03 --- /dev/null +++ b/projects-parent/archetypes-parent/student-archetype/src/test/resources/projects/javadoc/verify.groovy @@ -0,0 +1,11 @@ +File buildLog = new File(basedir, "project/javadoc/build.log"); +if (!buildLog.isFile()) { + throw new FileNotFoundException("Couldn't find build log: " + buildLog) +} + +String logText = buildLog.text + +def expectedJavaDoc = "This class is represents a Student." +if (!logText.contains(expectedJavaDoc)) { + throw new IllegalStateException("Didn't find expected JavaDoc: " + expectedJavaDoc) +} diff --git a/projects-parent/originals-parent/airline-web/pom.xml b/projects-parent/originals-parent/airline-web/pom.xml index 766b51c2c..d158dc6c3 100644 --- a/projects-parent/originals-parent/airline-web/pom.xml +++ b/projects-parent/originals-parent/airline-web/pom.xml @@ -189,6 +189,9 @@ grader + + ${grader} + diff --git a/projects-parent/originals-parent/airline/pom.xml b/projects-parent/originals-parent/airline/pom.xml index 88d94abf0..774abce5f 100644 --- a/projects-parent/originals-parent/airline/pom.xml +++ b/projects-parent/originals-parent/airline/pom.xml @@ -126,6 +126,9 @@ grader + + ${grader} + diff --git a/projects-parent/originals-parent/apptbook-web/pom.xml b/projects-parent/originals-parent/apptbook-web/pom.xml index 96837ef24..a0e2f4be5 100644 --- a/projects-parent/originals-parent/apptbook-web/pom.xml +++ b/projects-parent/originals-parent/apptbook-web/pom.xml @@ -187,6 +187,9 @@ grader + + ${grader} + diff --git a/projects-parent/originals-parent/apptbook/pom.xml b/projects-parent/originals-parent/apptbook/pom.xml index cb5a894bd..4647c9aa0 100644 --- a/projects-parent/originals-parent/apptbook/pom.xml +++ b/projects-parent/originals-parent/apptbook/pom.xml @@ -126,6 +126,9 @@ grader + + ${grader} + diff --git a/projects-parent/originals-parent/phonebill-web/pom.xml b/projects-parent/originals-parent/phonebill-web/pom.xml index 7cec3fe19..0ab0e679b 100644 --- a/projects-parent/originals-parent/phonebill-web/pom.xml +++ b/projects-parent/originals-parent/phonebill-web/pom.xml @@ -187,6 +187,9 @@ grader + + ${grader} + diff --git a/projects-parent/originals-parent/phonebill/pom.xml b/projects-parent/originals-parent/phonebill/pom.xml index 7f9080626..7e0dc399e 100644 --- a/projects-parent/originals-parent/phonebill/pom.xml +++ b/projects-parent/originals-parent/phonebill/pom.xml @@ -121,6 +121,9 @@ grader + + ${grader} + diff --git a/projects-parent/originals-parent/student/pom.xml b/projects-parent/originals-parent/student/pom.xml index 7bc1f2e0e..cbed48633 100644 --- a/projects-parent/originals-parent/student/pom.xml +++ b/projects-parent/originals-parent/student/pom.xml @@ -116,4 +116,33 @@ test + + + + grader + + ${grader} + + + + + org.apache.maven.plugins + maven-javadoc-plugin + 2.9 + + edu.pdx.cs410J.grader.APIDocumentationDoclet + + edu.pdx.cs410J + grader + Summer2017 + + false + private + + + + + + +