Move libraries into their own folder

and remove sharedTest symlink hack. The shared tests are now a proper gradle module to avoid issues with using the same source files in different modules.

.gitlab-ci.yml

@@ -148,12 +148,12 @@ pages:
   only:
     - master
   script:
-    - ./gradlew :download:dokkaHtml :index:dokkaHtml :database:dokkaHtml
-    - mkdir public
-    - touch public/index.html
-    - cp -r download/build/dokka/html public/download
-    - cp -r index/build/dokka/html public/index
-    - cp -r database/build/dokka/html public/database
+    - ./gradlew :libs:download:dokkaHtml :libs:index:dokkaHtml :libs:database:dokkaHtml
+    - mkdir -p public/libs
+    - touch public/index.html public/libs/index.html
+    - cp -r libs/download/build/dokka/html public/libs/download
+    - cp -r libs/index/build/dokka/html public/libs/index
+    - cp -r libs/database/build/dokka/html public/libs/database
   artifacts:
     paths:
       - public
@@ -174,7 +174,7 @@ deploy_nightly:
     - echo "<item>${CI_PROJECT_PATH}-nightly</item>" >> app/src/main/res/values/default_repos.xml
     - echo "<item>${CI_PROJECT_URL}-nightly/raw/master/fdroid/repo</item>" >> app/src/main/res/values/default_repos.xml
     - cat config/nightly-repo/repo.xml >> app/src/main/res/values/default_repos.xml
-    - export DB=`sed -n 's,.*version *= *\([0-9][0-9]*\).*,\1,p' database/src/main/java/org/fdroid/database/FDroidDatabase.kt`
+    - export DB=`sed -n 's,.*version *= *\([0-9][0-9]*\).*,\1,p' libs/database/src/main/java/org/fdroid/database/FDroidDatabase.kt`
     - export versionCode=`printf '%d%05d' $DB $(date '+%s'| cut -b1-8)`
     - sed -i "s,^\(\s*versionCode\)  *[0-9].*,\1 $versionCode," app/build.gradle
     # build the APKs!

README.md

