allegro / swift-junit

A Swift library for creating JUnit XML test results that can be interpreted by tools such as Bamboo or Jenkins. Macos and Linux ready.

Swift Test Reporter

A Swift library for creating JUnit XML test results that can be interpreted by tools such as Bamboo or Jenkins.

Sample output:

<?xml version="1.0" encoding="UTF-8"?>
<testsuites>
  <testsuite tests="2" failures="0" disabled="0" errors="0" time="0.0013051033020019531" name="JUnitReporterTests">
    <testcase classname="SwiftTestReporterTests.JUnitReporterTests" name="testReporterShouldReturnXMLForEmptySuite" time="0.0007890462875366211"></testcase>
    <testcase classname="SwiftTestReporterTests.JUnitReporterTests" name="testReporterShouldReturnXMLForFailedTest" time="0.000516057014465332"></testcase>
  </testsuite>
  <testsuite tests="1" failures="1" disabled="0" errors="0" time="0.00021898746490478516" name="UtilsTests">
    <testcase classname="SwiftTestReporterTests.UtilsTests" name="testShouldReturnProperlyClassName" time="0.00021898746490478516">
      <failure message="Oh no!!"></failure>
    </testcase>
  </testsuite>
</testsuites>

How to use it?

Linux

Add SwiftTestReporter to Package.swift:

import PackageDescription

let package = Package(
  dependencies: [
    ...
    .package(url: "https://github.com/allegro/swift-junit.git", from: "2.0.0"),
    // or for Swift 4.x
    // .package(url: "https://github.com/allegro/swift-junit.git", from: .upToNextMajor(from: "1.0.0")),
                
  ]
  ...
  targets: [
    ...
    .testTarget(
      name: "AppTests",
      dependencies: [
        "App",
        "SwiftTestReporter"
      ]
    ),
  ]
)

Next, add:

import SwiftTestReporter

_ = TestObserver()

To LinuxMain.swift. Done.

XCode

In Project Navigator, select particular project:

Next, select test target:

Add a new property named Principal class and set it to SwiftTestReporter.TestObserver

swift-junit's Issues

Test xml.file is not generated

Hi, I am working on a Mac and I am building a plain Swift project (no Xcode project).
I've done all steps in the Readme (without the steps for Xcode, as it is no Xcode project) but no test.xml file is getting generated. What am I doing wrong or where can I find the generated junit xml-file?

I am doing the following:

swift build
Fetching https://github.com/alexaubry/HTMLString.git
Fetching https://github.com/allegro/swift-junit.git
Cloning https://github.com/alexaubry/HTMLString.git
Resolving https://github.com/alexaubry/HTMLString.git at 5.0.0
Cloning https://github.com/allegro/swift-junit.git
Resolving https://github.com/allegro/swift-junit.git at 2.0.0

swift test
...
Test Suite 'All tests' passed at 2020-11-02 14:52:15.834.
         Executed 2 tests, with 0 failures (0 unexpected) in 0.086 (0.086) seconds

This is my Package.swift:

// swift-tools-version:5.2
// The swift-tools-version declares the minimum version of Swift required to build this package.

import PackageDescription

let package = Package(
    name: "swiftExercise",
    dependencies: [
        .package(name: "SwiftTestReporter", url: "https://github.com/allegro/swift-junit.git", from: "2.0.0"),
    ],
    targets: [
        .target(name: "swiftExerciseLib"),
        .target(name: "swiftExerciseApp", dependencies: ["swiftExerciseLib"]),
        .testTarget(name: "swiftExerciseTests", dependencies: ["swiftExerciseLib", "SwiftTestReporter"]),
    ]
)

My Swift version: Apple Swift version 5.2.2 (swiftlang-1103.0.32.6 clang-1103.0.32.51)

Please tag version 2.0.1

Thanks @vi4m for merging my PRs. If you think it's stable enough, it would be great to tag version 2.0.1 so that spm can pull this in with a version tag.

I've verified the change off the master branch in my CI.

Upgrade

Test on the newest Swift (5.9) - upgrade CI Matrix.
Upgrade deprecated methods.

swift-junit does not compile on iOS

swift-junit does not compile on iOS. There seems to be a problem with the NSObject.className being unavailable on iOS.

Move CI to Github Actions

TODO

• remove Travis CI
• add Github Actions workflow

Integration on linux with "--enable-test-discovery"

Hi,

is there a way to use it with "--enable-test-discovery"?

As tests for linux are now automatically synthesised there is no LinuxMain.swift anymore.

Best, Patrick