Add Support for Parsing .xctestrun file and use it to start xctest

ios/testmanagerd/xctestrunnerutils_test.go

@@ -0,0 +1,204 @@
+package testmanagerd
+
+import (
+	"fmt"
+	"os"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestParseXCTestRunFormatVersion1(t *testing.T) {
+	// Arrange: Create a temporary .xctestrun file with mock data
+	tempFile, err := os.CreateTemp("", "testfile*.xctestrun")
+	assert.NoError(t, err, "Failed to create temp file")
+	defer os.Remove(tempFile.Name()) // Cleanup after test
+
+	xcTestRunFileFormatVersion1 := `
+		<?xml version="1.0" encoding="UTF-8"?>
+		<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+		<plist version="1.0">
+			<dict>
+				<key>RunnerTests</key>
+				<dict>
+					<key>BlueprintName</key>
+					<string>RunnerTests</string>
+					<key>BlueprintProviderName</key>
+					<string>Runner</string>
+					<key>BlueprintProviderRelativePath</key>
+					<string>Runner.xcodeproj</string>
+					<key>BundleIdentifiersForCrashReportEmphasis</key>
+					<array>
+						<string>com.example.myApp</string>
+						<string>com.example.myApp.RunnerTests</string>
+					</array>
+					<key>CommandLineArguments</key>
+					<array/>
+					<key>DefaultTestExecutionTimeAllowance</key>
+					<integer>600</integer>
+					<key>DependentProductPaths</key>
+					<array>
+						<string>__TESTROOT__/Release-iphoneos/Runner.app</string>
+						<string>__TESTROOT__/Release-iphoneos/Runner.app/PlugIns/RunnerTests.xctest</string>
+					</array>
+					<key>DiagnosticCollectionPolicy</key>
+					<integer>1</integer>
+					<key>EnvironmentVariables</key>
+					<dict>
+						<key>APP_DISTRIBUTOR_ID_OVERRIDE</key>
+						<string>com.apple.AppStore</string>
+						<key>OS_ACTIVITY_DT_MODE</key>
+						<string>YES</string>
+						<key>SQLITE_ENABLE_THREAD_ASSERTIONS</key>
+						<string>1</string>
+						<key>TERM</key>
+						<string>dumb</string>
+					</dict>
+					<key>IsAppHostedTestBundle</key>
+					<true/>
+					<key>ParallelizationEnabled</key>
+					<true/>
+					<key>PreferredScreenCaptureFormat</key>
+					<string>screenRecording</string>
+					<key>ProductModuleName</key>
+					<string>RunnerTests</string>
+					<key>RunOrder</key>
+					<integer>0</integer>
+					<key>SystemAttachmentLifetime</key>
+					<string>deleteOnSuccess</string>
+					<key>TestBundlePath</key>
+					<string>__TESTHOST__/PlugIns/RunnerTests.xctest</string>
+					<key>TestHostBundleIdentifier</key>
+					<string>com.example.myApp</string>
+					<key>TestHostPath</key>
+					<string>__TESTROOT__/Release-iphoneos/Runner.app</string>
+					<key>TestLanguage</key>
+					<string></string>
+					<key>TestRegion</key>
+					<string></string>
+					<key>TestTimeoutsEnabled</key>
+					<false/>
+					<key>TestingEnvironmentVariables</key>
+					<dict>
+						<key>DYLD_INSERT_LIBRARIES</key>
+						<string>__TESTHOST__/Frameworks/libXCTestBundleInject.dylib</string>
+						<key>XCInjectBundleInto</key>
+						<string>unused</string>
+						<key>Test</key>
+						<string>xyz</string>
+					</dict>
+					<key>ToolchainsSettingValue</key>
+					<array/>
+					<key>UserAttachmentLifetime</key>
+					<string>deleteOnSuccess</string>
+					<key>OnlyTestIdentifiers</key>
+					<array>
+						<string>TestClass1/testMethod1</string>
+						<string>TestClass2/testMethod1</string>
+					</array>
+					<key>SkipTestIdentifiers</key>
+					<array>
+						<string>TestClass1/testMethod2</string>
+						<string>TestClass2/testMethod2</string>
+					</array>
+				</dict>
+				<key>__xctestrun_metadata__</key>
+				<dict>
+					<key>ContainerInfo</key>
+					<dict>
+						<key>ContainerName</key>
+						<string>Runner</string>
+						<key>SchemeName</key>
+						<string>Runner</string>
+					</dict>
+					<key>FormatVersion</key>
+					<integer>1</integer>
+				</dict>
+			</dict>
+		</plist>
+	`
+	_, err = tempFile.WriteString(xcTestRunFileFormatVersion1)
+	assert.NoError(t, err, "Failed to write mock data to temp file")
+	tempFile.Close()
+
+	// Act: Use the codec to parse the temp file
+	codec := NewXCTestRunCodec()
+	data, err := codec.ParseFile(tempFile.Name())
+
+	// Print the parsed data before asserting
+	fmt.Printf("Parsed Data: %+v\n", data)
+
+	// Assert: Verify the parsed data
+	assert.NoError(t, err, "Failed to parse .xctestrun file")
+	assert.NotNil(t, data, "Parsed data should not be nil")
+
+	// Assert TestHostBundleIdentifier value
+	assert.Equal(t, "com.example.myApp", data.RunnerTests.TestHostBundleIdentifier, "TestHostBundleIdentifier mismatch")
+
+	// Assert TestBundlePath value
+	assert.Equal(t, "__TESTHOST__/PlugIns/RunnerTests.xctest", data.RunnerTests.TestBundlePath, "TestBundlePath mismatch")
+
+	// Assert EnvironmentVariables values
+	assert.Equal(t, map[string]string{
+		"APP_DISTRIBUTOR_ID_OVERRIDE":     "com.apple.AppStore",
+		"OS_ACTIVITY_DT_MODE":             "YES",
+		"SQLITE_ENABLE_THREAD_ASSERTIONS": "1",
+		"TERM":                            "dumb",
+	}, data.RunnerTests.EnvironmentVariables, "EnvironmentVariables mismatch")
+
+	// Assert CommandLineArguments values
+	assert.Equal(t, []string{}, data.RunnerTests.CommandLineArguments, "CommandLineArguments mismatch")
+
+	// Assert TestingEnvironmentVariables values
+	assert.Equal(t, map[string]string{
+		"DYLD_INSERT_LIBRARIES": "__TESTHOST__/Frameworks/libXCTestBundleInject.dylib",
+		"XCInjectBundleInto":    "unused",
+		"Test":                  "xyz",
+	}, data.RunnerTests.TestingEnvironmentVariables, "TestingEnvironmentVariables mismatch")
+
+	// Assert OnlyTestIdentifiers values
+	assert.Equal(t, []string{
+		"TestClass1/testMethod1",
+		"TestClass2/testMethod1",
+	}, data.RunnerTests.OnlyTestIdentifiers, "OnlyTestIdentifiers mismatch")
+
+	// Assert SkipTestIdentifiers values
+	assert.Equal(t, []string{
+		"TestClass1/testMethod2",
+		"TestClass2/testMethod2",
+	}, data.RunnerTests.SkipTestIdentifiers, "SkipTestIdentifiers mismatch")
+
+	// Assert XCTestRunMetadata values
+	assert.Equal(t, 1, data.XCTestRunMetadata.FormatVersion, "FormatVersion mismatch")
+}
+
+func TestParseXCTestRunNotSupportedForFormatVersionOtherThanOne(t *testing.T) {
+	// Arrange: Create a temporary .xctestrun file with mock data
+	tempFile, err := os.CreateTemp("", "testfile*.xctestrun")
+	assert.NoError(t, err, "Failed to create temp file")
+	defer os.Remove(tempFile.Name()) // Cleanup after test
+
+	xcTestRunFileFormatVersion2 := `
+		<?xml version="1.0" encoding="UTF-8"?>
+		<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+		<plist version="1.0">
+		<dict>
+			<key>__xctestrun_metadata__</key>
+			<dict>
+				<key>FormatVersion</key>
+				<integer>2</integer>
+			</dict>
+		</dict>
+		</plist>
+	`
+	_, err = tempFile.WriteString(xcTestRunFileFormatVersion2)
+	assert.NoError(t, err, "Failed to write mock data to temp file")
+	tempFile.Close()
+
+	// Act: Use the codec to parse the temp file
+	codec := NewXCTestRunCodec()
+	_, err = codec.ParseFile(tempFile.Name())
+
+	// Assert the Error Message
+	assert.Equal(t, "go-ios currently only supports .xctestrun files in formatVersion 1: The formatVersion of your xctestrun file is 2, feel free to open an issue in https://github.com/danielpaulus/go-ios/issues to add support", err.Error(), "Error Message mismatch")
+}

ios/testmanagerd/xctestrunutils.go

@@ -0,0 +1,79 @@
+package testmanagerd
+
+import (
+	"bytes"
+	"errors"
+	"fmt"
+	"io"
+	"os"
+
+	log "github.com/sirupsen/logrus"
+	"howett.net/plist"
+)
+
+type XCTestRunData struct {
+	RunnerTests struct {
+		TestHostBundleIdentifier    string            `plist:"TestHostBundleIdentifier"`
+		TestBundlePath              string            `plist:"TestBundlePath"`
+		SkipTestIdentifiers         []string          `plist:"SkipTestIdentifiers"`
+		OnlyTestIdentifiers         []string          `plist:"OnlyTestIdentifiers"`
+		CommandLineArguments        []string          `plist:"CommandLineArguments"`
+		EnvironmentVariables        map[string]string `plist:"EnvironmentVariables"`
+		TestingEnvironmentVariables map[string]string `plist:"TestingEnvironmentVariables"`
+	} `plist:"RunnerTests"`
+	XCTestRunMetadata struct {
+		FormatVersion int `plist:"FormatVersion"`
+	} `plist:"__xctestrun_metadata__"`
+}
+
+// XCTestRunCodec handles encoding and decoding operations for .xctestrun files
+type XCTestRunCodec struct{}
+
+// NewXCTestRunCodec creates a new instance of XCTestRunCodec
+func NewXCTestRunCodec() XCTestRunCodec {
+	return XCTestRunCodec{}
+}
+
+// ParseFile reads the .xctestrun file and decodes it into a map
+func (codec XCTestRunCodec) ParseFile(filePath string) (XCTestRunData, error) {
+	file, err := os.Open(filePath)
+	if err != nil {
+		return XCTestRunData{}, fmt.Errorf("failed to open xctestrun file: %w", err)
+	}
+	defer file.Close()
+
+	xctestRunDate, err := codec.Decode(file)
+
+	// Verify that the FormatVersion is 1
+	if xctestRunDate.XCTestRunMetadata.FormatVersion != 1 {
+		log.Errorf("Invalid FormatVersion in .xctestrun file: got %d, expected 1", xctestRunDate.XCTestRunMetadata.FormatVersion)
+		return xctestRunDate, fmt.Errorf("go-ios currently only supports .xctestrun files in formatVersion 1: "+
+			"The formatVersion of your xctestrun file is %d, feel free to open an issue in https://github.com/danielpaulus/go-ios/issues to "+
+			"add support", xctestRunDate.XCTestRunMetadata.FormatVersion)
+	}
+
+	return xctestRunDate, err
+}
+
+// Decode reads and decodes the binary xctestrun content from a reader
+func (codec XCTestRunCodec) Decode(r io.Reader) (XCTestRunData, error) {
+	if r == nil {
+		return XCTestRunData{}, errors.New("reader was nil")
+	}
+
+	var result XCTestRunData
+	buf := new(bytes.Buffer)
+	_, err := io.Copy(buf, r) // Read the entire file content
+	if err != nil {
+		return XCTestRunData{}, fmt.Errorf("failed to read file content: %w", err)
+	}
+
+	// Decode the xctestrun content into the struct
+	_, err = plist.Unmarshal(buf.Bytes(), &result)
+	if err != nil {
+		return XCTestRunData{}, fmt.Errorf("failed to decode xctestrun content: %w", err)
+	}
+
+	log.Tracef("Successfully parsed .xctestrun file: %v", result)
+	return result, nil
+}

ios/testmanagerd/xcuitestrunner.go

@@ -7,6 +7,7 @@ import (
 	"io"
 	"maps"
 	"path"
+	"path/filepath"
 	"strings"
 
 	"github.com/Masterminds/semver"
@@ -249,6 +250,59 @@ type TestConfig struct {
 	Listener *TestListener
 }
 
+func StartXCTestWithConfig(ctx context.Context, xctestrunFilePath string, device ios.DeviceEntry, listener *TestListener) ([]TestSuite, error) {
+	// Parse the .xctestrun file to get the necessary details for TestConfig
+	codec := NewXCTestRunCodec()
+	result, err := codec.ParseFile(xctestrunFilePath)
+	if err != nil {
+		log.Errorf("Error parsing xctestrun file: %v", err)
+		return nil, err
+	}
+
+	testsToRunArg := result.RunnerTests.OnlyTestIdentifiers
+	var testsToRun []string
+	if testsToRunArg != nil && len(testsToRunArg) > 0 {
+		testsToRun = testsToRunArg
+	}
+
+	testsToSkipArg := result.RunnerTests.SkipTestIdentifiers
+	var testsToSkip []string
+	testsToSkip = nil
+	if testsToSkipArg != nil && len(testsToSkipArg) > 0 {
+		testsToSkip = testsToSkipArg
+	}
+
+	testEnv := make(map[string]any)
+
+	// Add EnvironmentVariables to the map
+	for key, value := range result.RunnerTests.EnvironmentVariables {
+		testEnv[key] = value
+	}
+
+	// Add TestingEnvironmentVariables to the map
+	for key, value := range result.RunnerTests.TestingEnvironmentVariables {
+		testEnv[key] = value
+	}
+
+	// Extract only the file name
+	var testBundlePath = filepath.Base(result.RunnerTests.TestBundlePath)
+
+	// Build the TestConfig object from parsed data
+	testConfig := TestConfig{
+		TestRunnerBundleId: result.RunnerTests.TestHostBundleIdentifier,
+		XctestConfigName:   testBundlePath,
+		Args:               result.RunnerTests.CommandLineArguments,
+		Env:                testEnv,
+		TestsToRun:         testsToRun,
+		TestsToSkip:        testsToSkip,
+		XcTest:             true,
+		Device:             device,
+		Listener:           listener,
+	}
+
+	return RunTestWithConfig(ctx, testConfig)
+}
+
 func RunTestWithConfig(ctx context.Context, testConfig TestConfig) ([]TestSuite, error) {
 	if len(testConfig.TestRunnerBundleId) == 0 {
 		return nil, fmt.Errorf("RunTestWithConfig: testConfig.TestRunnerBundleId can not be empty")
@@ -461,11 +515,14 @@ func startTestRunner17(appserviceConn *appservice.Connection, bundleID string, s
 			log.Debugf("adding extra env %s=%s", key, value)
 		}
 	}
+	var opts = map[string]interface{}{}
 
-	opts := map[string]interface{}{
-		"ActivateSuspended":   uint64(1),
-		"StartSuspendedKey":   uint64(0),
-		"__ActivateSuspended": uint64(1),
+	if !isXCTest {
+		opts = map[string]interface{}{
+			"ActivateSuspended":   uint64(1),
+			"StartSuspendedKey":   uint64(0),
+			"__ActivateSuspended": uint64(1),
+		}
 	}
 
 	appLaunch, err := appserviceConn.LaunchAppWithStdIo(