@@ -20,10 +20,7 @@ from our site or [browse it in the repo](https://f-droid.org/app/org.fdroid.fdro
 Core F-Droid functionality is split into re-usable libraries
 to make using F-Droid technology in your own projects as easy as possible.
 
-Note that all libraries are still in alpha stage.
-While they work, their public APIs are still subject to change.
-
-* [download](download) library for handling (multi-platform) HTTP download of repository indexes and APKs
+[More information about libraries](libs/README.md)
 
 ## Contributing
 

app/build.gradle

@@ -142,7 +142,9 @@ android {
 }
 
 dependencies {
-    implementation project(":download")
+    implementation project(":libs:download")
+    implementation project(":libs:index")
+    implementation project(":libs:database")
     implementation 'androidx.appcompat:appcompat:1.3.0'
     implementation 'androidx.preference:preference:1.1.1'
     implementation 'androidx.gridlayout:gridlayout:1.0.0'

download/README.md

@@ -1,40 +0,0 @@
-# F-Droid multi-platform download library
-
-Note that advanced security and privacy features are only available for Android:
-
-   * Rejection of TLS 1.1 and older as well as rejection of weak ciphers
-   * No DNS requests when using Tor as a proxy
-   * short TLS session timeout to prevent tracking and key re-use
-
-Other platforms besides Android have not been tested and might need additional work.
-
-## How to include in your project
-
-Add this to your `build.gradle` file
-and replace `[version]` with the [latest version](gradle.properties):
-
-    implementation 'org.fdroid:download:[version]'
-
-## Development
-
-You can list available gradle tasks by running the following command in the project root.
-
-    ./gradlew :download:tasks
-
-### Making releases
-
-Bump version number in [`gradle.properties`](gradle.properties), ensure you didn't break a public API and run:
-
-    ./gradlew :download:check :download:connectedCheck
-    ./gradlew :download:publish
-    ./gradlew closeAndReleaseRepository
-
-See https://github.com/vanniktech/gradle-maven-publish-plugin#gradle-maven-publish-plugin for more information.
-
-## License
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0

index/LICENSE

@@ -1,202 +0,0 @@
-
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.

index/README.md

@@ -1,41 +0,0 @@
-# F-Droid multi-platform index library
-
-Note that some features are only available for Android:
-
-   * index signature verification (`JarFile` is JVM only)
-   * index stream processing (`InputStream` is JVM only)
-   * index V2 diffing (reflection is JVM only)
-   * app device compatibility checking (requires Android)
-
-Other platforms besides Android have not been tested and might need additional work.
-
-## How to include in your project
-
-Add this to your `build.gradle` file
-and replace `[version]` with the [latest version](gradle.properties):
-
-    implementation 'org.fdroid:index:[version]'
-
-## Development
-
-You can list available gradle tasks by running the following command in the project root.
-
-    ./gradlew :index:tasks
-
-### Making releases
-
-Bump version number in [`gradle.properties`](gradle.properties), ensure you didn't break a public API and run:
-
-    ./gradlew :index:check :index:connectedCheck
-    ./gradlew :index:publish
-    ./gradlew closeAndReleaseRepository
-
-See https://github.com/vanniktech/gradle-maven-publish-plugin#gradle-maven-publish-plugin for more information.
-
-## License
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0

libs/README.md

@@ -0,0 +1,98 @@
+# F-Droid libraries
+
+Core F-Droid functionality is split into re-usable libraries
+to make using F-Droid technology in your own projects as easy as possible.
+
+Note that all libraries are still in alpha stage.
+While they work, their public APIs are still subject to change.
+
+* [download](libs/download) library for handling (multi-platform) HTTP download
+  of repository indexes and APKs
+* [index](libs/index) library for parsing/verifying/creating repository indexes
+* [database](libs/database) library to store and query F-Droid related information
+  in a Room-based database on Android
+
+## F-Droid multi-platform download library
+
+[API docs](https://fdroid.gitlab.io/fdroidclient/libs/download/)
+
+Note that advanced security and privacy features are only available for Android:
+
+* Rejection of TLS 1.1 and older as well as rejection of weak ciphers
+* No DNS requests when using Tor as a proxy
+* short TLS session timeout to prevent tracking and key re-use
+
+Other platforms besides Android have not been tested and might need additional work.
+
+### How to include in your project
+
+Add this to your `build.gradle` file
+and replace `[version]` with the [latest version](download/index/gradle.properties):
+
+    implementation 'org.fdroid:download:[version]'
+
+## F-Droid multi-platform index library
+
+[API docs](https://fdroid.gitlab.io/fdroidclient/libs/index/)
+
+Note that some features are only available for Android:
+
+   * index signature verification (`JarFile` is JVM only)
+   * index stream processing (`InputStream` is JVM only)
+   * index V2 diffing (reflection is JVM only)
+   * app device compatibility checking (requires Android)
+
+Other platforms besides Android have not been tested and might need additional work.
+
+### How to include in your project
+
+Add this to your `build.gradle` file
+and replace `[version]` with the [latest version](libs/index/gradle.properties):
+
+    implementation 'org.fdroid:index:[version]'
+
+## F-Droid Android database library
+
+[API docs](https://fdroid.gitlab.io/fdroidclient/libs/database/)
+
+An Android-only database library to store and query F-Droid related information
+such as repositories, apps and their versions.
+This library should bring everything you need to build your own F-Droid client
+that persists information.
+
+### How to include in your project
+
+Add this to your `build.gradle` file
+and replace `[version]` with the [latest version](libs/database/gradle.properties):
+
+    implementation 'org.fdroid:database:[version]'
+
+# Development
+
+You can list available gradle tasks by running the following command in the project root.
+
+    ./gradlew :download:tasks
+
+Replace `download` with the name of the library you want to view tasks for.
+
+# Making releases
+
+Bump version number in the library's [`gradle.properties`](gradle.properties),
+ensure you didn't break a public API and run:
+
+    ./gradlew :download:check :index:connectedCheck
+    ./gradlew :download:publish
+    ./gradlew closeAndReleaseRepository
+
+Replace `download` with the name of the library you want to publish.
+
+See https://github.com/vanniktech/gradle-maven-publish-plugin#gradle-maven-publish-plugin
+for more information.
+
+# License
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0

libs/database/build.gradle

@@ -10,7 +10,7 @@ android {
     compileSdkVersion 31
 
     defaultConfig {
-        minSdkVersion 22
+        minSdkVersion 21
 
         consumerProguardFiles "consumer-rules.pro"
         javaCompileOptions {
@@ -31,13 +31,9 @@ android {
     sourceSets {
         androidTest {
             java.srcDirs += "src/dbTest/java"
-            java.srcDirs += "src/sharedTest/kotlin"
-            assets.srcDirs += "src/sharedTest/resources"
         }
         test {
             java.srcDirs += "src/dbTest/java"
-            java.srcDirs += "src/sharedTest/kotlin"
-            assets.srcDirs += "src/sharedTest/resources"
         }
     }
     compileOptions {
@@ -65,8 +61,8 @@ android {
 }
 
 dependencies {
-    implementation project(":download")
-    implementation project(":index")
+    implementation project(":libs:download")
+    implementation project(":libs:index")
 
     implementation 'androidx.core:core-ktx:1.8.0'
     implementation 'androidx.lifecycle:lifecycle-livedata-ktx:2.4.1'
@@ -81,6 +77,7 @@ dependencies {
 
     implementation "org.jetbrains.kotlinx:kotlinx-serialization-json:1.3.2"
 
+    testImplementation project(":libs:sharedTest")
     testImplementation 'junit:junit:4.13.2'
     testImplementation 'io.mockk:mockk:1.12.4'
     testImplementation 'org.jetbrains.kotlin:kotlin-test'
@@ -90,6 +87,7 @@ dependencies {
     testImplementation 'org.robolectric:robolectric:4.8.1'
     testImplementation 'commons-io:commons-io:2.6'
 
+    androidTestImplementation project(":libs:sharedTest")
     androidTestImplementation 'io.mockk:mockk-android:1.12.3' // 1.12.4 has strange error
     androidTestImplementation 'org.jetbrains.kotlin:kotlin-test'
     androidTestImplementation 'androidx.test.ext:junit:1.1.3'

libs/download/build.gradle

@@ -99,7 +99,6 @@ android {
     }
     defaultConfig {
         minSdkVersion 21
-        targetSdkVersion 25
         testInstrumentationRunner 'androidx.test.runner.AndroidJUnitRunner'
         testInstrumentationRunnerArguments disableAnalytics: 'true'
     }

libs/download/lint.xml

@@ -1,7 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <lint>
-    <!-- TODO bump our targetSdkVersion when we are ready for it -->
-    <issue id="ExpiredTargetSdkVersion" severity="ignore"/>
     <issue id="GradleDependency" severity="warning"/>
     <issue id="InvalidPackage" severity="ignore"/>
 </lint>

libs/index/build.gradle

@@ -39,19 +39,17 @@ kotlin {
                 implementation "org.jetbrains.kotlinx:kotlinx-serialization-json:1.3.2"
                 implementation 'io.github.microutils:kotlin-logging:2.1.21'
 
-                implementation project(":download")
+                implementation project(":libs:download")
                 implementation "io.ktor:ktor-io:2.0.0"
             }
         }
-        sharedTest {
+        commonTest {
             dependencies {
+                implementation project(":libs:sharedTest")
                 implementation kotlin('test')
                 implementation "com.goncalossilva:resources:0.2.1"
             }
         }
-        commonTest {
-            dependsOn(sharedTest)
-        }
         // JVM is disabled for now, because Android app is including it instead of Android library
         jvmMain {
             dependencies {