Android Support: Exporting to Android Archive (AAR) #10271

atkawa7 · 2020-03-01T10:37:14Z

This pr add functionality to support android archives in vcpkg through exporting libs and includes to aar archives. This works similar to ndkports currently in the works by @DanAlbert . Once the archive is created then it can imported in the android as a native dependent.

Checkout the article "Native Dependencies in Android Studio 4.0" about prefab and native dependencies on https://android-developers.googleblog.com/2020/02/native-dependencies-in-android-studio-40.html

Checkout the prefab project on https://github.com/google/prefab

See NDK ports for more https://android.googlesource.com/platform/tools/ndkports

Todos

ability to auto build all android ports to support the 4 android Abis for i.e arm64-v8a, armeabi-v7a, x86_64, x86
prevent requiring port triple
Failing if port is not android specific
Testing on other platforms (tested on OS X)

Example exporting [jsoncpp]

Requires

maven
ndk
7zip or zip

The following packages are already built and will be exported:
    jsoncpp:x86-android
Exporting package jsoncpp...
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------< org.apache.maven:standalone-pom >-------------------
[INFO] Building Maven Stub Project (No POM) 1
[INFO] --------------------------------[ pom ]---------------------------------
[INFO]
[INFO] --- maven-install-plugin:2.4:install-file (default-cli) @ standalone-pom ---
[INFO] Installing<root>/prefab/jsoncpp/jsoncpp-1.9.2.aar to /.m2/repository/com/vcpkg/ndk/support/jsoncpp/1.9.2/jsoncpp-1.9.2.aar
[INFO] Installing <vcpkg_root>/prefab/jsoncpp/pom.xml to /.m2/repository/com/vcpkg/ndk/support/jsoncpp/1.9.2/jsoncpp-1.9.2.pom
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  0.301 s
[INFO] Finished at: 2020-03-01T10:18:15Z
[INFO] ------------------------------------------------------------------------
Successfuly installed jsoncpp. Checkout <vcpkg_root>/prefab/jsoncpp/aar

Export

prefab
└── jsoncpp
    ├── aar
    │   ├── AndroidManifest.xml
    │   ├── META-INF
    │   │   └── LICENCE
    │   └── prefab
    │       ├── modules
    │       │   └── jsoncpp
    │       │       ├── include
    │       │       │   └── json
    │       │       │       ├── allocator.h
    │       │       │       ├── assertions.h
    │       │       │       ├── autolink.h
    │       │       │       ├── config.h
    │       │       │       ├── forwards.h
    │       │       │       ├── json.h
    │       │       │       ├── json_features.h
    │       │       │       ├── reader.h
    │       │       │       ├── value.h
    │       │       │       ├── version.h
    │       │       │       └── writer.h
    │       │       ├── libs
    │       │       │   ├── android.arm64-v8a
    │       │       │   │   ├── abi.json
    │       │       │   │   └── libjsoncpp.so
    │       │       │   ├── android.armeabi-v7a
    │       │       │   │   ├── abi.json
    │       │       │   │   └── libjsoncpp.so
    │       │       │   ├── android.x86
    │       │       │   │   ├── abi.json
    │       │       │   │   └── libjsoncpp.so
    │       │       │   └── android.x86_64
    │       │       │       ├── abi.json
    │       │       │       └── libjsoncpp.so
    │       │       └── module.json
    │       └── prefab.json
    ├── jsoncpp-1.9.2.aar
    └── pom.xml

13 directories, 25 files

MVoz · 2020-03-02T02:31:13Z

Requires JAVA and Gradle ?

DanAlbert · 2020-03-02T03:43:30Z

Requires JAVA and Gradle ?

Gradle is required on the consumption end of this, but not on the production end.

The Java requirement comes from maven, which could be avoided if needed (it could also potentially be made an optional requirement).

MVoz · 2020-03-02T03:47:46Z

@DanAlbert
and if you look at the future\in advance, and not just in these edits

p/s/ in this version, everything is also fine if the working version

Zingam · 2020-03-03T12:18:16Z

@atkawa7 @DanAlbert android/ndk#916 (comment)
Can this be made to be used to build the prefabs you'll deliver?

Or maybe also integrated into AS UI (SDK Manager) to search, get/build and include packages manually/automatically with as little dependencies as possible and use what's available in the AS installation.

Requires JAVA and Gradle ?

Gradle is required on the consumption end of this, but not on the production end.

The Java requirement comes from maven, which could be avoided if needed (it could also potentially be made an optional requirement).

Zingam · 2020-03-03T12:32:11Z

@atkawa7 If at some point prefabs support: google/prefab#65 (comment) Can this feature be extended to produce debuggable prefabs? Or does this feature already do that?

atkawa7 · 2020-03-03T13:12:51Z

