Android Gradle - how to include shared object with specific folder structure? - android

Normally when you use Android Gradle package, you can include individual shared objects (.so's) using configuration parameter jniLibs.srcDirs. .so file gets included in flat manner. But what if I want to include plugins into their own correspondent sub-folders ?
Also taking into account product flavors ?
I have uploaded at least one demo project over here:
https://sourceforge.net/p/syncproj/code/HEAD/tree/sampleScripts/AndroidGradlePackage
(In case if you want to play around by yourself - it's slightly simplified Android java-c++ project).
Currently folder structure is following:
bin\Debug\armeabi-v7a\libnative_lib.so
I want to add folder structure like this:
bin\Debug\armeabi-v7a\plugins
bin\Debug\armeabi-v7a\plugins\test1
bin\Debug\armeabi-v7a\plugins\test1\test1.so
There exists bug report over here:
https://issuetracker.google.com/issues/63707864
with status 'Won't fix' - but if this is not fixed - maybe there are some walkaround to it ?
I have tried at least what is mentioned on that page -
plugins folder structure gets created, with *so.recipe files inside, but no .so files for some reason - someone seems to filter .so out of there.
Most interesting thing is that generated file build\native-libs\native-libs.jar
indeed contains 1. *.so and 2. *.so.recipe files, but only 2nd gets included.
One of solutions mentioned over here:
https://medium.com/keepsafe-engineering/the-perils-of-loading-native-libraries-on-android-befa49dce2db
Attempts to replace java's 'System.loadLibrary' - but aren't there any simpler solution to this ?
So this solution can include *.so.recipe into .apk package: (Just in case if you want to try to continue with my approach) (Must be applied to project link above after dependencies)
dependencies {
implementation 'com.android.support.constraint:constraint-layout:1.0.2'
// See (*)
compile fileTree(dir: "$buildDir/native-libs", include: 'native-libs.jar')
}
// See (*)
task nativeLibsToJar(type: Zip) {
destinationDir file("$buildDir/native-libs")
baseName 'native-libs'
extension 'jar'
from fileTree(dir: getCurrentConfigAbiDir() + "/plugins", include: '**/*.so*')
// '/lib/armeabi-v7a' - same folder as in .apk package
into '/lib/' + getCurrentAbiFolder() + "/plugins"
}
//
// (*) Walk around issue of not being able to add files recursively from sub-folders as well.
// https://issuetracker.google.com/issues/63707864
//
tasks.withType(JavaCompile) {
compileTask -> compileTask.dependsOn(nativeLibsToJar)
}
//------------------------------------------------------------------------------------------------
// Helper functions
//------------------------------------------------------------------------------------------------
//
// Gets current Abi folder name, empty if not detected - for example "armeabi-v7a"
//
String getCurrentAbiFolder()
{
String[] props = getCommandLineArgs()
if( props.length != 2 )
return ""
String platform = props[0]
String config = props[1]
String r = ""
android.productFlavors.all { flavour ->
if( flavour.name.toLowerCase() == platform.toLowerCase() )
r = flavour.ndk.abiFilters.first().toLowerCase()
}
// println r
return r
}
String getCurrentConfigAbiDir()
{
String dirToZip = "DoesNotExists"
String[] props = getCommandLineArgs()
if( props.length != 2 )
return dirToZip
String platform = props[0]
String config = props[1]
android.productFlavors.all { flavour ->
if( flavour.name.toLowerCase() == platform.toLowerCase() )
dirToZip = "bin/" + config + "/" + flavour.ndk.abiFilters.first().toLowerCase()
}
// println dirToZip
return dirToZip
}

Related

notCompatibleWithConfigurationCache() not working with Gradle task, keeps Reusing configuration cache anyways

The configuration cache is enabled in the Gradle settings for the project, yet for this task it reuses the configuration cache anyways. Before I would always use the --no-configuration-cache flag since it would not edit the baseline file on consecutive runs. I updated Gradle and use notCompatibleWithConfigurationCache() in other tasks, yet only for this one it still reuses the configuration cache. How can I fix this? Is there another way I could read/write the file without having to use --no-configuration-cache?
This was the code I was using:
tasks.register("fixBaseline", Copy){
notCompatibleWithConfigurationCache()
List<String> fileList = []
// Read in file list
if (project.hasProperty("directory")) {
// Read in files from directory
String directoryPath = project.property(directoryProperty) as String
def fileNameFinder = new FileNameFinder()
def pathList = fileNameFinder.getFileNames("$rootDir$File.separator$directoryPath", "**/*.kt")
for (pathName in pathList) {
def f = file(pathName)
fileList.add(f.name)
}
}
// Remove lines from baseline
def baselineDir = "$rootDir/config/base"
def baselineFile = file("$rootDir/config/base/baseline.xml")
def outputFile = File.createTempFile("remove", ".tmp", baselineFile.getParentFile())
int linesRemoved = 0
project.logger.lifecycle("Clearing files from baseline...\n")
outputFile.withPrintWriter { outputWriter ->
baselineFile.eachLine { line, lineNumber ->
for (fileName in fileList){
if (line.contains(fileName)){
linesRemoved++
return
}
}
outputWriter.println(line)
}
}
// Rename temporary file to baseline.xml
from baselineDir
include outputFile.name
destinationDir file(baselineDir)
rename outputFile.name, baselineFile.name
project.logger.lifecycle("\nRemoved $linesRemoved lines")
project.logger.lifecycle('----------')
doLast {
project.delete(outputFile)
}
}

How to generate java files from swig?Is this done by gradle or do it with command line?

This is my Build.gradle file:-
project.ext {
// * SWIG options *
// This and the SWIG "task" at the bottom are loosely based on:
//
// http://androiddeveloper.co.il/using-swig/
swigModuleFiles = ['yourfy.i']
swigIncludeDirs = ['src/main/cpp/yourfy/src', 'src/main/cpp/yourfy/src/nxcommon/src/libnxcommon']
swigJavaOutputDir = file("src/main/java/com/yourfy/yourfy/swig").absolutePath
swigCxxOutputDir = file("src/main/cpp/swig").absolutePath
swigModuleFilesAbs = []
swigIncludeDirOpts = []
swigCxxModuleFilesAbs = []
swigModuleFiles.each { moduleFile ->
swigModuleFilesAbs.add(file("src/main/cpp/yourfy/src/yourfy/" + moduleFile).absolutePath)
swigCxxModuleFilesAbs.add(swigCxxOutputDir + "/" + moduleFile + ".cxx")
}
swigIncludeDirs.each { incDir ->
swigIncludeDirOpts.add("-I" + file(incDir).absolutePath)
}
}
// * Generate SWIG wrappers *
// Generate .java and .cxx files for the SWIG bindings.
//
// It has to be done in Gradle (as opposed to the native library's CMakeLists.txt), because
// Gradle calls the Java implementationr BEFORE running the native build, so the .java SWIG files will
// not have been generated yet when the implementationr runs. We have to ensure that they are generated
// before the Java implementationr runs.
//
// Thanks, Gradle!
//
// I would love to do this as a task, but unfortunately, it does not work. For some reason,
// when building from Android Studio (NOT when running Gradle from command line), CMake is
// actually invoked first, before any other tasks, which means that the Gradle-generated SWIG
// CXX source files might still be missing, which CMake then complains about and aborts. For
// now, we will have to run SWIG at the top level all the time to get it working. Right now,
// it's reasonably fast to do so, let's see how long this holds.
// More info:
def swigExec = '/usr/local/bin/swig'
// TODO: Add some auto-detection
if (project.hasProperty('swig.executable')) {
swigExec = project.property('swig.executable')
}
if (swigExec != null && file(swigExec).isFile()) {
file(project.swigJavaOutputDir).mkdirs()
file(project.swigCxxOutputDir).mkdirs()
// Delete previous output files (.cxx, .h and *.java in respective directories)
(file(project.swigJavaOutputDir).listFiles() + file(project.swigCxxOutputDir).listFiles()).each { file ->
if (file.name.toLowerCase().endsWith(".cxx")
|| file.name.toLowerCase().endsWith(".h")
|| file.name.toLowerCase().endsWith(".java")
) {
file.delete()
}
}
[project.swigModuleFilesAbs, project.swigCxxModuleFilesAbs].transpose().each { moduleFile, cxxFile ->
exec {
commandLine(
swigExec,
'-java',
'-c++',
'-package', 'com.yourfy.yourfy.swig',
*project.swigIncludeDirOpts,
'-outdir', project.swigJavaOutputDir,
'-o', cxxFile,
moduleFile
)
}
}
} else {
logger.error('Property swig.executable not set or invalid! You should set it in ' +
'the gradle.properties file of your gradle user home directory, pointing to ' +
'a SWIG > 3.0 executable')
}
How to generate swig wrapper files in android?There are some links added to here but still its not figure out.
Also tried following links also mentioned in the comment:-
Stackoverflow question link
Github link
I was trying both the links but didn't understand but still seems it difficult.

build.gradle: Copy directory before build

In my android application I use JNI to work with some C++ library sources.
These sources must be copied from own repository (".../Connection/Connection") into "src/main/jni/CoreLib/"
The problem is that I need to re-create "src/main/jni/CoreLib/" directory each build to delete unused files.
I also have a cpp file in "jni" folder, which is referencing already deleted file from "CoreLib" directory, which gives me an error because of his include:
#include "CoreLib/EventDispatcher.h" // "src/main/jni/MyCustomCppFile.cpp
I assume that compiler checks includes before my script is executed.
The question is: How can I recreate and copy all cpp sources into my "CoreLib" directory before any kind of compilation/linking validations? Or is there another workaround to get rid of this error?
Here's some of my build.gradle file:
task deleteCoreLibDir(type: Delete) {
println('Deleting CoreLib dir')
delete 'src/main/jni/CoreLib'
}
task createCoreLibDir {
File f = new File('src/main/jni/CoreLib/');
f.mkdirs();
if (f.exists()) {
println('Re-created CoreLib dir')
} else {
println('!!!! CoreLib dir was not created')
}
}
task copyConnectionFiles(type: Copy) {
println('Copying files from Core library to current project')
File thisProj = file('src');
File connectionDir = thisProj.parentFile.parentFile.parentFile.parentFile;
File f = new File(connectionDir, 'Connection/Connection'); // library folder
from f.absolutePath
into 'src/main/jni/CoreLib/'
include('**/*')
}
afterEvaluate {
android.applicationVariants.all { variant ->
variant.javaCompiler.dependsOn(deleteCoreLibDir)
variant.javaCompiler.dependsOn(createCoreLibDir)
variant.javaCompiler.dependsOn(copyConnectionFiles)
}
}
Thanks in advance!

Android Studio Gradle sourceSets copy

Android Studio 2.0 Preview 2, Gradle Wrapper 2.8, Mac OS X
-MainProjectWorkspace
-|-build.gradle
-|-settings.gradle
-|-gradle.properties
-|-gradle
-|-MyLibraryDependencies
-|-MyMainModule
--|-build.gradle
--|-build
--|-src
---|-androidTest
---|-main
----|-assets
----|-jniLibs
----|-libs
----|-java
-----|-com
----|-res
----|-AndroidManifest.xml
MyMainModule/build.gradle
//Not a single SourceSets configurations.
productFlavors {
flavor1 {
}
flavor2 {
}
}
buildTypes {
release {
}
debug {
}
}
A genius developer left System.out.println statements, instead of Log statements in several hundreds of Java source-files in 'src/main/java'. Ideally, we do not want Sysout statements getting bundled with either of the applicationVariants, specially flavor1Release and flavor2Release.
Before we make amends to those hundreds of Java source-files and eventually switch the Sysout statements to Log statements, we would need to turn them off urgently.
Two possible solutions -
Execute a simple script that will remove all the Sysout statements in the Java source-files in 'src/main/java'. But about that, variants flavor1Debug and flavor2Debug need the Loggers displaying what's going on in the App.
Execute a simple Gradle task at build-time, copy Java source-files from 'src/main/java' to 'src/release/java', ensuring Sysout statements are omitted.
Solution 2 appears to be quickest, easiest, elegant. Particularly when the Gradle Custom-task is executed independently. Except for that, Gradle-sync in Android-Studio seems to be copying everything from 'src/main' to 'src/release' including assets, jniLibs, libs, res and even the AndroidManifest.xml. Fortunately, the Java source-files are ripped-off the Sysout statements in 'src/release', which is the expected result, and ideally, only 'src/release/java' should remain without any other folders.
task prepareRelease(type: Task) {
Pattern sysoutRegex = Pattern.compile(<Sysout-Pattern>)
try {
File releaseFolder = file("src/release")
File mainFolder = file("src/main")
ByteArrayOutputStream output = new ByteArrayOutputStream()
exec {
commandLine = "sh"
args = ["-c", "find ${mainFolder.canonicalPath} -name '*' -type f -print ",
"| xargs egrep -l '${sysoutRegex.pattern()}'"]
standardOutput = output
}
def fileList = output.toString().split(System.getProperty("line.separator"))
fileList.each { line ->
File srcFile = file(line)
File destFile = file(srcFile.canonicalPath.replace("main", "release"))
def content = srcFile.readLines()
if (!destFile.exists()) {
destFile.parentFile.mkdirs()
destFile.createNewFile()
destFile.writable = true
}
destFile.withWriter { out ->
content.eachWithIndex { contentLine, index ->
if (!sysoutRegex.matcher(contentLine).find()) {
out.println contentLine
}
}
}
} catch (Exception fail) {
throw fail
}
}
There is nothing in the custom Gradle-task that may cause this error of making "src/release" an exact copy of "src/main", which was not intended to be.
Any pointers to prevent this default copy of "src/main" to "src/release" will be greatly appreciated.
Based off RaGe's comment - "How about using *.java as your find pattern instead of * ?"
Kudos. I was not supposed to break the "find | xargs egrep " before the '|' into two separate args in the args[] in the exec task. Indeed, a Genius!!!

New Relic in Android Studio - newrelic.properties - variants

I'm integrating New Relic in my project (with Android Studio & Gradle) which has 2 variants. Each variant has its own generated token, which I store in each variant's string.xml file.
In the New Relic documentation, it states the following:
In your project’s root directory (projectname/app), add a newrelic.properties file with the following line:
com.newrelic.application_token=generated_token
The problem is, if I do this, how can make the correct token appear for the correct variant? If this file must appear in the project root, I can't create one per variant, and so I'm forced to use the same token for both variants, which doesn't work for my requirements.
Any insight would be appreciated.
Okay, so after contacting the support team at New Relic, there is apparently no direct solution for this as of today, although they said they've opened a feature request, and so this problem might be solved soon.
From what I managed to understand, the reason this file is needed is so that the New Relic system can display an un-obfuscated error log when an exception occurs on a production version which has been obfuscated with ProGuard.
The New Relic system, with the help of this file, will upload the ProGuard mapping.txt file to the New Relic servers and associate it with your app according to the specified token. With this, New Relic can un-obfuscate stack traces and display a descriptive stack trace with actual class & method names, rather a, b, c, etc.
As a workaround, I was told that I can forego this file all together, if I upload the mapping file manually.
The mapping file can be found at:
build/outputs/proguard/release/mapping.txt
In order to manually upload the file, perform the following via command line:
curl -v -F proguard=#"<path_to_mapping.txt>" -H "X-APP-LICENSE-KEY:<APPLICATION_TOKEN>" https://mobile-symbol-upload.newrelic.com/symbol
This must be done for each variant which is being obfuscated with ProGuard (classically, release builds).
Source
Hope this helps someone else.
I solved creating some Gradle tasks. Please, take a look at https://discuss.newrelic.com/t/how-to-set-up-newrelic-properties-file-for-project-with-multiple-build-variants/46176/5
I following a code that worked pretty well for me.
Add the New Relic application token on a string resource file. i.e.: api.xml.
Create a new Gradle file. i.e: newrelic-util.gradle.
Add the following content on the newly created Gradle file:
apply plugin: 'com.android.application'
android.applicationVariants.all { variant ->
//<editor-fold desc="Setup New Relic property file">
def variantName = variant.name.capitalize()
def newRelicTasksGroup = "newrelic"
def projectDirPath = project.getProjectDir().absolutePath
def newRelicPropertyFileName = "newrelic.properties"
def newRelicPropertyFilePath = "${projectDirPath}/${newRelicPropertyFileName}"
// Cleanup task for New Relic property file creation process.
def deleteNewRelicPropertyFile = "deleteNewRelicPropertyFile"
def taskDeleteNewRelicPropertyFile = project.tasks.findByName(deleteNewRelicPropertyFile)
if (!taskDeleteNewRelicPropertyFile) {
taskDeleteNewRelicPropertyFile = tasks.create(name: deleteNewRelicPropertyFile) {
group = newRelicTasksGroup
description = "Delete the newrelic.properties file on project dir."
doLast {
new File("${newRelicPropertyFilePath}").with {
if (exists()) {
logger.lifecycle("Deleting file ${absolutePath}.")
delete()
} else {
logger.lifecycle("Nothing to do. File ${absolutePath} not found.")
}
}
}
}
}
/*
* Fix for warning message reported by task "newRelicMapUploadVariantName"
* Message:
* [newrelic] newrelic.properties was not found! Mapping file for variant [variantName] not uploaded.
* New Relic discussion:
* https://discuss.newrelic.com/t/how-to-set-up-newrelic-properties-file-for-project-with-multiple-build-variants/46176
*/
def requiredTaskName = "assemble${variantName}"
def taskAssembleByVariant = project.tasks.findByName(requiredTaskName)
def createNewRelicPropertyFileVariantName = "createNewRelicPropertyFile${variantName}"
// 0. Searching task candidate to be dependent.
if (taskAssembleByVariant) {
logger.debug("Candidate task to be dependent found: ${taskAssembleByVariant.name}")
// 1. Task creation
def taskCreateNewRelicPropertyFile = tasks.create(name: createNewRelicPropertyFileVariantName) {
group = newRelicTasksGroup
description = "Generate the newrelic.properties file on project dir.\nA key/value propety " +
"will be written in file to be consumed by newRelicMapUploadVariantName task."
logger.debug("Creating task: ${name}")
doLast {
def newRelicPropertyKey = "com.newrelic.application_token"
def newRelicStringResourceKey = "new_relic_key"
def targetResourceFileName = "api.xml"
def variantXmlResourceFilePath = "${projectDirPath}/src/${variant.name}/res/values/${targetResourceFileName}"
def mainXmlResourceFilePath = "${projectDirPath}/src/main/res/values/${targetResourceFileName}"
def xmlResourceFilesPaths = [variantXmlResourceFilePath, mainXmlResourceFilePath]
xmlResourceFilesPaths.any { xmlResourceFilePath ->
// 1.1. Searching xml resource file.
def xmlResourceFile = new File(xmlResourceFilePath)
if (xmlResourceFile.exists()) {
logger.lifecycle("Reading property from xml resource file: ${xmlResourceFilePath}.")
// 1.2. Searching for string name new_relic_key api.xml resource file.
def nodeResources = new XmlParser().parse(xmlResourceFile)
def nodeString = nodeResources.find {
Node nodeString -> nodeString.'#name'.toString() == newRelicStringResourceKey
}
// 1.3. Checking if string name new_relic_key was found.
if (nodeString != null) {
def newRelicApplicationToken = "${nodeString.value()[0]}"
logger.lifecycle("name:${nodeString.'#name'.toString()};" +
"value:${newRelicApplicationToken}")
// 1.4 Checking the content of newRelicApplicationToken
if (newRelicApplicationToken == 'null' || newRelicApplicationToken.allWhitespace) {
logger.warn("Invalid value for key ${newRelicStringResourceKey}. " +
"Please, consider configuring a value for key ${newRelicStringResourceKey}" +
" on ${xmlResourceFile.name} resource file for buildVariant: ${variantName}. " +
"The ${newRelicPropertyFileName} will be not created.")
return true // break the loop
}
// 1.5. File creation.
File fileProperties = new File(newRelicPropertyFilePath)
fileProperties.createNewFile()
logger.lifecycle("File ${fileProperties.absolutePath} created.")
// 1.6. Writing content on properties file.
def fileComments = "File generated dynamically by gradle task ${createNewRelicPropertyFileVariantName}.\n" +
"Don't change it manually.\n" +
"Don't track it on VCS."
new Properties().with {
load(fileProperties.newDataInputStream())
setProperty(newRelicPropertyKey, newRelicApplicationToken.toString())
store(fileProperties.newWriter(), fileComments)
}
logger.lifecycle("Properties saved on file ${fileProperties.absolutePath}.")
return true // break the loop
} else {
logger.warn("The key ${newRelicStringResourceKey} was not found on ${xmlResourceFile.absolutePath}.\n" +
"Please, consider configuring a key/value on ${xmlResourceFile.name} resource file for buildVariant: ${variantName}.")
return // continue to next xmlResourceFilePath
}
} else {
logger.error("Resource file not found: ${xmlResourceFile.absolutePath}")
return // continue next xmlResourceFilePath
}
}
}
}
// 2. Task dependency setup
// To check the task dependencies, use:
// logger.lifecycle("Task ${name} now depends on tasks:")
// dependsOn.forEach { dep -> logger.lifecycle("\tTask: ${dep}") }
tasks['clean'].dependsOn taskDeleteNewRelicPropertyFile
taskCreateNewRelicPropertyFile.dependsOn taskDeleteNewRelicPropertyFile
taskAssembleByVariant.dependsOn taskCreateNewRelicPropertyFile
} else {
logger.error("Required task ${requiredTaskName} was not found. " +
"The task ${createNewRelicPropertyFileVariantName} will be not created.")
}
//</editor-fold>
}
On app/build.gradle file, apply the Gradle file.
apply from: './newrelic-util.gradle'
That’s it. I created a file named newrelic-util.gradle on project app dir. If you execute the task assembleAnyVariantName, the task createNewRelicPropertyFileAnyVarianteName will be performed first. Tip: don’t track the generated file newrelic.properties file. Ignore it on your VCS.
Additionally, the task deleteNewRelicPropertyFile will be performed right before the tasks ‘clean’ and ‘createNewRelicPropertyFileAnyVarianteName’ in order to avoid a file with a wrong New Relic application token.

Categories

Resources