Improved QRCode design

collect_app/build.gradle

@@ -263,6 +263,7 @@ dependencies {
 
     // Android Architecture Components:
     implementation "androidx.lifecycle:lifecycle-extensions:2.2.0"
+    implementation "androidx.viewpager2:viewpager2:1.0.0"
 
     // Dagger:
     implementation "com.google.dagger:dagger:${rootProject.daggerVersion}"

collect_app/src/androidTest/java/org/odk/collect/android/instrumented/settings/QrCodeTest.java

@@ -30,6 +30,8 @@
 import org.odk.collect.android.preferences.AdminSharedPreferences;
 import org.odk.collect.android.preferences.GeneralSharedPreferences;
 import org.odk.collect.android.preferences.PreferenceSaver;
+import org.odk.collect.android.preferences.qr.ObservableQRCodeGenerator;
+import org.odk.collect.android.preferences.qr.QRCodeGenerator;
 import org.odk.collect.android.utilities.QRCodeUtils;
 
 import java.io.IOException;
@@ -52,6 +54,7 @@
 public class QrCodeTest {
 
     private final GeneralSharedPreferences preferences = GeneralSharedPreferences.getInstance();
+    private final QRCodeGenerator qrCodeGenerator = new ObservableQRCodeGenerator();
 
     @Test
     public void importSettingsFromQrCode() throws JSONException, IOException, WriterException, DataFormatException, ChecksumException, NotFoundException, FormatException {
@@ -73,7 +76,7 @@ public void importSettingsFromQrCode() throws JSONException, IOException, Writer
 
         // generate QrCode
         final AtomicReference<Bitmap> generatedBitmap = new AtomicReference<>();
-        QRCodeUtils.getQRCodeGeneratorObservable(new ArrayList<>())
+        qrCodeGenerator.generateQRCode(new ArrayList<>())
                 .subscribe(generatedBitmap::set, Timber::e);
 
         assertNotNull(generatedBitmap.get());

collect_app/src/androidTest/java/org/odk/collect/android/preferences/qr/ConfigureWithQRCodeTest.java

@@ -0,0 +1,192 @@
+package org.odk.collect.android.preferences.qr;
+
+import android.Manifest;
+import android.app.Activity;
+import android.app.Instrumentation;
+import android.content.Intent;
+import android.graphics.Bitmap;
+import android.graphics.BitmapFactory;
+import android.net.Uri;
+
+import com.google.zxing.WriterException;
+
+import androidx.core.content.FileProvider;
+import androidx.test.core.app.ApplicationProvider;
+import androidx.test.espresso.intent.Intents;
+import androidx.test.espresso.intent.rule.IntentsTestRule;
+import androidx.test.ext.junit.runners.AndroidJUnit4;
+import androidx.test.rule.GrantPermissionRule;
+import dagger.Provides;
+import io.reactivex.Observable;
+
+import org.junit.Before;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.rules.RuleChain;
+import org.junit.runner.RunWith;
+import org.odk.collect.android.BuildConfig;
+import org.odk.collect.android.R;
+import org.odk.collect.android.activities.MainMenuActivity;
+import org.odk.collect.android.injection.config.AppDependencyModule;
+import org.odk.collect.android.storage.StoragePathProvider;
+import org.odk.collect.android.storage.StorageSubdirectory;
+import org.odk.collect.android.support.ResetStateRule;
+import org.odk.collect.android.support.pages.MainMenuPage;
+import org.odk.collect.android.utilities.FileUtils;
+
+import java.io.File;
+import java.io.IOException;
+import java.util.Collection;
+
+import static androidx.test.espresso.intent.Intents.intended;
+import static androidx.test.espresso.intent.Intents.intending;
+import static androidx.test.espresso.intent.matcher.BundleMatchers.hasEntry;
+import static androidx.test.espresso.intent.matcher.IntentMatchers.hasAction;
+import static androidx.test.espresso.intent.matcher.IntentMatchers.hasExtraWithKey;
+import static androidx.test.espresso.intent.matcher.IntentMatchers.hasExtras;
+import static androidx.test.espresso.intent.matcher.IntentMatchers.hasType;
+import static androidx.test.espresso.intent.matcher.IntentMatchers.isInternal;
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.equalTo;
+import static org.hamcrest.Matchers.not;
+
+import static org.junit.Assert.assertTrue;
+
+
+@RunWith(AndroidJUnit4.class)
+public class ConfigureWithQRCodeTest {
+    // drawable resource that will act as "qr code" in this test
+    private static final int CHECKER_BACKGROUND_DRAWABLE_ID = R.drawable.checker_background;
+
+    public IntentsTestRule<MainMenuActivity> rule = new IntentsTestRule<>(MainMenuActivity.class);
+
+    @Rule
+    public RuleChain copyFormChain = RuleChain
+            .outerRule(GrantPermissionRule.grant(
+                    Manifest.permission.READ_EXTERNAL_STORAGE,
+                    Manifest.permission.WRITE_EXTERNAL_STORAGE,
+                    Manifest.permission.READ_PHONE_STATE
+            ))
+            .around(new ResetStateRule(new AppDependencyModule() {
+                @Override
+                @Provides
+                public QRCodeGenerator providesQRCodeGenerator() {
+                    return new StubQRCodeGenerator();
+                }
+            }))
+            .around(rule);
+
+    @Before
+    public void stubAllExternalIntents() {
+        // By default Espresso Intents does not stub any Intents. Stubbing needs to be setup before
+        // every test run. In this case all external Intents will be blocked.
+        intending(not(isInternal())).respondWith(new Instrumentation.ActivityResult(Activity.RESULT_OK, null));
+    }
+
+    @Test
+    public void onMainMenu_clickConfigureQRCode_andClickingOnScan_opensScanner() {
+        new MainMenuPage(rule)
+                .assertOnPage()
+                .clickOnMenu()
+                .clickConfigureQR()
+                .clickScanFragment()
+                .checkIsIdDisplayed(R.id.zxing_barcode_surface);
+    }
+
+    @Test
+    public void onMainMenu_clickConfigureQRCode_andClickingOnView_showsQRCode() {
+        new MainMenuPage(rule)
+                .assertOnPage()
+                .clickOnMenu()
+                .clickConfigureQR()
+                .clickViewQRFragment()
+                .assertImageViewShowsImage(R.id.ivQRcode, BitmapFactory.decodeResource(
+                        ApplicationProvider.getApplicationContext().getResources(),
+                        CHECKER_BACKGROUND_DRAWABLE_ID
+                ));
+    }
+
+    @Test
+    public void onMainMenu_clickConfigureQRCode_andClickingOnImportQRCode_startsExternalImagePickerIntent() {
+        new MainMenuPage(rule)
+                .assertOnPage()
+                .clickOnMenu()
+                .clickConfigureQR()
+                .clickOnMenu()
+                .clickOnString(R.string.import_qrcode_sd);
+
+        intended(hasAction(Intent.ACTION_PICK));
+        intended(hasType("image/*"));
+    }
+
+    @Test
+    public void onMainMenu_clickConfigureQRCode_andClickingOnShareQRCode_startsExternalShareIntent() {
+        String path = new StubQRCodeGenerator().getQrCodeFilepath();
+        Uri expected = FileProvider.getUriForFile(ApplicationProvider.getApplicationContext(),
+                BuildConfig.APPLICATION_ID + ".provider",
+                new File(path));
+
+        new MainMenuPage(rule)
+                .assertOnPage()
+                .clickOnMenu()
+                .clickConfigureQR()
+                .clickOnId(R.id.menu_item_share);
+
+        // should be two Intents, 1. to QRCodeTabsActivity 2. Share QR Code Intent
+        assertThat(Intents.getIntents().size(), equalTo(2));
+        Intent receivedIntent = Intents.getIntents().get(1);
+        assertThat(receivedIntent, hasAction(Intent.ACTION_CHOOSER));
+
+        // test title
+        assertThat(receivedIntent, hasExtras(hasEntry(Intent.EXTRA_TITLE,
+                ApplicationProvider.getApplicationContext().getString(R.string.share_qrcode))));
+
+        // test SEND intent
+        assertThat(receivedIntent, hasExtraWithKey(Intent.EXTRA_INTENT));
+        Intent sendIntent = receivedIntent.getParcelableExtra(Intent.EXTRA_INTENT);
+
+        assertThat(sendIntent, hasAction(Intent.ACTION_SEND));
+        assertThat(sendIntent, hasType("image/*"));
+        assertThat(sendIntent, hasExtras(hasEntry(Intent.EXTRA_STREAM, expected)));
+
+        // test that file stream is valid by checking that file exists
+        File qrcodeFile = new File(path);
+        assertTrue(qrcodeFile.exists());
+    }
+
+    // StubQRCodeGenerator is a class that is injected during this test
+    // to verify that the QRCode is generated and shown to user correctly
+    private static class StubQRCodeGenerator implements QRCodeGenerator {
+        @Override
+        public Bitmap generateQRBitMap(String data, int sideLength) throws IOException, WriterException {
+            // don't use this in this test, so okay to return null
+            return null;
+        }
+
+        @Override
+        public Observable<Bitmap> generateQRCode(Collection<String> selectedPasswordKeys) {
+            return Observable.create(emitter -> {
+                Bitmap bitmap =
+                        BitmapFactory.decodeResource(
+                                ApplicationProvider.getApplicationContext().getResources(),
+                                CHECKER_BACKGROUND_DRAWABLE_ID);
+                emitter.onNext(bitmap);
+
+                // save bitmap to test that shareQRCode generates bitmap if file not there
+                FileUtils.saveBitmapToFile(bitmap, getQrCodeFilepath());
+                emitter.onComplete();
+            });
+        }
+
+        @Override
+        public String getQrCodeFilepath() {
+            return new StoragePathProvider().getDirPath(StorageSubdirectory.SETTINGS) + File.separator + "test-collect-settings.png";
+        }
+
+        @Override
+        public String getMd5CachePath() {
+            // don't use this in this test, so okay to return null
+            return null;
+        }
+    }
+}

collect_app/src/androidTest/java/org/odk/collect/android/support/pages/MainMenuPage.java

@@ -61,6 +61,11 @@ public AdminSettingsPage clickAdminSettings() {
         return new AdminSettingsPage(rule).assertOnPage();
     }
 
+    public QRCodeTabsActivityPage clickConfigureQR() {
+        clickOnString(R.string.configure_via_qr_code);
+        return new QRCodeTabsActivityPage(rule).assertOnPage();
+    }
+
     public FillBlankFormPage clickFillBlankForm() {
         onView(withId(R.id.enter_data)).perform(click());
         return new FillBlankFormPage(rule).assertOnPage();

collect_app/src/androidTest/java/org/odk/collect/android/support/pages/QRCodeTabsActivityPage.java

@@ -0,0 +1,83 @@
+package org.odk.collect.android.support.pages;
+
+import android.graphics.Bitmap;
+import android.graphics.drawable.BitmapDrawable;
+import android.graphics.drawable.Drawable;
+import android.view.View;
+import android.widget.ImageView;
+
+import org.hamcrest.Description;
+import org.hamcrest.Matcher;
+import org.odk.collect.android.R;
+import org.odk.collect.android.support.ActivityHelpers;
+
+import androidx.test.espresso.Espresso;
+import androidx.test.espresso.matcher.BoundedMatcher;
+import androidx.test.rule.ActivityTestRule;
+
+import static androidx.test.espresso.Espresso.onView;
+import static androidx.test.espresso.action.ViewActions.click;
+import static androidx.test.espresso.assertion.ViewAssertions.matches;
+import static androidx.test.espresso.matcher.ViewMatchers.withId;
+import static androidx.test.espresso.matcher.ViewMatchers.withText;
+
+public class QRCodeTabsActivityPage extends Page<QRCodeTabsActivityPage> {
+    public QRCodeTabsActivityPage(ActivityTestRule rule) {
+        super(rule);
+    }
+
+    @Override
+    public QRCodeTabsActivityPage assertOnPage() {
+        checkIsStringDisplayed(R.string.configure_via_qr_code);
+        return this;
+    }
+
+    public QRCodeTabsActivityPage clickScanFragment() {
+        onView(withText(R.string.scan_qr_code_fragment_title)).perform(click());
+        return this;
+    }
+
+    public QRCodeTabsActivityPage clickViewQRFragment() {
+        onView(withText(R.string.view_qr_code_fragment_title)).perform(click());
+        return this;
+    }
+
+    public QRCodeTabsActivityPage assertImageViewShowsImage(int resourceid, Bitmap image) {
+        onView(withId(resourceid)).check(matches(DrawableMatcher.withBitmap(image)));
+        return this;
+    }
+
+    public QRCodeTabsActivityPage clickOnMenu() {
+        Espresso.openActionBarOverflowOrOptionsMenu(ActivityHelpers.getActivity());
+        return this;
+    }
+
+    // Matcher class to match the contents of a ImageView and compare with a bitmap
+    private static class DrawableMatcher {
+        private static Matcher<View> withBitmap(Bitmap match) {
+            return new BoundedMatcher<View, ImageView>(ImageView.class) {
+                @Override
+                public void describeTo(Description description) {
+                    description.appendText("bitmaps did not match");
+                }
+
+                @Override
+                protected boolean matchesSafely(ImageView imageView) {
+                    Drawable drawable = imageView.getDrawable();
+                    if (drawable == null && match == null) {
+                        return true;
+                    } else if (drawable != null && match == null) {
+                        return false;
+                    } else if (drawable == null && match != null) {
+                        return false;
+                    }
+
+                    Bitmap actual = ((BitmapDrawable) drawable).getBitmap();
+
+                    return actual.sameAs(match);
+                }
+            };
+        }
+    }
+
+}

collect_app/src/main/AndroidManifest.xml

@@ -97,9 +97,6 @@ the specific language governing permissions and limitations under the License.
             android:screenOrientation="portrait"
             android:stateNotNeeded="true"
             android:windowSoftInputMode="stateAlwaysHidden" />
-        <activity android:name=".activities.ScanQRCodeActivity"
-            android:screenOrientation="portrait"
-            />
         <activity
             android:name=".activities.FormEntryActivity"
             android:windowSoftInputMode="adjustResize" />
@@ -130,6 +127,7 @@ the specific language governing permissions and limitations under the License.
             android:configChanges="orientation|screenSize" />
         <activity android:name=".activities.InstanceUploaderActivity" />
         <activity android:name=".activities.AboutActivity" />
+        <activity android:name=".preferences.qr.QRCodeTabsActivity" />
         <activity android:name=".preferences.PreferencesActivity" />
         <activity android:name=".preferences.AdminPreferencesActivity" />
         <activity android:name=".preferences.AndroidXPreferencesActivity" />

collect_app/src/main/java/org/odk/collect/android/activities/MainMenuActivity.java

@@ -53,6 +53,7 @@
 import org.odk.collect.android.preferences.GeneralSharedPreferences;
 import org.odk.collect.android.preferences.PreferenceSaver;
 import org.odk.collect.android.preferences.PreferencesActivity;
+import org.odk.collect.android.preferences.qr.QRCodeTabsActivity;
 import org.odk.collect.android.preferences.Transport;
 import org.odk.collect.android.provider.InstanceProviderAPI.InstanceColumns;
 import org.odk.collect.android.storage.StorageInitializer;
@@ -371,7 +372,7 @@ public boolean onOptionsItemSelected(MenuItem item) {
                     args.putSerializable(AdminPasswordDialogFragment.ARG_ACTION, Action.SCAN_QR_CODE);
                     showIfNotShowing(AdminPasswordDialogFragment.class, args, getSupportFragmentManager());
                 } else {
-                    startActivity(new Intent(this, ScanQRCodeActivity.class));
+                    startActivity(new Intent(this, QRCodeTabsActivity.class));
                 }
                 return true;
             case R.id.menu_about:
@@ -556,7 +557,7 @@ public void onCorrectAdminPassword(Action action) {
 
                 break;
             case SCAN_QR_CODE:
-                startActivity(new Intent(this, ScanQRCodeActivity.class));
+                startActivity(new Intent(this, QRCodeTabsActivity.class));
                 break;
         }
     }