@Zingam that is doable. VCPKG supports debug libs but I didn't include them since prefabs doesn't support them yet. Once i google/prefab#65 is supported I am sure we can add the debugs.

Zingam · 2020-03-03T13:27:48Z

Thanx! I just wonder how all this stuff would fit into my current build system as I have custom Find*.cmake modules to build and configure the libraries I need. I use vcpkg for my Windows and Linux builds.

DanAlbert

I'm not very familiar with vcpkg, so please forgive any obviously incorrect review comments :)

toolsrc/include/vcpkg/export.prefab.h

toolsrc/src/vcpkg/export.cpp

toolsrc/src/vcpkg/export.prefab.cpp

toolsrc/src/vcpkg/export.cpp

toolsrc/src/vcpkg/export.prefab.cpp

DanAlbert · 2020-03-03T21:43:12Z

@atkawa7 @DanAlbert android/ndk#916 (comment)
Can this be made to be used to build the prefabs you'll deliver?

Not sure what the benefit would be. Getting this merged here makes it available to users. Us using it wouldn't make a difference.

Or maybe also integrated into AS UI (SDK Manager) to search, get/build and include packages manually/automatically with as little dependencies as possible and use what's available in the AS installation.

I don't think that's the right approach. Users should be fetching prebuilts, not building the libraries themselves. This patch makes it easy for someone to build the vcpkg corpus for Android and push them to maven as AARs. The better solution would be for someone to do that instead.

JackBoosY · 2020-03-04T02:30:03Z

/azp run

JackBoosY · 2020-03-04T03:04:10Z

It looks like we cannot use these changes to build vcpkg in Windows anymore.

atkawa7 · 2020-03-05T21:25:22Z

@DanAlbert Thank you for your good reviews. @JackBoosY @ras0219-msft See the news changes. Now its buildable on Visual Studio

atkawa7 · 2020-03-24T19:29:26Z

@JackBoosY @strega-nil @ras0219-msft Checkout the new changes

JackBoosY · 2020-03-27T03:12:39Z

CI test success.
@dan-shaw

dan-shaw · 2020-04-06T21:36:08Z

Passing CI now, and it looks like all review comments are fixed. Thanks @atkawa7 and everyone for the PR and reviews!

linquize · 2020-04-13T01:41:15Z

Should add the new files export.prefab.cpp, export.prefab.h to vcpkglib.vcxproj.filters

pthom · 2020-05-08T13:24:43Z

I hope the vcpkg doc will be updated soon in order to reflect this, since for the moment this feature is mostly hidden for users : the official doc about triplets only mentions info about outdated android standalone toolchains.

strega-nil · 2020-05-08T19:28:51Z

@pthom This isn't really a feature the vcpkg team knows much about; if you'd like to write up the docs, we'd absolutely appreciate it :) (or if @atkawa7 would like to come back and write docs!)

atkawa7 · 2020-05-09T04:35:46Z

@pthom @strega-nil there is currently documentation on how to integrate android archives
See this document https://github.com/microsoft/vcpkg/blob/master/docs/specifications/prefab.md

See #11052 for configuration issues that might pop up.

You need to create the four android triplets yourself. Initially I had added triplets but then removed them since android users need custom triplets.

pthom · 2020-05-09T10:16:59Z

@pthom This isn't really a feature the vcpkg team knows much about; if you'd like to write up the docs, we'd absolutely appreciate it :) (or if @atkawa7 would like to come back and write docs!)

My proposition, where I made some changes in the doc that would have helped me a lot:
#11264

Zingam · 2020-05-09T11:31:29Z

I am not a native English speaker but I think that there are some grammatical errors in the document. Also prefab.md isn't very descriptive unless you already know what you look for? Perhaps Android-prefab.md or something like that would be better?

atkawa7 · 2020-05-09T11:39:51Z

@Zingam I think just android is even better

* added android triplets * added android support to vcpkg * added export directories to git ignore * fix libraries naming * added vckpg sources to visual studio project files * rename file location * issue with std::string fs:path copy initialization * format path on VStudio * fix checks format cannot work on fs::path * support header only libraries * support using architecture instead of triplets * added prefab support * added debug logs and prefab debug flag * added support for empty packages i.e openssl

atkawa7 added 3 commits March 1, 2020 10:02

added android triplets

fbbefac

added android support to vcpkg

73a42da

added export directories to git ignore

9180b99

atkawa7 mentioned this pull request Mar 1, 2020

android support #5717

Closed

fix libraries naming

188f55e

NancyLi1013 assigned JackBoosY Mar 2, 2020

JackBoosY added the needs-feature-review label Mar 2, 2020

This was referenced Mar 3, 2020

[PKG] GeographicLib google/prefab#78

Closed

[PKG] SQLite google/prefab#57

Closed

