java-native / jssc

Java library for talking to serial ports (with added build support for maven, cmake, MSVC)
https://discord.gg/RBsUfE9sX9
GNU Lesser General Public License v3.0
172 stars 53 forks source link

Use github actions for testing PRs #151

Closed tresf closed 1 year ago

tresf commented 1 year ago

Adds dockerless CI jobs to compile and test for new PRs; removes Travis-CI which stopped running a while ago.

TODO:

Preview:

image
pietrygamat commented 1 year ago

@tresf regarding failing tests e.g. https://github.com/tresf/jssc/actions/runs/6807689668/job/18510958314 The build logs for ubuntu (x86_64, g++) shows the action order a bit off, and the tests fail, because they are not testing the correct version of the library:

Here's whats going on:

  1. Decide to run tests
  2. Copy resources (including precompiled binaries to target/classes
  3. Compile new natives, copy them to target/cmake/natives and src/main/resources-precompiled (too late!)
  4. Copy test resources from src/test/resources (nothing todo, we don't have any)
  5. Run test. Tests run in /target/classes, so the libs copied here in step 2 are loaded, because that's the default priority for native lib loader.

To fix this we should do one of:

First option seems cleanest and easiest - see: https://github.com/pietrygamat/jssc/commit/ca26e1a0e3390fed7e7788c57b3df8c74b724e97 https://github.com/pietrygamat/jssc/actions/runs/6818119903/job/18543034333

tresf commented 1 year ago

Whoa, great find. Do you have permission to push to my branch?

tresf commented 1 year ago

Hmm... I feel copying all natives to the test directory is an over-complicated approach, when we only need one library to complete the native tests. jssc.boot.library.path was really intended for exactly this purpose.

pietrygamat commented 1 year ago

Hmm... I feel copying all natives to the test directory is an over-complicated approach, when we only need one library to complete the native tests. jssc.boot.library.path was really intended for exactly this purpose.

That's effectively the same thing, because native compilation creates just one file per run.

tresf commented 1 year ago

Hmm... I feel copying all natives to the test directory is an over-complicated approach, when we only need one library to complete the native tests. jssc.boot.library.path was really intended for exactly this purpose.

That's effectively the same thing, because native compilation creates just one file per run.

Hmm... well, since we set the native library path in src/test/java/jssc/bootpath/ManualBootLibraryPathTest.java I feel like keeping this logic introduces less guesswork for future tests. I'm open to arguments to the contrary. Per cd632f9, I've moved the jssc.boot.library.path into a reusable helper.

tresf commented 1 year ago

That's effectively the same thing

I understand, but it introduces yet another copy to keep track of. I think testing the one we just built is better. Of course, this can fail if we skipped building too, which would fail the existing ManualBootLibraryPathTest. I'm not sure if we properly skip that when natives aren't built.

pietrygamat commented 1 year ago

yet another copy to keep track of.

Yeah, this is the confusing part for me. WHY do we even have the first copy in https://github.com/java-native/jssc/blob/0d106b74c04b75c2b8120aa08b78e8fa4f849590/CMakeLists.txt#L196 in the first place? CMake builds its artifacts to /target/cmake/natives, and keeps clean distinction between src and target, then it is explicitly broken. It looks to me it was an attempt to do the same thing I did today.

If we were to skip copying and use jssc.boot.library.path - it's fine by me by all means, but then let's please clean up this part too - and stop casually modifying source tree with build artifacts, as it may lead to accidental commits of broken artifacts.

Now that I think about it, we should only have one copy from cmake's /target/cmake/native to java's /target/classes (and not /src/). Jar's would be packaged correctly, test would execute as expected, and src-target convention would not be broken.

tresf commented 1 year ago

Hmm... I feel copying all natives to the test directory is an over-complicated approach, when we only need one library to complete the native tests. jssc.boot.library.path was really intended for exactly this purpose.

That's effectively the same thing, because native compilation creates just one file per run.

Sorry, this statement is right. I misunderstood.

tresf commented 1 year ago

in the first place? CMake builds its artifacts to /target/cmake/natives, and keeps clean distinction between src and target, then it is explicitly broken. It looks to me it was an attempt to do the same thing I did today.

Copying to src is so that it can (rather easily) be committed back into the source tree. We could argue that this task is best left as a dedicated maven step, but it's helpful for people that are forking the project and want to know the source path that gets updated when a native is rebuilt, so I vote to keep it for now.

If we were to skip copying and use jssc.boot.library.path - it's fine by me by all means, but then let's please clean up this part too - and stop casually modifying source tree with build artifacts, as it may lead to accidental commits of broken artifacts.

I accidentally committed one in this branch. I'm welcome to ideas. One workaround is to add the directory to the .gitignore so that we must explicitly commit it.

Now that I think about it, we should only have one copy from cmake's /target/cmake/native to java's /target/classes (and not /src/). Jar's would be packaged correctly, test would execute as expected, and src-target convention would not be broken.

THIS is the fix. I'm not sure if we should keep around the cmake/natives copy, but copying back to classes is the puzzle piece I was missing. I don't hate having a second copy though, as it ensures that jssc.boot.library.path is working.

8e6bc4a properly copies the recently compiled native library to target/classes/natives.

tresf commented 1 year ago

I think this is finally ready for merge. I was hoping to hear from @hiddenalpha in regards to Windows exception testing, but we can discuss that in another thread.

@pietrygamat in regards to polluting the source tree, I think that's a good conversation. Do you mind if we move it to another issue or to Discord?

Also, a final review is appreciated.