code cleanup from static code checks (#157)

* code cleanup from static code checks

* removed exception eaters from FileCacheStore

* moved integration tests to its own module, and added Jacoco code coverage plugin

* change logging format of integration tests to match operator tests

* force sync local and remote repos

* move copyright check inline to the checkstyle rules

* moved installer creation to its own module

* enforce user credentials for verify phase where integration tests are run

* separate artifacts from same groupId as WDT

* remove flatten-pom plugin

Author: ddsharpe

.gitignore

@@ -6,4 +6,3 @@
 !.idea/codeStyles/codeStyleConfig.xml
 **/target
 **/.DS_Store
-.flattened-pom.xml

.mvn/maven.config-template

@@ -0,0 +1 @@
+-Dtest.dependency.dir=/some/folder/with/installers

Jenkinsfile

@@ -9,8 +9,7 @@ pipeline {
     }
 
     environment {
-        WLSIMG_BLDDIR = "${env.WORKSPACE}/imagetool/target/build"
-        WLSIMG_CACHEDIR = "${env.WORKSPACE}/imagetool/target/cache"
+        STAGING_DIR = "/scratch/artifacts/imagetool"
     }
 
     stages {
@@ -25,7 +24,7 @@ pipeline {
         }
         stage ('Build') {
             steps {
-                sh 'mvn -B -DskipTests clean package'
+                sh 'mvn -B -DskipTests -DskipITs clean install'
             }
         }
         stage ('Test') {
@@ -44,12 +43,12 @@ pipeline {
             }
             steps {
                 withCredentials([[$class: 'UsernamePasswordMultiBinding', credentialsId: 'otn-cred', passwordVariable: 'ORACLE_SUPPORT_PASSWORD', usernameVariable: 'ORACLE_SUPPORT_USERNAME']]) {
-                    sh 'mvn verify'
+                    sh 'mvn verify -Dtest.staging.dir=${STAGING_DIR}'
                 }
             }
             post {
                 always {
-                    junit 'imagetool/target/failsafe-reports/*.xml'
+                    junit 'tests/target/failsafe-reports/*.xml'
                 }
             }
         }

build-tools/pom.xml

@@ -4,7 +4,7 @@
 <project>
   <modelVersion>4.0.0</modelVersion>
 
-  <groupId>com.oracle.weblogic.lifecycle</groupId>
+  <groupId>com.oracle.weblogic.lifecycle.imagetool</groupId>
   <artifactId>build-tools</artifactId>
   <version>1.2</version>
   <name>Build Tools</name>

build-tools/src/main/resources/weblogic-image-tool/checkstyle/customized_google_checks.xml

@@ -41,7 +41,7 @@
     </module>
 
     <module name="RegexpHeader">
-        <property name="headerFile" value="build-tools/src/main/resources/weblogic-image-tool/checkstyle/java.header"/>
+        <property name="header" value="^// Copyright \(c\) (\d\d\d\d, )+Oracle Corporation and\/or its affiliates\.$\n^// Licensed under the Universal Permissive License v 1\.0 as shown at https://oss\.oracle\.com/licenses/upl\.$"/>
         <property name="fileExtensions" value="java"/>
     </module>
 

build-tools/src/main/resources/weblogic-image-tool/checkstyle/java.header

@@ -8,15 +8,19 @@
     <modelVersion>4.0.0</modelVersion>
 
     <artifactId>imagetool</artifactId>
-    <name>WebLogic Image Tool</name>
+    <name>Image Tool Core</name>
 
     <parent>
         <artifactId>imagetool-parent</artifactId>
-        <groupId>com.oracle.weblogic.lifecycle</groupId>
+        <groupId>com.oracle.weblogic.lifecycle.imagetool</groupId>
         <version>1.8.5-SNAPSHOT</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 
+    <properties>
+        <sonar.coverage.jacoco.xmlReportPaths>${basedir}/../${aggregate.report.dir}</sonar.coverage.jacoco.xmlReportPaths>
+    </properties>
+
     <dependencies>
         <dependency>
             <groupId>org.apache.httpcomponents</groupId>
@@ -73,6 +77,18 @@
             </resource>
         </resources>
         <plugins>
+            <plugin>
+                <groupId>org.jacoco</groupId>
+                <artifactId>jacoco-maven-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <id>prepare-agent</id>
+                        <goals>
+                            <goal>prepare-agent</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-jar-plugin</artifactId>
@@ -102,73 +118,10 @@
                     </arguments>
                 </configuration>
             </plugin>
-            <plugin>
-                <groupId>org.codehaus.mojo</groupId>
-                <artifactId>flatten-maven-plugin</artifactId>
-            </plugin>
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-assembly-plugin</artifactId>
-                <executions>
-                    <execution>
-                        <id>build-zip-installer</id>
-                        <phase>package</phase>
-                        <goals>
-                            <goal>single</goal>
-                        </goals>
-                        <configuration>
-                            <finalName>${installer-name}</finalName>
-                            <descriptors>
-                                <descriptor>src/assembly/zip.xml</descriptor>
-                            </descriptors>
-                            <archiveBaseDirectory>${project.basedir}</archiveBaseDirectory>
-                            <appendAssemblyId>false</appendAssemblyId>
-                            <archiverConfig>
-                                <directoryMode>0750</directoryMode>
-                                <defaultDirectoryMode>0750</defaultDirectoryMode>
-                                <fileMode>0640</fileMode>
-                            </archiverConfig>
-                        </configuration>
-                    </execution>
-                </executions>
-            </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-checkstyle-plugin</artifactId>
             </plugin>
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-failsafe-plugin</artifactId>
-                <configuration>
-                    <encoding>UTF-8</encoding>
-                    <failIfNoTests>false</failIfNoTests>
-                    <argLine> 
-                        -Xmx1024m -XX:MaxPermSize=256m
-                    </argLine>
-                    <systemProperties>
-                        <property>
-                            <name>imagetoolversion</name>
-                            <value>${project.version}</value>
-                        </property>
-                    </systemProperties>
-                </configuration>
-                <executions>
-                    <execution>
-                        <id>integration-tests</id>
-                        <goals>
-                            <goal>integration-test</goal>
-                            <goal>verify</goal>
-                        </goals>
-                        <phase>integration-test</phase>
-                        <configuration>
-                            <systemPropertyVariables>
-                                <java.util.logging.SimpleFormatter.format>%1$tm-%1$td-%1$tY %1$tH:%1$tM:%1$tS %4$-6s %2$s %5$s%6$s%n</java.util.logging.SimpleFormatter.format>
-                            </systemPropertyVariables>
-                            <trimStackTrace>false</trimStackTrace>
-                        </configuration>
-                    </execution>
-                </executions>
-            </plugin>
         </plugins>
     </build>
 </project>

imagetool/pom.xml

@@ -112,7 +112,10 @@ public Path copyFile(CacheStore cacheStore, String buildContextDir) throws IOExc
         try {
             result = Files.copy(Paths.get(sourceFile), Paths.get(buildContextDir, targetFilename));
         } catch (Exception ee) {
-            ee.printStackTrace();
+            String msg = Utils.getMessage("IMG-0064", sourceFile, buildContextDir);
+            logger.severe(msg);
+            logger.fine(msg, ee);
+            throw ee;
         }
         logger.exiting(result);
         return result;

imagetool/src/main/java/com/oracle/weblogic/imagetool/api/model/CachedFile.java

@@ -9,7 +9,6 @@ public class CommandResponse {
 
     private int status;
     private String message;
-    private Object result;
     private Object[] messageParams;
 
     /**

imagetool/src/main/java/com/oracle/weblogic/imagetool/api/model/CommandResponse.java

@@ -45,17 +45,21 @@ public interface CacheStore {
      *
      * @param key   artifact identifier
      * @param value a file path
-     * @return true if add is successful
      */
-    boolean addToCache(String key, String value);
+    void addToCache(String key, String value) throws CacheStoreException;
 
     /**
      * Delete an entry from the cache.
      *
      * @param key key corresponding to an entry in the cache
      * @return value or null
      */
-    String deleteFromCache(String key);
+    String deleteFromCache(String key) throws CacheStoreException;
+
+    /**
+     * Delete all entries from the cache.
+     */
+    void clearCache() throws CacheStoreException;
 
     /**
      * Returns a map of current items in the cache.