Fix checkstyle errors when building archetype-generated apps
Checkstyle validation is now enabled by default in onos-dependencies
(archetypes' parent pom). We also add a reference to the archetypes' pom
to disable checkstyle, if needed.
Change-Id: I9b6e6cecf2d704f52ec1f118eae2aafd03cf0b9a
diff --git a/tools/package/archetypes/api/src/main/resources/archetype-resources/pom.xml b/tools/package/archetypes/api/src/main/resources/archetype-resources/pom.xml
index acded36..ba79393 100644
--- a/tools/package/archetypes/api/src/main/resources/archetype-resources/pom.xml
+++ b/tools/package/archetypes/api/src/main/resources/archetype-resources/pom.xml
@@ -19,7 +19,9 @@
~ See the License for the specific language governing permissions and
~ limitations under the License.
-->
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
@@ -45,4 +47,18 @@
</dependency>
</dependencies>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-checkstyle-plugin</artifactId>
+ <!-- Uncomment to disable checkstyle validation
+ <configuration>
+ <skip>true</skip>
+ </configuration>
+ -->
+ </plugin>
+ </plugins>
+ </build>
+
</project>
diff --git a/tools/package/archetypes/api/src/main/resources/archetype-resources/src/main/java/package-info.java b/tools/package/archetypes/api/src/main/resources/archetype-resources/src/main/java/package-info.java
index e9d8ea0..3d2d640 100644
--- a/tools/package/archetypes/api/src/main/resources/archetype-resources/src/main/java/package-info.java
+++ b/tools/package/archetypes/api/src/main/resources/archetype-resources/src/main/java/package-info.java
@@ -1,5 +1,8 @@
+#set( $symbol_pound = '#' )
+#set( $symbol_dollar = '$' )
+#set( $symbol_escape = '\' )
/*
- * Copyright 2014-present Open Networking Foundation
+ * Copyright ${year}-present Open Networking Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -15,6 +18,6 @@
*/
/**
- * ONOS application archetype.
+ * The ${artifactId} application.
*/
-package ${package};
\ No newline at end of file
+package ${package};
diff --git a/tools/package/archetypes/bundle/pom.xml b/tools/package/archetypes/bundle/pom.xml
index 12e8577..79ee076 100644
--- a/tools/package/archetypes/bundle/pom.xml
+++ b/tools/package/archetypes/bundle/pom.xml
@@ -14,18 +14,20 @@
~ See the License for the specific language governing permissions and
~ limitations under the License.
-->
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
- <modelVersion>4.0.0</modelVersion>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <modelVersion>4.0.0</modelVersion>
- <parent>
- <groupId>org.onosproject</groupId>
- <artifactId>onos-archetypes</artifactId>
- <version>2.4.0-SNAPSHOT</version>
- </parent>
+ <parent>
+ <groupId>org.onosproject</groupId>
+ <artifactId>onos-archetypes</artifactId>
+ <version>2.4.0-SNAPSHOT</version>
+ </parent>
- <artifactId>onos-bundle-archetype</artifactId>
- <packaging>maven-archetype</packaging>
+ <artifactId>onos-bundle-archetype</artifactId>
+ <packaging>maven-archetype</packaging>
- <description>ONOS OSGi bundle archetype</description>
+ <description>ONOS OSGi bundle archetype</description>
</project>
diff --git a/tools/package/archetypes/bundle/src/main/resources/archetype-resources/pom.xml b/tools/package/archetypes/bundle/src/main/resources/archetype-resources/pom.xml
index 08f248b..c996608 100644
--- a/tools/package/archetypes/bundle/src/main/resources/archetype-resources/pom.xml
+++ b/tools/package/archetypes/bundle/src/main/resources/archetype-resources/pom.xml
@@ -84,6 +84,16 @@
<groupId>org.onosproject</groupId>
<artifactId>onos-maven-plugin</artifactId>
</plugin>
+
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-checkstyle-plugin</artifactId>
+ <!-- Uncomment to disable checkstyle validation
+ <configuration>
+ <skip>true</skip>
+ </configuration>
+ -->
+ </plugin>
</plugins>
</build>
diff --git a/tools/package/archetypes/bundle/src/main/resources/archetype-resources/src/main/java/package-info.java b/tools/package/archetypes/bundle/src/main/resources/archetype-resources/src/main/java/package-info.java
index e9d8ea0..4a304bb 100644
--- a/tools/package/archetypes/bundle/src/main/resources/archetype-resources/src/main/java/package-info.java
+++ b/tools/package/archetypes/bundle/src/main/resources/archetype-resources/src/main/java/package-info.java
@@ -1,5 +1,8 @@
+#set( $symbol_pound = '#' )
+#set( $symbol_dollar = '$' )
+#set( $symbol_escape = '\' )
/*
- * Copyright 2014-present Open Networking Foundation
+ * Copyright ${year}-present Open Networking Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
diff --git a/tools/package/archetypes/cli/src/main/resources/archetype-resources/pom.xml b/tools/package/archetypes/cli/src/main/resources/archetype-resources/pom.xml
index e98fdcd..5a8d65a 100644
--- a/tools/package/archetypes/cli/src/main/resources/archetype-resources/pom.xml
+++ b/tools/package/archetypes/cli/src/main/resources/archetype-resources/pom.xml
@@ -19,7 +19,9 @@
~ See the License for the specific language governing permissions and
~ limitations under the License.
-->
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
@@ -84,6 +86,15 @@
</instructions>
</configuration>
</plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-checkstyle-plugin</artifactId>
+ <!-- Uncomment to disable checkstyle validation
+ <configuration>
+ <skip>true</skip>
+ </configuration>
+ -->
+ </plugin>
</plugins>
</build>
diff --git a/tools/package/archetypes/cli/src/main/resources/archetype-resources/src/main/java/package-info.java b/tools/package/archetypes/cli/src/main/resources/archetype-resources/src/main/java/package-info.java
deleted file mode 100644
index e9d8ea0..0000000
--- a/tools/package/archetypes/cli/src/main/resources/archetype-resources/src/main/java/package-info.java
+++ /dev/null
@@ -1,20 +0,0 @@
-/*
- * Copyright 2014-present Open Networking Foundation
- *
- * Licensed 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 agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-/**
- * ONOS application archetype.
- */
-package ${package};
\ No newline at end of file
diff --git a/tools/package/archetypes/rest/src/main/resources/archetype-resources/pom.xml b/tools/package/archetypes/rest/src/main/resources/archetype-resources/pom.xml
index 3abcc18..8a159d0 100644
--- a/tools/package/archetypes/rest/src/main/resources/archetype-resources/pom.xml
+++ b/tools/package/archetypes/rest/src/main/resources/archetype-resources/pom.xml
@@ -19,7 +19,9 @@
~ See the License for the specific language governing permissions and
~ limitations under the License.
-->
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
@@ -143,6 +145,15 @@
<groupId>org.onosproject</groupId>
<artifactId>onos-maven-plugin</artifactId>
</plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-checkstyle-plugin</artifactId>
+ <!-- Uncomment to disable checkstyle validation
+ <configuration>
+ <skip>true</skip>
+ </configuration>
+ -->
+ </plugin>
</plugins>
</build>
diff --git a/tools/package/archetypes/rest/src/main/resources/archetype-resources/src/main/java/package-info.java b/tools/package/archetypes/rest/src/main/resources/archetype-resources/src/main/java/package-info.java
deleted file mode 100644
index e9d8ea0..0000000
--- a/tools/package/archetypes/rest/src/main/resources/archetype-resources/src/main/java/package-info.java
+++ /dev/null
@@ -1,20 +0,0 @@
-/*
- * Copyright 2014-present Open Networking Foundation
- *
- * Licensed 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 agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-/**
- * ONOS application archetype.
- */
-package ${package};
\ No newline at end of file
diff --git a/tools/package/archetypes/ui/src/main/resources/archetype-resources/pom.xml b/tools/package/archetypes/ui/src/main/resources/archetype-resources/pom.xml
index 3bb5fdd..0ec953f 100644
--- a/tools/package/archetypes/ui/src/main/resources/archetype-resources/pom.xml
+++ b/tools/package/archetypes/ui/src/main/resources/archetype-resources/pom.xml
@@ -19,7 +19,9 @@
~ See the License for the specific language governing permissions and
~ limitations under the License.
-->
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
@@ -77,6 +79,15 @@
<groupId>org.onosproject</groupId>
<artifactId>onos-maven-plugin</artifactId>
</plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-checkstyle-plugin</artifactId>
+ <!-- Uncomment to disable checkstyle validation
+ <configuration>
+ <skip>true</skip>
+ </configuration>
+ -->
+ </plugin>
</plugins>
</build>
diff --git a/tools/package/archetypes/ui/src/main/resources/archetype-resources/src/main/java/package-info.java b/tools/package/archetypes/ui/src/main/resources/archetype-resources/src/main/java/package-info.java
deleted file mode 100644
index e9d8ea0..0000000
--- a/tools/package/archetypes/ui/src/main/resources/archetype-resources/src/main/java/package-info.java
+++ /dev/null
@@ -1,20 +0,0 @@
-/*
- * Copyright 2014-present Open Networking Foundation
- *
- * Licensed 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 agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-/**
- * ONOS application archetype.
- */
-package ${package};
\ No newline at end of file
diff --git a/tools/package/archetypes/ui2/src/main/resources/archetype-resources/pom.xml b/tools/package/archetypes/ui2/src/main/resources/archetype-resources/pom.xml
index 05da40c..6aa5e58 100644
--- a/tools/package/archetypes/ui2/src/main/resources/archetype-resources/pom.xml
+++ b/tools/package/archetypes/ui2/src/main/resources/archetype-resources/pom.xml
@@ -26,7 +26,9 @@
~ See the License for the specific language governing permissions and
~ limitations under the License.
-->
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
@@ -48,4 +50,18 @@
<module>web/${artifactId}-gui</module>
</modules>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-checkstyle-plugin</artifactId>
+ <!-- Uncomment to disable checkstyle validation
+ <configuration>
+ <skip>true</skip>
+ </configuration>
+ -->
+ </plugin>
+ </plugins>
+ </build>
+
</project>
diff --git a/tools/package/archetypes/uitab/src/main/resources/archetype-resources/pom.xml b/tools/package/archetypes/uitab/src/main/resources/archetype-resources/pom.xml
index 7775946..3551265 100644
--- a/tools/package/archetypes/uitab/src/main/resources/archetype-resources/pom.xml
+++ b/tools/package/archetypes/uitab/src/main/resources/archetype-resources/pom.xml
@@ -20,7 +20,9 @@
~ See the License for the specific language governing permissions and
~ limitations under the License.
-->
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
@@ -78,6 +80,15 @@
<groupId>org.onosproject</groupId>
<artifactId>onos-maven-plugin</artifactId>
</plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-checkstyle-plugin</artifactId>
+ <!-- Uncomment to disable checkstyle validation
+ <configuration>
+ <skip>true</skip>
+ </configuration>
+ -->
+ </plugin>
</plugins>
</build>
diff --git a/tools/package/archetypes/uitab/src/main/resources/archetype-resources/src/main/java/AppUiTableMessageHandler.java b/tools/package/archetypes/uitab/src/main/resources/archetype-resources/src/main/java/AppUiTableMessageHandler.java
index 2645c32..33634b8 100644
--- a/tools/package/archetypes/uitab/src/main/resources/archetype-resources/src/main/java/AppUiTableMessageHandler.java
+++ b/tools/package/archetypes/uitab/src/main/resources/archetype-resources/src/main/java/AppUiTableMessageHandler.java
@@ -1,6 +1,6 @@
-#set( $symbol_pound = '#' )
-#set( $symbol_dollar = '$' )
-#set( $symbol_escape = '\' )
+#set($symbol_pound='#')
+#set($symbol_dollar='$')
+#set($symbol_escape='\' )
/*
* Copyright ${year}-present Open Networking Foundation
*
@@ -99,7 +99,7 @@
// fake data for demonstration purposes...
List<Item> items = getItems();
- for (Item item: items) {
+ for (Item item : items) {
populateRow(tm.addRow(), item);
}
}
diff --git a/tools/package/archetypes/uitab/src/main/resources/archetype-resources/src/main/java/package-info.java b/tools/package/archetypes/uitab/src/main/resources/archetype-resources/src/main/java/package-info.java
deleted file mode 100644
index e9d8ea0..0000000
--- a/tools/package/archetypes/uitab/src/main/resources/archetype-resources/src/main/java/package-info.java
+++ /dev/null
@@ -1,20 +0,0 @@
-/*
- * Copyright 2014-present Open Networking Foundation
- *
- * Licensed 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 agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-/**
- * ONOS application archetype.
- */
-package ${package};
\ No newline at end of file
diff --git a/tools/package/archetypes/uitopo/src/main/resources/archetype-resources/pom.xml b/tools/package/archetypes/uitopo/src/main/resources/archetype-resources/pom.xml
index 412db9e..bf2a4ea 100644
--- a/tools/package/archetypes/uitopo/src/main/resources/archetype-resources/pom.xml
+++ b/tools/package/archetypes/uitopo/src/main/resources/archetype-resources/pom.xml
@@ -20,7 +20,9 @@
~ See the License for the specific language governing permissions and
~ limitations under the License.
-->
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
@@ -78,6 +80,15 @@
<groupId>org.onosproject</groupId>
<artifactId>onos-maven-plugin</artifactId>
</plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-checkstyle-plugin</artifactId>
+ <!-- Uncomment to disable checkstyle validation
+ <configuration>
+ <skip>true</skip>
+ </configuration>
+ -->
+ </plugin>
</plugins>
</build>
diff --git a/tools/package/archetypes/uitopo/src/main/resources/archetype-resources/src/main/java/package-info.java b/tools/package/archetypes/uitopo/src/main/resources/archetype-resources/src/main/java/package-info.java
deleted file mode 100644
index e9d8ea0..0000000
--- a/tools/package/archetypes/uitopo/src/main/resources/archetype-resources/src/main/java/package-info.java
+++ /dev/null
@@ -1,20 +0,0 @@
-/*
- * Copyright 2014-present Open Networking Foundation
- *
- * Licensed 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 agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-/**
- * ONOS application archetype.
- */
-package ${package};
\ No newline at end of file
diff --git a/tools/test/bin/onos-archetypes-test b/tools/test/bin/onos-archetypes-test
index 5056477..33e3d4b 100755
--- a/tools/test/bin/onos-archetypes-test
+++ b/tools/test/bin/onos-archetypes-test
@@ -21,15 +21,17 @@
export AROOT=${ONOS_STAGE_ROOT:-/tmp}/foo
export ARCHETYPE_OPTS="-DarchetypeGroupId=org.onosproject -DarchetypeVersion=2.4.0-SNAPSHOT"
+rm -fr $AROOT 2>/dev/null
mkdir -p $AROOT
+
# FIXME: for an in api bundle cli rest ui uitab uitopo ui2; do
for an in api bundle cli rest ui uitab uitopo; do
cd $AROOT
- rm -fr $AROOT/foo-$an
+ [ $an = api ] && name=foo-api || name=foo-app
mvn -q -B archetype:generate "$@" $ARCHETYPE_OPTS \
-DarchetypeArtifactId=onos-$an-archetype \
- -DgroupId=org.foo -DartifactId=foo-$an -Dversion=1.0 \
- -Dpackage=org.foo.$an -DinteractiveMode=false
- cd $AROOT/foo-$an
+ -DgroupId=org.foo -DartifactId=$name -Dversion=1.0 \
+ -Dpackage=org.foo.test -DinteractiveMode=false
+ cd $AROOT/$name
mvn "$@" -q -B clean install
done