SRE-35206: integration test pipeline (#402)

* SRE-35206: Create Integration test pipeline with test_support

* SRE-35209: Project and script integration tests

Co-authored-by: Suman Nakshatri <suman_nakshatri@intuit.com>

Author: nakshatris

buildspec.yml

@@ -13,13 +13,20 @@ phases:
   build:
     commands:
       - java -version
+      # Run the complete build with both unit and integration tests
       - mvn clean install surefire-report:report -P release
 
 reports:
-  SurefireReports: # CodeBuild will create a report group called "SurefireReports".
-    files: #Store all of the files
-      - '**/*'
-    base-directory: 'web/web_support/target/surefire-reports' # Location of the reports
+  UnitTestReports:
+    files:
+      - '**/target/surefire-reports/TEST-*.xml'
+      - '**/target/surefire-reports/*.txt'
+    base-directory: '.'
+  IntegrationTestReports:
+    files:
+      - '**/target/failsafe-reports/TEST-*.xml'
+      - '**/target/failsafe-reports/*.txt'
+    base-directory: '.'
 
 artifacts:
   files:

data_access/src/main/java/com/intuit/tank/dao/ProjectDao.java

@@ -43,9 +43,8 @@
 
 /**
  * ProductDao
- * 
+ *
  * @author dangleton
- * 
  */
 public class ProjectDao extends OwnableDao<Project> {
     private static final Logger LOG = LogManager.getLogger(ProjectDao.class);
@@ -62,25 +61,25 @@ public ProjectDao() {
      * @return
      */
     public Project findByName(@Nonnull String name) {
-    	Project project = null;
-    	EntityManager em = getEntityManager();
-    	try {
-    		begin();
-    		CriteriaBuilder cb = em.getCriteriaBuilder();
-	        CriteriaQuery<Project> query = cb.createQuery(Project.class);
-	        Root<Project> root = query.from(Project.class);
-	        query.select(root);
-	        query.where(cb.equal(root.<String>get(Project.PROPERTY_NAME), name));
-	        project = em.createQuery(query).getSingleResult();
-    		commit();
+        Project project = null;
+        EntityManager em = getEntityManager();
+        try {
+            begin();
+            CriteriaBuilder cb = em.getCriteriaBuilder();
+            CriteriaQuery<Project> query = cb.createQuery(Project.class);
+            Root<Project> root = query.from(Project.class);
+            query.select(root);
+            query.where(cb.equal(root.<String>get(Project.PROPERTY_NAME), name));
+            project = em.createQuery(query).getSingleResult();
+            commit();
         } catch (Exception e) {
-        	rollback();
+            rollback();
             e.printStackTrace();
             throw new RuntimeException(e);
-    	} finally {
-    		cleanup();
-    	}
-    	return project;
+        } finally {
+            cleanup();
+        }
+        return project;
     }
 
     /**
@@ -107,71 +106,68 @@ public Project saveOrUpdate(@Nonnull Project entity) throws HibernateException {
         entity.setModified(new Date());
         return super.saveOrUpdate(entity);
     }
-    
+
     /**
      * Deep lookup of full project, initiate eager loading when needed.
-     * 
-     * @param id
-     *            the primary key
+     *
+     * @param id the primary key
      * @return the entity or null
      */
     @Nullable
     public Project findByIdEager(@Nonnull Integer id) {
-    	Project project = null;
-    	try {
-    		begin();
-    		project = getEntityManager().find(Project.class, id);
-			Hibernate.initialize(project.getWorkloads().get(0).getJobConfiguration());
-			Hibernate.initialize(project.getWorkloads().get(0).getTestPlans());
-    		commit();
+        Project project = null;
+        try {
+            begin();
+            project = getEntityManager().find(Project.class, id);
+            Hibernate.initialize(project.getWorkloads().get(0).getJobConfiguration());
+            Hibernate.initialize(project.getWorkloads().get(0).getTestPlans());
+            commit();
         } catch (Exception e) {
-        	rollback();
+            rollback();
             LOG.info("No entities for Project id " + id);
-    	} finally {
-    		cleanup();
-    	}
-    	return project;
+        } finally {
+            cleanup();
+        }
+        return project;
     }
 
     /**
      * Override BaseDao to deep lookup finaAll Projects
      * This is very slow, thousands of queries, don't use this.
-     * 
+     *
      * @return the nonnull list of entities
-     * @throws HibernateException
-     *             if there is an error in persistence
+     * @throws HibernateException if there is an error in persistence
      */
     @Nonnull
     @Override
     public List<Project> findAll() throws HibernateException {
-    	List<Project> results = Collections.emptyList();
-    	EntityManager em = getEntityManager();
-    	try {
-    		begin();
-	        CriteriaBuilder cb = em.getCriteriaBuilder();
-	        CriteriaQuery<Project> query = cb.createQuery(Project.class);
-	        Root<Project> root = query.from(Project.class);
-	        Fetch<Project, Workload>  wl = root.fetch(Project.PROPERTY_WORKLOADS);
-	        wl.fetch(Workload.PROPERTY_JOB_CONFIGURATION);
-	        query.select(root);
-	        results = em.createQuery(query).getResultList();
-	        commit();
+        List<Project> results = Collections.emptyList();
+        EntityManager em = getEntityManager();
+        try {
+            begin();
+            CriteriaBuilder cb = em.getCriteriaBuilder();
+            CriteriaQuery<Project> query = cb.createQuery(Project.class);
+            Root<Project> root = query.from(Project.class);
+            Fetch<Project, Workload> wl = root.fetch(Project.PROPERTY_WORKLOADS);
+            wl.fetch(Workload.PROPERTY_JOB_CONFIGURATION);
+            query.select(root);
+            results = em.createQuery(query).getResultList();
+            commit();
         } catch (Exception e) {
-        	rollback();
+            rollback();
             e.printStackTrace();
             LOG.info("No entities found at all for Project");
-    	} finally {
-    		cleanup();
-    	}
-    	return results;
+        } finally {
+            cleanup();
+        }
+        return results;
     }
 
     /**
      * Shallow find of all Projects, used for debugger request.
      *
      * @return the nonnull list of entities
-     * @throws HibernateException
-     *             if there is an error in persistence
+     * @throws HibernateException if there is an error in persistence
      */
     @Nonnull
     public List<Project> findAllFast() throws HibernateException {
@@ -194,11 +190,11 @@ public List<Project> findAllFast() throws HibernateException {
         }
         return results;
     }
-    
+
     @Nullable
     public Project loadScripts(Integer ProjectId) {
-    	Project project = findByIdEager(ProjectId);
-    	if (project != null) {
+        Project project = findByIdEager(ProjectId);
+        if (project != null) {
             ScriptDao dao = new ScriptDao();
             for (TestPlan testPlan : project.getWorkloads().get(0).getTestPlans()) {
                 for (ScriptGroup scriptGroup : testPlan.getScriptGroups()) {

pom.xml

@@ -44,6 +44,7 @@
     <version.primefaces-ext>14.0.15</version.primefaces-ext>
     <version.jsr166>1.7.0</version.jsr166>
     <version.surefire>3.5.3</version.surefire>
+    <version.jacoco>0.8.11</version.jacoco>
     <version.junit>5.12.2</version.junit>
     <version.mockito>5.14.2</version.mockito>
     <version.httpclient>4.5.14</version.httpclient>
@@ -114,12 +115,14 @@
           <plugin>
             <groupId>org.jacoco</groupId>
             <artifactId>jacoco-maven-plugin</artifactId>
+            <version>${version.jacoco}</version>
             <configuration>
               <excludes>
                 <exclude>org/fife/**/*</exclude>
               </excludes>
             </configuration>
             <executions>
+              <!-- Unit test coverage -->
               <execution>
                 <id>default-prepare-agent</id>
                 <goals>
@@ -133,6 +136,8 @@
                   <goal>report</goal>
                 </goals>
               </execution>
+
+              <!-- Check rules -->
               <execution>
                 <id>default-check</id>
                 <goals>
@@ -855,6 +860,28 @@
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-surefire-report-plugin</artifactId>
           <version>${version.surefire}</version>
+          <executions>
+            <execution>
+              <id>unit-test-report</id>
+              <phase>verify</phase>
+              <goals>
+                <goal>report</goal>
+              </goals>
+              <configuration>
+                <outputName>unit-test-report</outputName>
+              </configuration>
+            </execution>
+            <execution>
+              <id>integration-test-report</id>
+              <phase>verify</phase>
+              <goals>
+                <goal>report</goal>
+              </goals>
+              <configuration>
+                <outputName>integration-test-report</outputName>
+              </configuration>
+            </execution>
+          </executions>
         </plugin>
 
         <plugin>
@@ -1013,6 +1040,7 @@
             <path>
               <groupId>org.projectlombok</groupId>
               <artifactId>lombok</artifactId>
+              <version>1.18.38</version>
             </path>
           </annotationProcessorPaths>
         </configuration>
@@ -1048,23 +1076,49 @@
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-project-info-reports-plugin</artifactId>
       </plugin>
+
+      <!-- Unit Tests Configuration -->
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-surefire-plugin</artifactId>
+        <version>${version.surefire}</version>
         <configuration>
           <!-- Sets the VM argument line used when unit tests are run. -->
           <argLine>${argLine}</argLine>
-          <excludedGroups>manual,integration,experimental</excludedGroups>
           <includes>
             <include>**/*Test.java</include>
             <include>**/*Spec.groovy</include>
           </includes>
+          <excludes>
+            <exclude>**/*IT.java</exclude>
+            <exclude>**/integration/**/*.java</exclude>
+          </excludes>
+          <excludedGroups>manual,integration,experimental</excludedGroups>
+        </configuration>
+      </plugin>
+      <!-- Integration Tests Configuration -->
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-failsafe-plugin</artifactId>
+        <version>${version.surefire}</version>
+        <executions>
+          <execution>
+            <goals>
+              <goal>integration-test</goal>
+              <goal>verify</goal>
+            </goals>
+          </execution>
+        </executions>
+        <configuration>
+          <includes>
+            <include>**/*IT.java</include>
+            <include>**/integration/**/*.java</include>
+          </includes>
         </configuration>
       </plugin>
     </plugins>
   </build>
 
-
   <reporting>
     <outputDirectory>${project.build.directory}/site</outputDirectory>
     <plugins>

readme.md

@@ -29,13 +29,14 @@ There are several profiles (for the initial build you should build the release p
 * coverage -- runs jacoco code coverage.
 * static-analysis -- runs checkstyle and findbugs.
 
+`mvn clean install` runs all unit tests and integration tests by default under their respective maven stages - `test` and `verify`.
 
 There are several artifacts that are important.
 * web/web_ui/target/tank.war -- the main deployment file. Intended for deployment to a tomcat web server.
 * agent/agentManager_pkg/target/agent-startup-pkg.zip -- the agent app that gets started when the agent starts and manages communicating with the tank controller and coordinating the tests.
 * tools/agent_debugger_pkg/target/Tank-Debugger-all.jar -- the visual debugger jar. can be launched to debug scripts or projects.
 * tools/script_filter_pkg/target/Tank-Script-Runner-all.jar -- the visual script filter tool for writing scripts to filter or manipulate scripts on import.
-* proxy-parent/proxy_pkg/target/Tank-Proxy-pkg.jar -- the proxy recording tool. A Tool to record scripts using your browser. 
+* proxy-parent/proxy_pkg/target/Tank-Proxy-pkg.jar -- the proxy recording tool. A Tool to record scripts using your browser.
 
 ## Quickstart
 There is a shell script to install and configure a standalone controller and agent and configured with a java database for 
@@ -44,6 +45,11 @@ It can be downloaded from our [public site](http://tank-public.s3-website-us-eas
 in the root of the distribution. You can use this version for small tests to try out the tools but should not use 
 it for large scale or production testing.
 
+## Integration Tests
+
+The integration tests are located in the `test_support` module. They are designed to test the REST API endpoints against the QA Tank environment.
+You can find more information in the [README](test_support/README.md) file in that module.
+
 ## Guides
 Installation guide and User guide can be found in the docs folder and are built with the source. and can also be found on our [wiki](https://github.com/intuit/Tank/wiki).
 

test_support/.gitignore

@@ -1 +1,2 @@
 /target
+/src/test/resources/test-config.properties