[PKG] libopus google/prefab#44

Closed

Zingam mentioned this pull request Mar 3, 2020

A few questions? atkawa7/prefab-vpkg-integration-sample#1

Open

DanAlbert suggested changes Mar 3, 2020

View reviewed changes

JackBoosY added the waiting for response label Mar 4, 2020

atkawa7 added 5 commits March 5, 2020 19:31

added vckpg sources to visual studio project files

db08b93

rename file location

64493d2

issue with std::string fs:path copy initialization

a0a58f4

format path on VStudio

1be40f4

fix checks format cannot work on fs::path

6542bb8

JackBoosY removed the waiting for response label Mar 5, 2020

dan-shaw added the waiting for response label Mar 20, 2020

atkawa7 added 3 commits March 24, 2020 17:04

merge current master

45c51b9

support using architecture instead of triplets

a9e267c

added prefab support

2dc6600

JackBoosY requested a review from strega-nil March 25, 2020 01:48

JackBoosY added needs-feature-review and removed waiting for response labels Mar 25, 2020

atkawa7 added 2 commits March 25, 2020 12:08

added debug logs and prefab debug flag

58bda31

added support for empty packages i.e openssl

1e1ccd9

This was referenced Mar 27, 2020

[PKG]mbedtls google/prefab#86

Closed

[PKG]libpng google/prefab#51

Closed

dan-shaw added info:reviewed Pull Request changes follow basic guidelines and removed needs-feature-review labels Mar 28, 2020

dan-shaw merged commit 52b5dfd into microsoft:master Apr 6, 2020

atkawa7 deleted the allen/feature/android-support branch April 7, 2020 07:08

NancyLi1013 mentioned this pull request Apr 9, 2020

Warnings in bootstrap on Ubuntu 18.04 #10750

Closed

This was referenced Apr 27, 2020

Support new "prefab" AAR format dotnet/android#4436

Open

Eliminate bad error reporting "Value was null" #11052

Closed

atkawa7 mentioned this pull request Dec 9, 2020

Android prefab broken due to emscripten support #12359

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Android Support: Exporting to Android Archive (AAR) #10271

Android Support: Exporting to Android Archive (AAR) #10271

atkawa7 commented Mar 1, 2020 •

edited

Loading

MVoz commented Mar 2, 2020

DanAlbert commented Mar 2, 2020

MVoz commented Mar 2, 2020 •

edited

Loading

Zingam commented Mar 3, 2020

Zingam commented Mar 3, 2020 •

edited

Loading

atkawa7 commented Mar 3, 2020

Zingam commented Mar 3, 2020 •

edited

Loading

DanAlbert left a comment

DanAlbert commented Mar 3, 2020

JackBoosY commented Mar 4, 2020

JackBoosY commented Mar 4, 2020

atkawa7 commented Mar 5, 2020

atkawa7 commented Mar 24, 2020

JackBoosY commented Mar 27, 2020

dan-shaw commented Apr 6, 2020

linquize commented Apr 13, 2020

pthom commented May 8, 2020 •

edited

Loading

strega-nil commented May 8, 2020

atkawa7 commented May 9, 2020

pthom commented May 9, 2020

Zingam commented May 9, 2020

atkawa7 commented May 9, 2020

Android Support: Exporting to Android Archive (AAR) #10271

Android Support: Exporting to Android Archive (AAR) #10271

Conversation

atkawa7 commented Mar 1, 2020 • edited Loading

Todos

Example exporting [jsoncpp]

Requires

MVoz commented Mar 2, 2020

DanAlbert commented Mar 2, 2020

MVoz commented Mar 2, 2020 • edited Loading

Zingam commented Mar 3, 2020

Zingam commented Mar 3, 2020 • edited Loading

atkawa7 commented Mar 3, 2020

Zingam commented Mar 3, 2020 • edited Loading

DanAlbert left a comment

Choose a reason for hiding this comment

DanAlbert commented Mar 3, 2020

JackBoosY commented Mar 4, 2020

JackBoosY commented Mar 4, 2020

atkawa7 commented Mar 5, 2020

atkawa7 commented Mar 24, 2020

JackBoosY commented Mar 27, 2020

dan-shaw commented Apr 6, 2020

linquize commented Apr 13, 2020

pthom commented May 8, 2020 • edited Loading

strega-nil commented May 8, 2020

atkawa7 commented May 9, 2020

pthom commented May 9, 2020

Zingam commented May 9, 2020

atkawa7 commented May 9, 2020

atkawa7 commented Mar 1, 2020 •

edited

Loading

MVoz commented Mar 2, 2020 •

edited

Loading

Zingam commented Mar 3, 2020 •

edited

Loading

Zingam commented Mar 3, 2020 •

edited

Loading

pthom commented May 8, 2020 •

edited

Loading