Merge pull request #36 from brodybits/build-and-documentation-updates

build & documentation updates

Author: developernotes

.gitignore

@@ -9,3 +9,5 @@ build
 local.properties
 .idea/**
 *.iml
+*.aar
+*.jar

README.md

@@ -1,39 +1,41 @@
-To run, clone this repo and make sure you have the Android Studio installed:
-- SQLCipher for Android defines [compatibility support](https://github.com/sqlcipher/android-database-sqlcipher#compatibility), simply run on either an emulator or device.
-- More information can be found at [SQLCipher for Android](https://zetetic.net/sqlcipher/sqlcipher-for-android/).
+To run: clone this repo and open with a recent version of Android Studio, or [build from the command line](https://developer.android.com/studio/build/building-cmdline).
+
+It is possible to run on an emulator or device, as documented in the [SQLCipher for Android compatibility section](https://github.com/sqlcipher/android-database-sqlcipher#compatibility).
+
+More information can be found in [SQLCipher for Android](https://zetetic.net/sqlcipher/sqlcipher-for-android/).
 
 ### Creating A New Test
 
 1. Open this repository within Android Studio
 2. Add a new class within `net.zetetic.tests` package that extends `SQLCipherTest`:
 
-```
+```Java
 package net.zetetic.tests;
 
 import net.sqlcipher.database.SQLiteDatabase;
 
-public class DemoTest extends SQLCipherTest {
+public class AwesomeTest extends SQLCipherTest {
 
   @Override
   public boolean execute(SQLiteDatabase database) {
     try {
       // Add your scenario here
       return true;
-    }catch (Exception e){
+    } catch (Exception e) {
       return false;
     }
   }
 
   @Override
   public String getName() {
-    return "Demo Test";
+    return "Awesome Test";
   }
 }
 ```
 
-3. Add `DemoTest` to the [`TestSuiteRunner`](https://github.com/sqlcipher/sqlcipher-android-tests/blob/master/src/main/java/net/zetetic/tests/TestSuiteRunner.java):
+3. Add `AwesomeTest` to the [`TestSuiteRunner`](https://github.com/sqlcipher/sqlcipher-android-tests/blob/master/src/main/java/net/zetetic/tests/TestSuiteRunner.java):
 
+```Java
+tests.add(new AwesomeTest());
 ```
-tests.add(new DemoTest());
-```
-4. Build and run the application on an Android device/emulator
+4. Build and run the application on an Android device or emulator

app/build.gradle

@@ -19,18 +19,19 @@ android {
 }
 
 dependencies {
-  implementation fileTree(dir: 'libs', include: ['*.jar'])
+  // For testing JAR-based distribution:
+  // implementation files('libs/sqlcipher.jar')
 
-  // For testing zip-based distributions:
-  //implementation files('libs/sqlcipher.jar')
+  // For testing local AAR package:
+  // implementation (name: 'android-database-sqlcipher-4.4.0-release', ext: 'aar')
 
-  // For testing local AAR packages:
-  //implementation (name: 'android-database-sqlcipher-4.3.0-release', ext: 'aar')
+  // For testing on remote AAR reference:
+  implementation 'net.zetetic:android-database-sqlcipher:4.4.0@aar'
 
-
-  // For testing on remote AAR references:
-  implementation 'net.zetetic:android-database-sqlcipher:4.3.0@aar'
+  // Mandatory dependency:
   implementation "androidx.sqlite:sqlite:2.0.1"
+
+  // For Room tests:
   implementation "androidx.room:room-runtime:2.1.0"
   annotationProcessor "androidx.room:room-compiler:2.1.0"
 }

app/src/main/java/net/zetetic/tests/JavaClientLibraryVersionTest.java

@@ -4,7 +4,7 @@
 
 public class JavaClientLibraryVersionTest extends SQLCipherTest {
 
-  String expectedClientLibraryVersion = "4.3.0";
+  String expectedClientLibraryVersion = "4.4.0";
 
   @Override
   public boolean execute(SQLiteDatabase database) {
@@ -16,4 +16,4 @@ public boolean execute(SQLiteDatabase database) {
   public String getName() {
     return "Java Client Library Version Test";
   }
-}
+}

app/src/main/java/net/zetetic/tests/PragmaCipherVersionTest.java

@@ -6,7 +6,7 @@
 
 public class PragmaCipherVersionTest extends SQLCipherTest {
 
-    private final String CURRENT_CIPHER_VERSION = "4.3.0";
+    private final String CURRENT_CIPHER_VERSION = "4.4.0";
 
     @Override
     public boolean execute(SQLiteDatabase database) {
@@ -31,4 +31,4 @@ public boolean execute(SQLiteDatabase database) {
     public String getName() {
         return "PRAGMA cipher_version Test";
     }
-}
+}