Merge pull request bitrise-steplib#13 from bitrise-steplib/export-test-results-test-addon

Export test results test addon

Author: lszucs

bitrise.yml

@@ -17,6 +17,7 @@ workflows:
     - test-in-src-dir
     - test-in-root-tmp-dir
     - check-artifacts
+    - check-testaddon-export
 
   test-in-src-dir:
     title: Test android project & mono repo projects in source dir
@@ -102,6 +103,41 @@ workflows:
                 exit 1
             fi
 
+  check-testaddon-export:
+    steps:
+    - script:
+        title: purge previous build artifacts
+        inputs:
+        - content: ./gradlew clean
+    - script:
+        title: purge test deploy dir (will always cause ignorable cli error)
+        inputs:
+        - content: rm -rf $BITRISE_TEST_DEPLOY_DIR/*
+    - path::./:
+        title: run step with predefined inputs
+        inputs:
+        - module: app
+        - variant: Debug
+    - script:
+        title: check exported arftifacts
+        is_always_run: true
+        inputs:
+        - content: |-
+            #!/usr/bin/env bash
+            set -ex
+
+            # check directory and test-info.json existense
+            if [ $(find ${BITRISE_TEST_DEPLOY_DIR} -regex ".*/app-debug/test-info.json" | grep -c .) -eq 0 ]; then
+                echo "ERROR: ${BITRISE_TEST_DEPLOY_DIR} does not contain app-debug/test-info.json."
+                exit 1
+            fi
+
+            # check result xml existense
+            if [ ! $(find ${BITRISE_TEST_DEPLOY_DIR} -regex ".*/app-debug/TEST.*.xml" | grep -c .) -eq 2 ]; then
+                echo "ERROR: ${BITRISE_TEST_RESULT_DIR}/app-debug does not contain all test result XMLs."
+                exit 1
+            fi
+
   go-tests:
     steps:
     - go-list:

main.go

@@ -11,11 +11,14 @@ import (
 	"github.com/bitrise-io/go-utils/pathutil"
 	"github.com/bitrise-io/go-utils/sliceutil"
 	"github.com/bitrise-steplib/bitrise-step-android-unit-test/cache"
+	"github.com/bitrise-steplib/bitrise-step-android-unit-test/testaddon"
 	"github.com/bitrise-tools/go-android/gradle"
 	"github.com/bitrise-tools/go-steputils/stepconf"
 	shellquote "github.com/kballard/go-shellquote"
 )
 
