Skip to content

Commit

Permalink
[Android][Volley] Build fixes (OpenAPITools#18899)
Browse files Browse the repository at this point in the history 
* [android] Fix useAndroidMavenGradlePlugin type in template

* [android][volley] Use version variables in template

* [android][volley] Exclude httpclient

As it is incompatible with Android

* [android][volley] Resolve file conflict between httpcomponents modules

* [android] Update Gradle, the plugins, build tools

This fixes building with current Android Studio.

Android Gradle plugin version 8.0.0 was chosen for wider compatibility
with Android Studio versions (as far back as 2022.2.1).

The Maven plugin has been abandoned since the functionality is now
built in, and manual jar tasks are not necessary with it.

* [android] Regenerate samples
  • Loading branch information
@valpackett
valpackett authored Jun 16, 2024
1 parent 6f9ad31 commit 989a798
Show file tree
Hide file tree
Showing 24 changed files with 259 additions and 289 deletions.
7 changes: 3 additions & 4 deletions ...napi-generator/src/main/java/org/openapitools/codegen/languages/AndroidClientCodegen.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -459,8 +459,6 @@ public void processOpts() {
if (additionalProperties.containsKey(USE_ANDROID_MAVEN_GRADLE_PLUGIN)) {
this.setUseAndroidMavenGradlePlugin(Boolean.valueOf((String) additionalProperties
.get(USE_ANDROID_MAVEN_GRADLE_PLUGIN)));
} else {
additionalProperties.put(USE_ANDROID_MAVEN_GRADLE_PLUGIN, useAndroidMavenGradlePlugin);
}

if (additionalProperties.containsKey(ANDROID_GRADLE_VERSION)) {
Expand All @@ -483,8 +481,9 @@ public void processOpts() {
this.setSerializableModel(Boolean.valueOf(additionalProperties.get(CodegenConstants.SERIALIZABLE_MODEL).toString()));
}

// need to put back serializableModel (boolean) into additionalProperties as value in additionalProperties is string
// need to put back boolean properties into additionalProperties as the values in additionalProperties are strings
additionalProperties.put(CodegenConstants.SERIALIZABLE_MODEL, serializableModel);
additionalProperties.put(USE_ANDROID_MAVEN_GRADLE_PLUGIN, useAndroidMavenGradlePlugin);

//make api and model doc path available in mustache template
additionalProperties.put("apiDocPath", apiDocPath);
Expand Down Expand Up @@ -524,7 +523,7 @@ private void addSupportingFilesForVolley() {
supportingFiles.add(new SupportingFile("git_push.sh.mustache", "", "git_push.sh"));
supportingFiles.add(new SupportingFile("gitignore.mustache", "", ".gitignore"));
supportingFiles.add(new SupportingFile("pom.mustache", "", "pom.xml"));
// supportingFiles.add(new SupportingFile("settings.gradle.mustache", "", "settings.gradle"));
supportingFiles.add(new SupportingFile("settings.gradle.mustache", "", "settings.gradle"));
supportingFiles.add(new SupportingFile("build.mustache", "", "build.gradle"));
supportingFiles.add(new SupportingFile("manifest.mustache", projectFolder, "AndroidManifest.xml"));
supportingFiles.add(new SupportingFile("apiInvoker.mustache",
Expand Down
106 changes: 33 additions & 73 deletions modules/openapi-generator/src/main/resources/android/build.mustache
View file
Original file line number Diff line number Diff line change
@@ -1,50 +1,26 @@
{{#useAndroidMavenGradlePlugin}}
group = '{{groupId}}'
project.version = '{{artifactVersion}}'
{{/useAndroidMavenGradlePlugin}}

buildscript {
repositories {
maven { url "https://repo1.maven.org/maven2" }
jcenter()
}
dependencies {
{{#androidGradleVersion}}
classpath 'com.android.tools.build:gradle:{{{.}}}'
{{/androidGradleVersion}}
{{^androidGradleVersion}}
classpath 'com.android.tools.build:gradle:2.3.+'
{{/androidGradleVersion}}
{{#useAndroidMavenGradlePlugin}}
classpath 'com.github.dcendents:android-maven-gradle-plugin:1.5'
{{/useAndroidMavenGradlePlugin}}
}
plugins {
{{#androidGradleVersion}}
id 'com.android.library' version '{{{.}}}'
{{/androidGradleVersion}}
{{^androidGradleVersion}}
id 'com.android.library' version '8.0.0'
{{/androidGradleVersion}}
id 'maven-publish'
}

allprojects {
repositories {
jcenter()
}
}


apply plugin: 'com.android.library'
{{#useAndroidMavenGradlePlugin}}
apply plugin: 'com.github.dcendents.android-maven'
{{/useAndroidMavenGradlePlugin}}

android {
namespace "{{invokerPackage}}"
{{#androidSdkVersion}}
compileSdkVersion {{{.}}}
{{/androidSdkVersion}}
{{^androidSdkVersion}}
compileSdkVersion 25
compileSdkVersion 33
{{/androidSdkVersion}}
{{#androidBuildToolsVersion}}
buildToolsVersion '{{{.}}}'
{{/androidBuildToolsVersion}}
{{^androidBuildToolsVersion}}
buildToolsVersion '25.0.2'
buildToolsVersion '34.0.0'
{{/androidBuildToolsVersion}}
useLibrary 'org.apache.http.legacy'
defaultConfig {
Expand All @@ -53,27 +29,20 @@ android {
targetSdkVersion {{{.}}}
{{/androidSdkVersion}}
{{^androidSdkVersion}}
targetSdkVersion 25
targetSdkVersion 33
{{/androidSdkVersion}}
}
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}

// Rename the aar correctly
libraryVariants.all { variant ->
variant.outputs.each { output ->
def outputFile = output.outputFile
if (outputFile != null && outputFile.name.endsWith('.aar')) {
def fileName = "${project.name}-${variant.baseName}-${version}.aar"
output.outputFile = new File(outputFile.parent, fileName)
}
publishing {
singleVariant('release') {
withSourcesJar()
}
}
}


ext {
swagger_annotations_version = "1.6.6"
gson_version = "2.10.1"
Expand All @@ -83,38 +52,29 @@ ext {
}

dependencies {
compile "io.swagger:swagger-annotations:$swagger_annotations_version"
compile "com.google.code.gson:gson:$gson_version"
compile "org.apache.httpcomponents:httpcore:$httpcore_version"
compile "org.apache.httpcomponents:httpclient:$httpclient_version"
compile ("org.apache.httpcomponents:httpcore:$httpcore_version") {
implementation "io.swagger:swagger-annotations:$swagger_annotations_version"
implementation "com.google.code.gson:gson:$gson_version"
implementation "org.apache.httpcomponents:httpcore:$httpcore_version"
implementation "org.apache.httpcomponents:httpclient:$httpclient_version"
implementation ("org.apache.httpcomponents:httpcore:$httpcore_version") {
exclude(group: 'org.apache.httpcomponents', module: 'httpclient')
}
compile ("org.apache.httpcomponents:httpmime:$httpclient_version") {
implementation ("org.apache.httpcomponents:httpmime:$httpclient_version") {
exclude(group: 'org.apache.httpcomponents', module: 'httpclient')
}
testCompile "junit:junit:$junit_version"
testImplementation "junit:junit:$junit_version"
}

afterEvaluate {
android.libraryVariants.all { variant ->
def task = project.tasks.create "jar${variant.name.capitalize()}", Jar
task.description = "Create jar artifact for ${variant.name}"
task.dependsOn variant.javaCompile
task.from variant.javaCompile.destinationDirectory
task.destinationDirectory = project.file("${project.buildDir}/outputs/jar")
task.archiveFileName = "${project.name}-${variant.baseName}-${version}.jar"
artifacts.add('archives', task);
}
}
publishing {
publications {
release(MavenPublication) {
groupId = '{{groupId}}'
artifactId = '{{artifactId}}'
version = '{{artifactVersion}}'
{{#useAndroidMavenGradlePlugin}}
task sourcesJar(type: Jar) {
from android.sourceSets.main.java.srcDirs
classifier = 'sources'
}

artifacts {
archives sourcesJar
afterEvaluate {
from components.release
}
}
}
}
{{/useAndroidMavenGradlePlugin}}
2 changes: 1 addition & 1 deletion modules/openapi-generator/src/main/resources/android/gradle-wrapper.properties.mustache
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-6.7.1-bin.zip
distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-all.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
118 changes: 52 additions & 66 deletions modules/openapi-generator/src/main/resources/android/libraries/volley/build.mustache
View file
Original file line number Diff line number Diff line change
@@ -1,44 +1,35 @@
{{#useAndroidMavenGradlePlugin}}
group = '{{groupId}}'
project.version = '{{artifactVersion}}'
{{/useAndroidMavenGradlePlugin}}

buildscript {
repositories {
mavenLocal()
google()
maven {
url 'https://dl.google.com/dl/android/maven2'
}
jcenter()
}
dependencies {
classpath 'com.android.tools.build:gradle:3.2.+'
{{#useAndroidMavenGradlePlugin}}
classpath 'com.github.dcendents:android-maven-gradle-plugin:1.5'
{{/useAndroidMavenGradlePlugin}}
}
}

allprojects {
repositories {
google()
jcenter()
}
plugins {
{{#androidGradleVersion}}
id 'com.android.library' version '{{{.}}}'
{{/androidGradleVersion}}
{{^androidGradleVersion}}
id 'com.android.library' version '8.0.0'
{{/androidGradleVersion}}
id 'maven-publish'
}


apply plugin: 'com.android.library'
{{#useAndroidMavenGradlePlugin}}
apply plugin: 'com.github.dcendents.android-maven'
{{/useAndroidMavenGradlePlugin}}

android {
compileSdkVersion 26
buildToolsVersion '28.0.3'
namespace "{{invokerPackage}}"
{{#androidSdkVersion}}
compileSdkVersion {{{.}}}
{{/androidSdkVersion}}
{{^androidSdkVersion}}
compileSdkVersion 33
{{/androidSdkVersion}}
{{#androidBuildToolsVersion}}
buildToolsVersion '{{{.}}}'
{{/androidBuildToolsVersion}}
{{^androidBuildToolsVersion}}
buildToolsVersion '34.0.0'
{{/androidBuildToolsVersion}}
defaultConfig {
minSdkVersion 14
targetSdkVersion 26
{{#androidSdkVersion}}
targetSdkVersion {{{.}}}
{{/androidSdkVersion}}
{{^androidSdkVersion}}
targetSdkVersion 33
{{/androidSdkVersion}}
}
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
Expand All @@ -47,24 +38,23 @@ android {
lintOptions {
abortOnError false
}

// Rename the aar correctly
libraryVariants.all { variant ->
variant.outputs.all { output ->
if (outputFile != null && outputFileName.endsWith('.aar')) {
outputFileName = "${archivesBaseName}-${version}.aar"
}
}
packagingOptions {
resources.excludes += "META-INF/DEPENDENCIES"
}

testOptions {
unitTests.returnDefaultValues = true
}
publishing {
singleVariant('release') {
withSourcesJar()
}
}
}

ext {
swagger_annotations_version = "1.6.6"
gson_version = "2.10.1"
httpcore_version = "4.4.16"
httpmime_version = "4.5.14"
volley_version = "1.2.1"
junit_version = "4.13.2"
Expand All @@ -75,32 +65,28 @@ ext {
dependencies {
implementation "io.swagger:swagger-annotations:$swagger_annotations_version"
implementation "com.google.code.gson:gson:$gson_version"
implementation "org.apache.httpcomponents:httpmime:$httpmime_version"
implementation ("org.apache.httpcomponents:httpcore:$httpcore_version") {
exclude(group: "org.apache.httpcomponents", module: "httpclient")
}
implementation ("org.apache.httpcomponents:httpmime:$httpmime_version") {
exclude(group: "org.apache.httpcomponents", module: "httpclient")
}
implementation "com.android.volley:volley:${volley_version}"
testImplementation "junit:junit:$junit_version"
testImplementation "org.robolectric:robolectric:${robolectric_version}"
testImplementation "net.jodah:concurrentunit:${concurrent_unit_version}"
}

afterEvaluate {
android.libraryVariants.all { variant ->
def task = project.tasks.create "jar${variant.name.capitalize()}", Jar
task.description = "Create jar artifact for ${variant.name}"
task.dependsOn variant.javaCompile
task.from variant.javaCompile.destinationDirectory
task.destinationDirectory = project.file("${project.buildDir}/outputs/jar")
task.archiveFileName = "${project.name}-${variant.baseName}-${version}.jar"
artifacts.add('archives', task);
}
}

{{#useAndroidMavenGradlePlugin}}
task sourcesJar(type: Jar) {
from android.sourceSets.main.java.srcDirs
classifier = 'sources'
}
publishing {
publications {
release(MavenPublication) {
groupId = '{{groupId}}'
artifactId = '{{artifactId}}'
version = '{{artifactVersion}}'
artifacts {
archives sourcesJar
afterEvaluate {
from components.release
}
}
}
}
{{/useAndroidMavenGradlePlugin}}
16 changes: 16 additions & 0 deletions modules/openapi-generator/src/main/resources/android/settings.gradle.mustache
View file
Original file line number Diff line number Diff line change
@@ -1 +1,17 @@
pluginManagement {
repositories {
gradlePluginPortal()
google()
mavenCentral()
}
}

dependencyResolutionManagement {
repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
repositories {
google()
mavenCentral()
}
}

rootProject.name = "{{artifactId}}"
2 changes: 1 addition & 1 deletion samples/client/petstore/android/httpclient/.openapi-generator/VERSION
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
6.0.0-SNAPSHOT
7.7.0-SNAPSHOT
14 changes: 7 additions & 7 deletions samples/client/petstore/android/httpclient/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -117,13 +117,6 @@ Class | Method | HTTP request | Description
## Documentation for Authorization

Authentication schemes defined for the API:
### api_key

- **Type**: API key

- **API key parameter name**: api_key
- **Location**: HTTP header

### petstore_auth


Expand All @@ -134,6 +127,13 @@ Authentication schemes defined for the API:
- write:pets: modify pets in your account
- read:pets: read your pets

### api_key

- **Type**: API key

- **API key parameter name**: api_key
- **Location**: HTTP header


## Recommendation

Expand Down
Loading

0 comments on commit 989a798

Please sign in to comment.