Add Maven Support

[danyaljj]

Original post
I can see some maven releases here:
https://bintray.com/nikola-ilo/maven/or-tools/view
Q: Why the releases are not continued? Are you guys planning to release a new version on maven?
A: Not done by Google LLC

For v8.0 we are migrating to use maven to create java package
Todo List:

• Use Maven in CMake based build
  • Add Maven package to CMake based build
  • Use Maven for samples (ortools/*/samples)
  • Use Maven for examples (examples/contrib examples/java)
  • Use Maven for tests (examples/tests)
• Use Maven in Make based build
  • Add Maven packages to Make based build
  • Use Maven for samples
  • Use Maven for examples
  • Use Maven for tests
• Rework archive to use Maven packages
  • Linux archive
  • MacOS archive
  • Windows archive
• Add internal doc in:
  • ortools/java/README.md
  • ortools/java/doc/local_pipeline.dot
  • cmake/doc/java.md

[lperron]

These are actual contributed and we did not do it.
I will contact the author to see if we can transfer it to or-tools.

Thanks

Laurent Perron | Operations Research | lperron@google.com | (33) 1 42 68 53
00

2016-06-30 0:20 GMT+02:00 Daniel Khashabi notifications@github.com:

I can see some maven releases here:
https://bintray.com/nikola-ilo/maven/or-tools/view

Why the releases are not continued? Are you guys planning to release a new
version on maven?

—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
#202, or mute the thread
https://github.com/notifications/unsubscribe/AKj17YzVqy9EP7GJ-Xo901KJQETAPzZ0ks5qQu-tgaJpZM4JBn-L
.

[punkeel]

I would definitely appreciate being able to integrate or-tools using Maven

[dlahlou]

Hello Punkeel,
It's on our to-do list to support Maven. Thank you.
Regards,
Driss

On Aug 26, 2016 03:36, "PunKeel" notifications@github.com wrote:

I would definitely appreciate being able to integrate or-tools using Maven

—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
#202 (comment), or mute
the thread
https://github.com/notifications/unsubscribe-auth/ASwpfG_r17r_em0h0ROiUDNRupAb5C2cks5qjkL8gaJpZM4JBn-L
.

[guizmaii]

Any news ?

[fcorneli]

Maven support would be interesting...

[Mizux]

hi all,

Yes I would like to provide a maven (gradle ? ivy ?) package for or-tools ASAP and ideas are welcome !

How I see it currently:
1.Have a clean and modern CMake project to replace Makefile (cf WIP mizux/cmake branch)
2. Have a gradle project with cpp-plugin/JNI to wrap libortools.so
3. Use gradle plugin "maven-publish'
4. Profit !

[gsavvid]

Hello,

I was wondering whether this feature is still planned to be included in v6.8 and also whether the due date of v6.8 (April 1st) is still valid.

[Mizux]

Hi,

Not sure it will be included in v6.8 and not sure when v6.8 will be out (more mid-april I think).
The Goal is to have a Release (which means a version (aka SHA1) generated on Linux/Mac/Win) every month if possible.
For features, it's a best effort basis and depends to the bugs/features found by the community.

So for Maven, I would say, hope to do it ASAP (so I put it in my kaban/ToDo list) but I can't really give you a strong/mandatory date...

[oliviercailloux]

I have prepared a Maven project to release Google OR-Tools for Java (meaning, the SWIG classes) in Maven central. Please see here. The goal is to be able to depend on it in my projects that use Google OR-Tools.

Please give me any comment you like, preferably soon if possible because I have other projects that depend on this for easy consumption.

I am ready to change the groupId if you prefer that I use Google’s (or artifactId if you prefer another one). Currently I put mine simply because there might be a question of trust (I am the one who release the code, after all, not Google, and users could want to know it for security reasons). OTOH, I certainly do not want to appear as trying to get credit for Google’s code.

I am also ready to hand it over to you if you prefer to release it yourself. That would be best, but only if you intend to release it soon… (Otherwise, I’d suggest I release under my groupId now and then hand it to you for the future releases.)

I still have to check for how to release to Maven central without javadoc, I believe it is required by default.

As the Maven release will include only the Java classes and not the native library (it’s there in my project just for the test but is not transmitted by Maven to consumers), users will still have to manually download the library (on linux, libjniortools.so and libortools.so). It does not seem possible to automate this in a clean way using Maven. At least, compilation will be made possible automatically thanks to this release.

[oliviercailloux]

The project is now published to Maven Central

[guizmaii]

Hi,

Any official release in Maven ?

[lalithsuresh]

@Mizux will the maven packages for release 8.0 be made available on Maven Central?

[Mizux]

This is the next step, but we need to test few things:

• how to sign package while still given the opportunity to build locally without the "official" token
• currently we have three "meta" packages
  • Linux: ortools-java depends on ortools-linux-x86-64
  • MacOS: ortools-java depends on ortools-darwin
  • Windows: ortools-java depends on ortools-win32-x86-64
• I don't know if the code generated for the meta package containing the java class is cross-platform and identical -> need to test
  if yes then we will be able to merge all ortools-java in one package and publish it to maven (ed this is what we do for .NET)
  ref: https://github.com/google/or-tools/tree/stable/ortools/java
  ref: https://github.com/google/or-tools/tree/stable/ortools/dotnet#complete-googleortools-package

I'll should work on it next week

[dillonmabry]

@Mizux any update on this or from someone else? I believe quite a few people would be very happy to have this added on maven central for Java since quite a few teams would be using this for optimization problems :)

[amucunguzi]

@dillonmabry our team has been using this: https://github.com/panavis/google-or-tools-maven. We hope that there will be an official release soon. @Mizux.

[suming]

@amucunguzi thank you for working on this! I saw that https://github.com/panavis/google-or-tools-maven doesn't have a dependency for mac -- is that on it's way at all?

[magneticflux-]

@suming My version #202 (comment) has all OS distributions available 👀

[lalithsuresh]

Yes, I've been using @magneticflux-'s version on OSX and it works fine.

[suming]

@magneticflux- & @lalithsuresh thank you for the heads-up, I just tested it out and it's great. I can develop locally on OSX and deploy on Linux easily. Appreciate it!

[dillonmabry]

@suming My version #202 (comment) has all OS distributions available 👀

Using this version currently with no issues, thanks for your support! Works as expected.

[ErickPol]

@suming My version #202 (comment) has all OS distributions available 👀

For those that had trouble running Makefile in order to install the jars follows a detailed set-up guide based on @magneticflux- 's solution:

1. Guarantee maven (mvn) executable folder (e.g. /bin) is on your classpath
2. Download binaries (version 8.0) for your OS at https://github.com/google/or-tools/releases/tag/v8.0. For Windows the link is https://github.com/google/or-tools/releases/download/v8.0/or-tools_VisualStudio2019-64bit_v8.0.8283.zip
3. Extract the zip file and run these 2 commands inside the folder:
   mvn org.apache.maven.plugins:maven-install-plugin:2.5.2:install-file -Dfile="ortools-win32-x86-64-8.0.8283.jar" -DpomFile="pom-runtime.xml"
mvn org.apache.maven.plugins:maven-install-plugin:2.5.2:install-file -Dfile="ortools-java-8.0.8283.jar" -DpomFile="pom-local.xml"
4. Add the following dependencies to your project (in my case, to run or-tools over windows) :
   <dependency> <groupId>com.skaggsm.ortools</groupId> <artifactId>ortools-natives-all</artifactId> <version>8.0.8283</version> <type>pom</type> </dependency> <dependency> <groupId>com.google.ortools</groupId> <artifactId>ortools-java</artifactId> <version>8.0.8283</version> </dependency> <dependency> <groupId>com.google.ortools</groupId> <artifactId>ortools-win32-x86-64</artifactId> <version>8.0.8283</version> </dependency>
5. Run a test file , calling first the loader and then setting up the solver:
   @Test public void test(){ OrToolsHelper.loadLibrary(); MPSolver solver = MPSolver.createSolver("SCIP"); }

[magneticflux-]

@suming My version #202 (comment) has all OS distributions available 👀

For those that had trouble running Makefile in order to install the jars follows a detailed set-up guide based on @magneticflux- 's solution:

1. Guarantee maven (mvn) executable folder (e.g. /bin) is on your classpath

2. Download binaries (version 8.0) for your OS at https://github.com/google/or-tools/releases/tag/v8.0. For Windows the link is https://github.com/google/or-tools/releases/download/v8.0/or-tools_VisualStudio2019-64bit_v8.0.8283.zip

3. Extract the zip file and run these 2 commands inside the folder:
   `mvn org.apache.maven.plugins:maven-install-plugin:2.5.2:install-file -Dfile="ortools-win32-x86-64-8.0.8283.jar" -DpomFile="pom-runtime.xml"`
   `mvn org.apache.maven.plugins:maven-install-plugin:2.5.2:install-file -Dfile="ortools-java-8.0.8283.jar" -DpomFile="pom-local.xml"`

4. Add the following dependencies to your project (in my case, to run or-tools over windows) :
   `       <dependency> <groupId>com.skaggsm.ortools</groupId> <artifactId>ortools-natives-all</artifactId> <version>8.0.8283</version> <type>pom</type> </dependency> <dependency> <groupId>com.google.ortools</groupId> <artifactId>ortools-java</artifactId> <version>8.0.8283</version> </dependency> <dependency> <groupId>com.google.ortools</groupId> <artifactId>ortools-win32-x86-64</artifactId> <version>8.0.8283</version> </dependency>`

5. Run a test file , calling first the loader and then setting up the solver:
   `   @Test public void test(){ OrToolsHelper.loadLibrary(); MPSolver solver = MPSolver.createSolver("SCIP"); }`

I'm not sure why you're installing both my distribution and the official one. You don't need both; mine has everything included and has extra extraction functionality.

[jbellis]

This is the next step, but we need to test few things:

Is there a ticket for maven central publishing?

[magneticflux-]

Is there a ticket for maven central publishing?

With the sunsetting of JCenter, this is more urgent for me in particular. I'm not keen on shouldering the cost of hosting large binaries myself going forward, so I'd like my solution to just depend on official binaries on Maven Central.

[Mizux]

FYI, first 8.2 RC (8.2.9004)
https://search.maven.org/search?q=g:com.google.ortools
https://mvnrepository.com/artifact/com.google.ortools

note: I failed the linux artifact which is currently depending on GLIBC 2.33 (archlinux ^^;)

example usage: https://github.com/or-tools/java_or-tools/blob/6df2f03abe2b869f197eafe4c0846a376dbe04a0/pom.xml#L51-L59

[lalithsuresh]

@Mizux thanks! I just tested the Darwin version and it works.

note: I failed the linux artifact which is currently depending on GLIBC 2.33

Could you elaborate more on this?

If it helps, I'm getting an error about needing GLIBC 2.29 when running on Ubuntu 18.04.

java.lang.UnsatisfiedLinkError: /tmp/ortools-java7239044082451951181/linux-x86-64/libjniortools.so: /lib/x86_64-linux-gnu/libm.so.6: version `GLIBC_2.29' not found (required by /tmp/ortools-java7239044082451951181/linux-x86-64/libortools.so)

[Mizux]

see #2520
TLDR the runtime has been built against GLIBC 33 (archlinux) need to build the package against an "older" Linux distro

[dillonmabry]

see #2520
TLDR the runtime has been built against GLIBC 33 (archlinux) need to build the package against an "older" Linux distro

This is great news, and we appreciate your hard work!

Question: Is there a solution to have this work with Docker? For example, it works fine for me locally but whenever I run my docker build it cannot find the JNI/Library resource files like it can when I run locally, it extracts and discovers them automatically with my Spring/Java build.

I am using JDK 11 and Maven if that helps.

Thank you!

[Mizux]

@dillonmabry let's open a new issue with your docker issue.
note: You are not the only one with this feedback IIRC but I was never be able to reproduce it...
see: https://github.com/or-tools/java_or-tools/blob/main/Dockerfile and https://github.com/or-tools/java_or-tools/runs/2441985470?check_suite_focus=true