fdroidserver.build module¶

Build a package from source.

fdroidserver.build.build_local(app, build, vcs, build_dir, output_dir, log_dir, srclib_dir, extlib_dir, tmp_dir, force, onserver, refresh)¶

Do a build locally.

Parameters:

app: The metadata of the app to build.
build: The build of the app to build.
vcs: The version control system controller object of the app.
build_dir: The local source-code checkout directory of the app.
output_dir: The target folder for the build result.
log_dir: The directory in the VM where the build logs are getting stored.
srclib_dir: The path to the srclibs directory, usually ‘build/srclib’.
extlib_dir: The path to the extlibs directory, usually ‘build/extlib’.
tmp_dir: The temporary directory for building the source tarball.
force: Don’t refresh the already cloned repository and make the build stop on exceptions.
onserver: Assume the build is happening inside the VM.
refresh: Enable fetching the latest refs from the VCS remote.

Raises:

BuildException: If running a sudo command failed, locking the root account failed, sudo couldn’t be removed, cleaning the build environment failed, skipping the scanning has been requested but scandelete is present, errors occurred during scanning, running the build commands from the metadata failed, building native code failed, building with the specified build method failed, no output could be found with build method maven, more or less than one APK were found with build method gradle, less or more than one APKs match the output glob specified in the metadata, running a postbuild command specified in the metadata failed, the built APK is debuggable, the unsigned APK is not at the expected location, the APK does not contain the expected versionName and versionCode or undesired package names have been found in the APK.
FDroidException: If no Android NDK version could be found and the build isn’t run in a builder VM, the selected Android NDK is not a directory.

fdroidserver.build.build_server(app, build, vcs, build_dir, output_dir, log_dir, force)¶

Do a build on the builder vm.

Parameters:

app: The metadata of the app to build.
build: The build of the app to build.
vcs: The version control system controller object of the app.
build_dir: The local source-code checkout directory of the app.
output_dir: The target folder for the build result.
log_dir: The directory in the VM where the build logs are getting stored.
force: Don’t refresh the already cloned repository and make the build stop on exceptions.

Raises:

BuildException: If Paramiko is not installed, a srclib directory or srclib metadata file is unexpectedly missing, the build process in the VM failed or output files of the build process are missing.
FDroidException: If the Buildserver ID could not be obtained or copying a directory to the server failed.

fdroidserver.build.force_gradle_build_tools(build_dir, build_tools)¶

Manipulate build tools version used in top level gradle file.

Parameters:

build_dir: The directory to start looking for gradle files.
build_tools: The build tools version that should be forced to use.

fdroidserver.build.force_halt_build(timeout)¶

Halt the currently running Vagrant VM, to be called from a Timer.

Parameters:

timeout: The timeout in seconds.

fdroidserver.build.get_metadata_from_apk(app, build, apkfile)¶

Get the required metadata from the built APK.

VersionName is allowed to be a blank string, i.e. ‘’

Parameters:

app: The app metadata used to build the APK.
build: The build that resulted in the APK.
apkfile: The path of the APK file.

Returns:

versionCode: The versionCode from the APK or from the metadata is build.novcheck is set.
versionName: The versionName from the APK or from the metadata is build.novcheck is set.

Raises:

BuildException: If native code should have been built but was not packaged, no version information or no package ID could be found or there is a mismatch between the package ID in the metadata and the one found in the APK.

fdroidserver.build.keep_when_not_allowed()¶: Control if APKs signed by keys not in AllowedAPKSigningKeys are removed.

fdroidserver.build.main()¶

Build a package from source.

The behaviour of this function is influenced by the configuration file as well as command line parameters.

Raises:

FDroidException: If more than one local metadata file has been found, no app metadata has been found, there are no apps to process, downloading binaries for checking the reproducibility of a built binary failed, the built binary is different from supplied reference binary, the reference binary is signed with a different signing key than expected, a VCS error occured while building an app or a different error occured while building an app.

fdroidserver.build.parse_commandline()¶

Parse the command line.

Returns:

options: The resulting options parsed from the command line arguments.
parser: The argument parser.

fdroidserver.build.transform_first_char(string, method)¶: Use method() on the first character of string.

fdroidserver.build.trybuild(app, build, build_dir, output_dir, log_dir, also_check_dir, srclib_dir, extlib_dir, tmp_dir, repo_dir, vcs, test, server, force, onserver, refresh)¶

Build a particular version of an application, if it needs building.

Parameters:

app: The metadata of the app to build.
build: The build of the app to build.
build_dir: The local source-code checkout directory of the app.
output_dir: The directory where the build output will go. Usually this is the ‘unsigned’ directory.
log_dir: The directory in the VM where the build logs are getting stored.
also_check_dir: An additional location for checking if the build is necessary (usually the archive repo).
srclib_dir: The path to the srclibs directory, usually ‘build/srclib’.
extlib_dir: The path to the extlibs directory, usually ‘build/extlib’.
tmp_dir: The temporary directory for building the source tarball of the app to build.
repo_dir: The repo directory - used for checking if the build is necessary.
vcs: The version control system controller object of the app to build.
test: True if building in test mode, in which case the build will always happen, even if the output already exists. In test mode, the output directory should be a temporary location, not any of the real ones.
server: Use buildserver VM for building.
force: Build app regardless of disabled state or scanner errors.
onserver: Assume the build is happening inside the VM.
refresh: Enable fetching the latest refs from the VCS remote.

Returns:

status: True if the build was done, False if it wasn’t necessary.