Add Support For Swift Package Manager

[100mango]

Fix #2719
#2557

Please Review:@ericvergnaud @hanjoes @parrt @ewanmellor Thanks a lot.

[parrt]

Hi @100mango is this PR still relevant given merging of #3301 previously? thanks!

[100mango]

Hi, @parrt I think this PR is still relevant

1. After I check the current master branch and 4.9.3 release. I found that there is no update support for the Swift Package Manager. So people still can't use Swift Package Manager Properly.
2. In my fork version (containing this PR change), it works with Swift Package Manager.
3. But I found that this PR will cause the swift target tests to fail. I would like to try to fix it later(it would be nice to have someone more familiar with this test script to help fix it :) ).
   Thank you for your response.

[parrt]

ok, I will leave this open. Maybe @hanjoes has some ideas

[hanjoes]

@100mango could you elaborate on how this PR is related to #1771? I saw that discussion was about unicode but this PR is for onboarding SPM.

You also mentioned this PR causes test failure, the integration results shows the tests are "cancelled" so hard to see what exactly is the failure.

[100mango]

@hanjoes Sorry for the mistake. This PR is related to SPM, not the Unicode problem.
#2719
#2557

The PR Changes will not affect the actual Antlr implementation, only change the Package.swift file to enable people to use SPM to adopt Antlr Swift runtime. like this:

let package = Package(
    name: "MyProject",
    platforms: [
        .macOS(.v11),
    ],
    products: [
      //.......
    ],
    dependencies: [
        .package(name: "Antlr4", url: "https://github.com/100mango/antlr4", from: "4.9.3"),
    ],
    targets: [
        .target(
            name: "MyTarget",
            dependencies: ["Antlr4"])
    ]
)

"the integration results shows the tests are "cancelled" so hard to see what exactly is the failure."

Can we manually trigger the test pipeline again to see the actual failure？ ( I think modifying the runtime/Swift/boot.py 's swift_test() method properly can fix these test failures. )

Thanks for your response.

[parrt]

hiya. try this log of build. if it helps, I see a lot of this:

/Users/macosx-ci-1/actions-runner/_work/antlr4/antlr4/runtime/Swift/Sources/Antlr4/tree/ParseTreeListener.swift:20:36: warning: using 'class' keyword for protocol inheritance is deprecated; use 'AnyObject' instead
public protocol ParseTreeListener: class {
                                   ^~~~~
                                   AnyObject

I just merged something that included AnyObject so maybe there's a version issue with the Swift on the build system?

[hanjoes]

The runtime unit tests are passing but the generated integration tests are having issues

scrolling down a bit, it seems we have lots of errors like:

[1/4] Compiling testcase_1633996911876 L.swift
/private/var/folders/85/3yb73nr53qgf68tmtfby5s3c0000gp/T/BaseSwiftTest-main-1633996911726/testcase-1633996911876/Sources/testcase-1633996911876/main.swift:1:8: error: no such module 'Antlr4'
import Antlr4
       ^
[2/4] Compiling testcase_1633996911876 LATN.swift
/private/var/folders/85/3yb73nr53qgf68tmtfby5s3c0000gp/T/BaseSwiftTest-main-1633996911726/testcase-1633996911876/Sources/testcase-1633996911876/main.swift:1:8: error: no such module 'Antlr4'
import Antlr4
       ^
[3/4] Compiling testcase_1633996911876 main.swift
/private/var/folders/85/3yb73nr53qgf68tmtfby5s3c0000gp/T/BaseSwiftTest-main-1633996911726/testcase-1633996911876/Sources/testcase-1633996911876/main.swift:1:8: error: no such module 'Antlr4'
import Antlr4
       ^

I'm wondering if there is something obvious missing, maybe the Antlr4 module was not generated because of this change.

[hanjoes]

@100mango i saw you added one line to boot.py:

check_call(["cd","./../.."])

there is a single dot before the first slash, was this intentional? maybe that's why boot.py couldn't find the SPM manifest.

[hanjoes]

but maybe not related, since it's only for unit tests.

i'm trying to set things up and see if i can run the tests locally.

[hanjoes]

it seems this line in the test rig builds the swift module, maybe we should update the working dir since the package manifest has been moved to the root folder of the project?

@100mango
@parrt

[100mango]

@100mango i saw you added one line to boot.py:

check_call(["cd","./../.."])

there is a single dot before the first slash, was this intentional? maybe that's why boot.py couldn't find the SPM manifest.

I need to write clearer code comments.

 #package.swift define in project root directory. 
 #The boot.py file is in projectRoot/runtime/Swift
 #So we back to project root directory. Then start swift test
 check_call(["cd","./../.."])

it seems this line in the test rig builds the swift module, maybe we should update the working dir since the package manifest has been moved to the root folder of the project?

@100mango @parrt

Yes, after moving the package.swift file to the root folder. We need to build/test swift runtime in the root folder.

swift build  //  should run in the folder containing  package.swift
swift test    //  should run in the folder containing package.swift

Thanks for your response. @parrt @hanjoes

[100mango]

but maybe not related, since it's only for unit tests.

i'm trying to set things up and see if i can run the tests locally.

👍👍👍 It would be helpful for development if we could run tests locally. I can't seem to find the relevant guidance document (for how to set tests up locally) at the moment.

[parrt]

Hi @100mango quick link before I head to bed... https://github.com/antlr/antlr4/blob/master/doc/antlr-project-testing.md has the info. cd to runtime-testsuite then to mvn -Dtest=swift.** test.

[100mango]

@parrt @hanjoes 👍

I successfully ran the test locally. (mvn -Dtest=swift.** test)

-------------------------------------------------------
 T E S T S
-------------------------------------------------------
Running org.antlr.v4.test.runtime.swift.TestListeners
Process exited with status 1
java.io.IOException: Process exited with status 1:
[1/10] Compiling testcase_1640934044953 TParserATN.swift
/private/var/folders/xt/7h_qf_8x29v30lh77xz3ms3h0000gn/T/BaseSwiftTest-main-1640934044580/testcase-1640934044953/Sources/testcase-1640934044953/main.swift:1:8: error: no such module 'Antlr4'
import Antlr4
       ^
//....Tons of logs

There seems to be a very large number of errors reported and it is difficult to find the root cause

How should I configure to test these test codes (set a breakpoint etc.)?

1. use IntelliJ IDEA
2. use JDK 1.8 ( not on JDK 11, tools.jar was removed in JDK 9. So we can't run tests on Java11. we will get error like: java: package com.sun.tools.javac.main does not exist )
3. run the tests

Thanks.

[100mango]

After changing ANTLR_RUNTIME_PATH in BaseSwiftTest.java

We can build/test Swift runtime in the root folder. 🎉 All tests pass.

Happy New Year. ( Best wishes from China 2021.12.31 21:47:08)

@parrt @hanjoes

[hanjoes]

great! thanks and happy new year!

[hanjoes]

this addresses #1774 as well,