+const resultArtifactPathPattern = "*TEST*.xml"
+
 // Configs ...
 type Configs struct {
 	ProjectLocation   string `env:"project_location,dir"`
@@ -32,9 +35,13 @@ func failf(f string, args ...interface{}) {
 	os.Exit(1)
 }
 
-func getArtifacts(gradleProject gradle.Project, started time.Time, pattern string) (artifacts []gradle.Artifact, err error) {
+func getArtifacts(gradleProject gradle.Project, started time.Time, pattern string, includeModuleName bool, isDirectoryMode bool) (artifacts []gradle.Artifact, err error) {
 	for _, t := range []time.Time{started, time.Time{}} {
-		artifacts, err = gradleProject.FindDirs(t, pattern, true)
+		if isDirectoryMode {
+			artifacts, err = gradleProject.FindDirs(t, pattern, includeModuleName)
+		} else {
+			artifacts, err = gradleProject.FindArtifacts(t, pattern, includeModuleName)
+		}
 		if err != nil {
 			return
 		}
@@ -173,7 +180,7 @@ func main() {
 	log.Infof("Export reports:")
 	fmt.Println()
 
-	reports, err := getArtifacts(gradleProject, started, config.ReportPathPattern)
+	reports, err := getArtifacts(gradleProject, started, config.ReportPathPattern, true, true)
 	if err != nil {
 		failf("Failed to find reports, error: %v", err)
 	}
@@ -187,7 +194,7 @@ func main() {
 	log.Infof("Export results:")
 	fmt.Println()
 
-	results, err := getArtifacts(gradleProject, started, config.ResultPathPattern)
+	results, err := getArtifacts(gradleProject, started, config.ResultPathPattern, true, true)
 	if err != nil {
 		failf("Failed to find results, error: %v", err)
 	}
@@ -196,6 +203,30 @@ func main() {
 		failf("Failed to export results, error: %v", err)
 	}
 
+	log.Infof("Export test results for test addon:")
+	fmt.Println()
+
+	resultXMLs, err := getArtifacts(gradleProject, started, resultArtifactPathPattern, false, false)
+	if err != nil {
+		log.Warnf("Failed to find test result XMLs, error: %s", err)
+	} else {
+		if baseDir := os.Getenv("BITRISE_TEST_RESULT_DIR"); baseDir != "" {
+			for _, artifact := range resultXMLs {
+				uniqueDir, err := getUniqueDir(artifact.Path)
+				if err != nil {
+					log.Warnf("Failed to export test results for test addon: cannot get export directory for artifact (%s): %s", err)
+					continue
+				}
+	
+				if err := testaddon.ExportArtifact(artifact.Path, baseDir, uniqueDir); err != nil {
+					log.Warnf("Failed to export test results for test addon: %s", err)
+				}
+			}
+			log.Printf("  Exporting test results to test addon successful [ %s ] ", baseDir)
+		}
+	}
+
+
 	if testErr != nil {
 		os.Exit(1)
 	}
@@ -206,4 +237,4 @@ func main() {
 		log.Warnf("%s", warning)
 	}
 	log.Donef("  Done")
-}
+}

testaddon.go

@@ -0,0 +1,39 @@
+package main
+
+import (
+	"fmt"
+	"strings"
+	"unicode"
+)
+
+// getUniqueDir returns the unique subdirectory inside the test addon export diroctory for a given artifact.
+func getUniqueDir(path string) (string, error) {
+	parts := strings.Split(path, "/")
+	i := len(parts) - 1
+	for i > 0 && parts[i] != "test-results" {
+		i--
+	}
+
+	if i == 0 {
+		return "", fmt.Errorf("path (%s) does not contain 'test-results' folder", path)
+	}
+
+	if i+1 > len(parts) {
+		return "", fmt.Errorf("get variant name: out of index error")
+	}
+
+	variant := parts[i+1]
+	variant = strings.TrimPrefix(variant, "test")
+	variant = strings.TrimSuffix(variant, "UnitTest")
+
+	runes := []rune(variant)
+	runes[0] = unicode.ToLower(runes[0])
+	variant = string(runes)
+
+	if i < 2 {
+		return "", fmt.Errorf("get module name: out of index error")
+	}
+	module := parts[i-2]
+
+	return module + "-" + variant, nil
+}

testaddon/testaddon.go

@@ -0,0 +1,63 @@
+package testaddon
+
+import (
+	"encoding/json"
+	"fmt"
+	"os"
+	"path/filepath"
+
+	"github.com/bitrise-io/go-utils/command"
+)
+
+const (
+	// ResultDescriptorFileName is the name of the test result descriptor file.
+	ResultDescriptorFileName  = "test-info.json"
+)
+
+func generateTestInfoFile(dir string, data []byte) error {
+	f, err := os.Create(filepath.Join(dir, ResultDescriptorFileName))
+	if err != nil {
+		return err
+	}
+
+	if _, err := f.Write(data); err != nil {
+		return err
+	}
+
+	if err := f.Sync(); err != nil {
+		return err
+	}
+
+	if err := f.Close(); err != nil {
+		return err
+	}
+
+	return nil
+}
+
+// ExportArtifact exports artifact found at path in directory uniqueDir,
+// rooted at baseDir.
+func ExportArtifact(path, baseDir, uniqueDir string) error {
+		exportDir := filepath.Join(baseDir, uniqueDir)
+
+		if err := os.MkdirAll(exportDir, os.ModePerm); err != nil {
+			return fmt.Errorf("skipping artifact (%s): could not ensure unique export dir (%s): %s", path, exportDir, err)
+		}
+
+		if _, err := os.Stat(filepath.Join(exportDir, ResultDescriptorFileName)); os.IsNotExist(err) {
+			m := map[string]string{"test-name": uniqueDir}
+			data, err := json.Marshal(m)
+			if err != nil {
+				return fmt.Errorf("create test info descriptor: json marshal data (%s): %s", m, err)
+			}
+			if err := generateTestInfoFile(exportDir, data); err != nil {
+				return fmt.Errorf("create test info descriptor: generate file: %s", err)
+			}
+		}
+
+		name := filepath.Base(path)
+		if err := command.CopyFile(path, filepath.Join(exportDir, name)); err != nil {
+			return fmt.Errorf("failed to export artifact (%s), error: %v", name, err)
+		}
+	return nil
+}