Fix #138 add source code of parent Specifications in Vivid Reports.

renatoathaydes · Mar 25, 2018 · 84a7352 · 84a7352
1 parent 5d1b7b2
commit 84a7352
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 9 deletions.
diff --git a/src/main/groovy/com/athaydes/spockframework/report/vivid/SpecSourceCode.groovy b/src/main/groovy/com/athaydes/spockframework/report/vivid/SpecSourceCode.groovy
@@ -13,14 +13,19 @@ import org.spockframework.util.Nullable
 @CompileStatic
 class SpecSourceCode {
 
-    private final Map<String, FeatureSourceCode> features = [ : ]
+    private final Map<String, FeatureSourceCode> sourceCodeByFeatureName = [ : ]
+    private final LinkedHashSet<SpecSourceCode> parents = [ ]
+
+    void addParent( SpecSourceCode parent ) {
+        parents << parent
+    }
 
     void startBlock( MethodNode feature, String label, @Nullable String text ) {
-        features.get( feature.name, new FeatureSourceCode() ).startBlock( label, text )
+        sourceCodeByFeatureName.get( feature.name, new FeatureSourceCode() ).startBlock( label, text )
     }
 
     void addStatement( MethodNode feature, String statement, int lineNumber ) {
-        def currentFeature = features[ feature.name ]
+        def currentFeature = sourceCodeByFeatureName[ feature.name ]
         if ( currentFeature ) {
             statement = removeIndent( statement )
             currentFeature.addStatement( statement, lineNumber )
@@ -30,7 +35,21 @@ class SpecSourceCode {
     }
 
     List<BlockCode> getBlocks( String featureName ) {
-        features.get( featureName )?.blocks ?: [ ]
+        List<BlockCode> result = sourceCodeByFeatureName[ featureName ]?.blocks
+        if ( result == null ) {
+            log.debug( 'Unable to find code for feature "{}", will try in parent Specs: {}', featureName, parents )
+
+            Iterator<SpecSourceCode> parentIterator = parents.iterator()
+            while ( result == null ) {
+                if ( parentIterator.hasNext() ) {
+                    def parent = parentIterator.next()
+                    result = parent.getBlocks( featureName )
+                } else {
+                    break
+                }
+            }
+        }
+        return result ?: [ ]
     }
 
     static String removeIndent( String code ) {

diff --git a/src/main/groovy/com/athaydes/spockframework/report/vivid/SpecSourceCodeCollector.groovy b/src/main/groovy/com/athaydes/spockframework/report/vivid/SpecSourceCodeCollector.groovy
@@ -1,5 +1,6 @@
 package com.athaydes.spockframework.report.vivid
 
+import com.athaydes.spockframework.report.util.Utils
 import groovy.transform.CompileStatic
 import groovy.util.logging.Slf4j
 import org.codehaus.groovy.ast.MethodNode
@@ -20,7 +21,7 @@ class SpecSourceCodeCollector {
     final SourceLookup sourceLookup
     final ModuleNode module
 
-    private final Map<String, SpecSourceCode> specSourceCodeByClassName = [ : ] as ConcurrentHashMap
+    private static final Map<String, SpecSourceCode> specSourceCodeByClassName = [ : ] as ConcurrentHashMap
 
     @Nullable
     private String className
@@ -33,6 +34,7 @@ class SpecSourceCodeCollector {
     }
 
     void setClassName( String className ) {
+        log.debug( "Collecting code for class {}", className )
         this.@className = className
         specSourceCodeByClassName[ className ] = new SpecSourceCode()
     }
@@ -43,7 +45,17 @@ class SpecSourceCodeCollector {
 
     @Nullable
     SpecSourceCode getResultFor( String className ) {
-        specSourceCodeByClassName.remove( className )
+        def sourceCode = specSourceCodeByClassName[ className ]
+        if ( sourceCode ) {
+            def parentSpecs = Utils.getParentSpecNames( className )
+            for ( parentSpec in parentSpecs ) {
+                def parentCode = specSourceCodeByClassName[ parentSpec ]
+                if ( parentCode ) {
+                    sourceCode.addParent( parentCode )
+                }
+            }
+        }
+        sourceCode
     }
 
     void add( Statement statement ) {

diff --git a/src/main/groovy/com/athaydes/spockframework/report/vivid/SpecSourceCodeReader.groovy b/src/main/groovy/com/athaydes/spockframework/report/vivid/SpecSourceCodeReader.groovy
@@ -14,10 +14,10 @@ class SpecSourceCodeReader {
     @Nullable
     private SpecSourceCode specSourceCode
 
+    private final VividAstInspector inspector = new VividAstInspector()
+
     void read( SpecData data ) {
         try {
-            VividAstInspector inspector = new VividAstInspector()
-
             File file = Utils.getSpecFile( testSourceRoots, data )
             specSourceCode = inspector.load( file, Utils.getSpecClassName( data ) )
         } catch ( Exception e ) {
@@ -26,6 +26,6 @@ class SpecSourceCodeReader {
     }
 
     List<BlockCode> getBlocks( FeatureInfo feature ) {
-        return specSourceCode?.getBlocks( feature.name ) ?: []
+        return specSourceCode?.getBlocks( feature.name ) ?: [ ]
     }
 }
diff --git a/src/main/groovy/com/athaydes/spockframework/report/vivid/VividAstInspector.groovy b/src/main/groovy/com/athaydes/spockframework/report/vivid/VividAstInspector.groovy
@@ -1,5 +1,6 @@
 package com.athaydes.spockframework.report.vivid
 
+import com.athaydes.spockframework.report.vivid.VividAstInspector.AstSuccessfullyCaptured
 import groovy.transform.CompileStatic
 import groovy.util.logging.Slf4j
 import org.codehaus.groovy.ast.ClassCodeVisitorSupport