Skip to content

Commit

Permalink
Migrate LicenseCheckerTests to swift-testing
Browse files Browse the repository at this point in the history
  • Loading branch information
@Kyome22
Kyome22 committed Jan 28, 2025
1 parent 8cbf15f commit 1f3f36b
Show file tree
Hide file tree
Showing 2 changed files with 64 additions and 124 deletions.
8 changes: 4 additions & 4 deletions Tests/LicenseCheckerModuleTests/PackageParserTests.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import TestResources
@testable import LicenseCheckerModule

struct PackageParserTests {
let testResources = TestResources()
private let testResources = TestResources()

@Test("If workspace-state is normal, PackageParser initialization succeeds.")
func init_PackageParser_success() async throws {
Expand All @@ -27,7 +27,7 @@ struct PackageParserTests {
"The license file is successfully extracted.",
arguments: [LicenseType.apache, .mit, .bsd, .zlib, .boringSSL]
)
func extractLicense(_ licenseType: LicenseType) async throws {
func extract_license(_ licenseType: LicenseType) async throws {
let jsonPath = "SourcePackagesUnknown/workspace-state"
let jsonURL = try #require(testResources.getJsonUrl(jsonPath))
let packageParser = try #require(PackageParser(url: jsonURL))
Expand All @@ -43,7 +43,7 @@ struct PackageParserTests {
"The licence file is successfully extracted.",
arguments: [LicenseType.apache, .mit]
)
func extractLicence(_ licenseType: LicenseType) async throws {
func extract_licence(_ licenseType: LicenseType) async throws {
let jsonPath = "SourcePackagesUnknown/workspace-state"
let jsonURL = try #require(testResources.getJsonUrl(jsonPath))
let packageParser = try #require(PackageParser(url: jsonURL))
Expand All @@ -59,7 +59,7 @@ struct PackageParserTests {
"The license file is successfully parsed.",
arguments: [LicenseType.apache, .mit, .bsd, .zlib, .boringSSL]
)
func parseLicense(_ licenseType: LicenseType) async throws {
func parse_license(_ licenseType: LicenseType) async throws {
let jsonPath = "\(licenseType.containerDirectoryName)/workspace-state"
let jsonURL = try #require(testResources.getJsonUrl(jsonPath))
let packageParser = try #require(PackageParser(url: jsonURL))
Expand Down
180 changes: 60 additions & 120 deletions Tests/LicenseCheckerTests/LicenseCheckerTests.swift
View file
Original file line number Diff line number Diff line change
@@ -1,22 +1,24 @@
import XCTest
import Foundation
import Testing
import TestResources

final class LicenseCheckerTests: XCTestCase {
let testResources = TestResources()

struct LicenseCheckerTests {
private let testResources = TestResources()
/// Returns path to the built products directory.
var productsDirectory: URL {
#if os(macOS)
private var productsDirectory: URL {
#if os(macOS)
for bundle in Bundle.allBundles where bundle.bundlePath.hasSuffix(".xctest") {
return bundle.bundleURL.deletingLastPathComponent()
}
fatalError("couldn't find the products directory")
#else
#else
return Bundle.main.bundleURL
#endif
#endif
}

func test_invalid_args() throws {

@Test("If executed with invalid arguments, the command exits with instructions on how to use it.")
func pass_invalid_arguments() throws {
let licenseCheckerBinary = productsDirectory.appendingPathComponent("license-checker")
let process = Process()
process.executableURL = licenseCheckerBinary
Expand All @@ -26,7 +28,7 @@ final class LicenseCheckerTests: XCTestCase {
process.waitUntilExit()
let data = pipe.fileHandleForReading.readDataToEndOfFile()
let output = String(data: data, encoding: .utf8)

let expect = """
Error: Missing expected argument '--source-packages-path <source-packages-path>'
Expand All @@ -42,179 +44,117 @@ final class LicenseCheckerTests: XCTestCase {
--version Show the version.
-h, --help Show help information.\n\n
"""
XCTAssertEqual(output, expect)
XCTAssertEqual(process.terminationStatus, 64)
}

func test_Apache() throws {
let licenseCheckerBinary = productsDirectory.appendingPathComponent("license-checker")
let process = Process()
process.executableURL = licenseCheckerBinary
let pipe = Pipe()
process.standardOutput = pipe
let resourceURL = try XCTUnwrap(testResources.resourceURL)
let sourcePackagesURL = resourceURL.appendingPathComponent("SourcePackagesApache")
let whiteListURL = sourcePackagesURL.appendingPathComponent("white-list.json")
process.arguments = ["-s", sourcePackagesURL.absolutePath, "-w", whiteListURL.absolutePath]
try process.run()
process.waitUntilExit()
let data = pipe.fileHandleForReading.readDataToEndOfFile()
let output = try XCTUnwrap(String(data: data, encoding: .utf8))

XCTAssertTrue(output.hasSuffix("✅ No problems with library licensing.\n"))
XCTAssertEqual(process.terminationStatus, 0)
}

func test_MIT() throws {
let licenseCheckerBinary = productsDirectory.appendingPathComponent("license-checker")
let process = Process()
process.executableURL = licenseCheckerBinary
let pipe = Pipe()
process.standardOutput = pipe
let resourceURL = try XCTUnwrap(testResources.resourceURL)
let sourcePackagesURL = resourceURL.appendingPathComponent("SourcePackagesMIT")
let whiteListURL = sourcePackagesURL.appendingPathComponent("white-list.json")
process.arguments = ["-s", sourcePackagesURL.absolutePath, "-w", whiteListURL.absolutePath]
try process.run()
process.waitUntilExit()
let data = pipe.fileHandleForReading.readDataToEndOfFile()
let output = try XCTUnwrap(String(data: data, encoding: .utf8))

XCTAssertTrue(output.hasSuffix("✅ No problems with library licensing.\n"))
XCTAssertEqual(process.terminationStatus, 0)
}

func test_BSD() throws {
let licenseCheckerBinary = productsDirectory.appendingPathComponent("license-checker")
let process = Process()
process.executableURL = licenseCheckerBinary
let pipe = Pipe()
process.standardOutput = pipe
let resourceURL = try XCTUnwrap(testResources.resourceURL)
let sourcePackagesURL = resourceURL.appendingPathComponent("SourcePackagesBSD")
let whiteListURL = sourcePackagesURL.appendingPathComponent("white-list.json")
process.arguments = ["-s", sourcePackagesURL.absolutePath, "-w", whiteListURL.absolutePath]
try process.run()
process.waitUntilExit()
let data = pipe.fileHandleForReading.readDataToEndOfFile()
let output = try XCTUnwrap(String(data: data, encoding: .utf8))

XCTAssertTrue(output.hasSuffix("✅ No problems with library licensing.\n"))
XCTAssertEqual(process.terminationStatus, 0)
}

func test_zlib() throws {
let licenseCheckerBinary = productsDirectory.appendingPathComponent("license-checker")
let process = Process()
process.executableURL = licenseCheckerBinary
let pipe = Pipe()
process.standardOutput = pipe
let resourceURL = try XCTUnwrap(testResources.resourceURL)
let sourcePackagesURL = resourceURL.appendingPathComponent("SourcePackagesZlib")
let whiteListURL = sourcePackagesURL.appendingPathComponent("white-list.json")
process.arguments = ["-s", sourcePackagesURL.absolutePath, "-w", whiteListURL.absolutePath]
try process.run()
process.waitUntilExit()
let data = pipe.fileHandleForReading.readDataToEndOfFile()
let output = try XCTUnwrap(String(data: data, encoding: .utf8))

XCTAssertTrue(output.hasSuffix("✅ No problems with library licensing.\n"))
XCTAssertEqual(process.terminationStatus, 0)
#expect(output == expect)
#expect(process.terminationStatus == 64)
}

func test_BoringSSL() throws {

@Test(
"If the license type is contained in the whitelist, the command exits normally.",
arguments: [
"SourcePackagesApache",
"SourcePackagesMIT",
"SourcePackagesBSD",
"SourcePackagesZlib",
"SourcePackagesBoringSSL",
]
)
func check_license(_ directoryName: String) throws {
let licenseCheckerBinary = productsDirectory.appendingPathComponent("license-checker")
let process = Process()
process.executableURL = licenseCheckerBinary
let pipe = Pipe()
process.standardOutput = pipe
let resourceURL = try XCTUnwrap(testResources.resourceURL)
let sourcePackagesURL = resourceURL.appendingPathComponent("SourcePackagesBoringSSL")
let resourceURL = try #require(testResources.resourceURL)
let sourcePackagesURL = resourceURL.appendingPathComponent(directoryName)
let whiteListURL = sourcePackagesURL.appendingPathComponent("white-list.json")
process.arguments = ["-s", sourcePackagesURL.absolutePath, "-w", whiteListURL.absolutePath]
try process.run()
process.waitUntilExit()
let data = pipe.fileHandleForReading.readDataToEndOfFile()
let output = try XCTUnwrap(String(data: data, encoding: .utf8))
let output = try #require(String(data: data, encoding: .utf8))

XCTAssertTrue(output.hasSuffix("✅ No problems with library licensing.\n"))
XCTAssertEqual(process.terminationStatus, 0)
#expect(output.hasSuffix("✅ No problems with library licensing.\n"))
#expect(process.terminationStatus == 0)
}

func test_SomePackage() throws {

@Test("If the library name is contained in the whitelist, the command exits normally.")
func check_library() throws {
let licenseCheckerBinary = productsDirectory.appendingPathComponent("license-checker")
let process = Process()
process.executableURL = licenseCheckerBinary
let pipe = Pipe()
process.standardOutput = pipe
let resourceURL = try XCTUnwrap(testResources.resourceURL)
let resourceURL = try #require(testResources.resourceURL)
let sourcePackagesURL = resourceURL.appendingPathComponent("SourcePackagesSomePackage")
let whiteListURL = sourcePackagesURL.appendingPathComponent("white-list.json")
process.arguments = ["-s", sourcePackagesURL.absolutePath, "-w", whiteListURL.absolutePath]
try process.run()
process.waitUntilExit()
let data = pipe.fileHandleForReading.readDataToEndOfFile()
let output = try XCTUnwrap(String(data: data, encoding: .utf8))
let output = try #require(String(data: data, encoding: .utf8))

XCTAssertTrue(output.hasSuffix("✅ No problems with library licensing.\n"))
XCTAssertEqual(process.terminationStatus, 0)
#expect(output.hasSuffix("✅ No problems with library licensing.\n"))
#expect(process.terminationStatus == 0)
}

func test_workspace_state_broken() throws {

@Test("If the workspace-state.json is broken, the command exits with error message.")
func pass_broken_workspace_state() throws {
let licenseCheckerBinary = productsDirectory.appendingPathComponent("license-checker")
let process = Process()
process.executableURL = licenseCheckerBinary
let pipe = Pipe()
process.standardOutput = pipe
let resourceURL = try XCTUnwrap(testResources.resourceURL)
let resourceURL = try #require(testResources.resourceURL)
let sourcePackagesURL = resourceURL.appendingPathComponent("SourcePackagesWorkspaceStateBroken")
let whiteListURL = sourcePackagesURL.appendingPathComponent("white-list.json")
process.arguments = ["-s", sourcePackagesURL.absolutePath, "-w", whiteListURL.absolutePath]
try process.run()
process.waitUntilExit()
let data = pipe.fileHandleForReading.readDataToEndOfFile()
let output = try XCTUnwrap(String(data: data, encoding: .utf8))
let output = try #require(String(data: data, encoding: .utf8))

XCTAssertTrue(output.hasSuffix("error: Couldn't load workspace-state.json\n"))
XCTAssertEqual(process.terminationStatus, 1)
#expect(output.hasSuffix("error: Couldn't load workspace-state.json\n"))
#expect(process.terminationStatus == 1)
}

func test_white_list_broken() throws {

@Test("If the white-list.json is broken, the command exits with error message.")
func pass_broken_white_list() throws {
let licenseCheckerBinary = productsDirectory.appendingPathComponent("license-checker")
let process = Process()
process.executableURL = licenseCheckerBinary
let pipe = Pipe()
process.standardOutput = pipe
let resourceURL = try XCTUnwrap(testResources.resourceURL)
let resourceURL = try #require(testResources.resourceURL)
let sourcePackagesURL = resourceURL.appendingPathComponent("SourcePackagesWhiteListBroken")
let whiteListURL = sourcePackagesURL.appendingPathComponent("white-list.json")
process.arguments = ["-s", sourcePackagesURL.absolutePath, "-w", whiteListURL.absolutePath]
try process.run()
process.waitUntilExit()
let data = pipe.fileHandleForReading.readDataToEndOfFile()
let output = try XCTUnwrap(String(data: data, encoding: .utf8))
let output = try #require(String(data: data, encoding: .utf8))

XCTAssertTrue(output.hasSuffix("error: Couldn't load white-list.json\n"))
XCTAssertEqual(process.terminationStatus, 2)
#expect(output.hasSuffix("error: Couldn't load white-list.json\n"))
#expect(process.terminationStatus == 2)
}

func test_unknown_license() throws {

@Test("If an unknown type of license is found, the command exits with error message.")
func check_unknown_license() throws {
let licenseCheckerBinary = productsDirectory.appendingPathComponent("license-checker")
let process = Process()
process.executableURL = licenseCheckerBinary
let pipe = Pipe()
process.standardOutput = pipe
let resourceURL = try XCTUnwrap(testResources.resourceURL)
let resourceURL = try #require(testResources.resourceURL)
let sourcePackagesURL = resourceURL.appendingPathComponent("SourcePackagesUnknown")
let whiteListURL = sourcePackagesURL.appendingPathComponent("white-list.json")
process.arguments = ["-s", sourcePackagesURL.absolutePath, "-w", whiteListURL.absolutePath]
try process.run()
process.waitUntilExit()
let data = pipe.fileHandleForReading.readDataToEndOfFile()
let output = try XCTUnwrap(String(data: data, encoding: .utf8))
let output = try #require(String(data: data, encoding: .utf8))

XCTAssertTrue(output.hasSuffix("error: Library with forbidden license is found.\n"))
XCTAssertEqual(process.terminationStatus, 3)
#expect(output.hasSuffix("error: Library with forbidden license is found.\n"))
#expect(process.terminationStatus == 3)
}
}

Expand Down

0 comments on commit 1f3f36b

Please sign in to comment.