Merge branch 'manual-screenshots' into 'master'

Create Screenshot of Conversation for Manual

Closes #1377

See merge request briar/briar!910

briar-android/src/androidTest/java/org/briarproject/briar/android/BriarTestRunner.java

@@ -1,11 +1,9 @@
-package org.briarproject.briar.android.test;
+package org.briarproject.briar.android;
 
 import android.app.Application;
 import android.content.Context;
 import android.support.test.runner.AndroidJUnitRunner;
 
-import org.briarproject.briar.android.BriarTestComponentApplication;
-
 public class BriarTestRunner extends AndroidJUnitRunner {
 
 	@Override
@@ -13,8 +11,8 @@ public class BriarTestRunner extends AndroidJUnitRunner {
 			Context context)
 			throws InstantiationException, IllegalAccessException,
 			ClassNotFoundException {
-		return super.newApplication(cl, BriarTestComponentApplication.class.getName(),
-				context);
+		return super.newApplication(cl,
+				BriarTestComponentApplication.class.getName(), context);
 	}
 
 }

briar-android/src/androidTest/java/org/briarproject/briar/android/UiTest.java

@@ -0,0 +1,79 @@
+package org.briarproject.briar.android;
+
+import android.app.Activity;
+import android.content.Intent;
+import android.support.test.espresso.intent.rule.IntentsTestRule;
+
+import org.briarproject.bramble.api.account.AccountManager;
+import org.briarproject.bramble.api.lifecycle.LifecycleManager;
+import org.briarproject.bramble.api.nullsafety.NotNullByDefault;
+import org.briarproject.briar.R;
+
+import javax.annotation.Nullable;
+import javax.inject.Inject;
+
+import static android.support.test.InstrumentationRegistry.getTargetContext;
+
+@SuppressWarnings("WeakerAccess")
+public abstract class UiTest {
+
+	protected final String USERNAME =
+			getTargetContext().getString(R.string.screenshot_alice);
+	protected static final String PASSWORD = "123456";
+
+	@Inject
+	protected AccountManager accountManager;
+	@Inject
+	protected LifecycleManager lifecycleManager;
+
+	public UiTest() {
+		BriarTestComponentApplication app =
+				(BriarTestComponentApplication) getTargetContext()
+						.getApplicationContext();
+		inject((BriarUiTestComponent) app.getApplicationComponent());
+	}
+
+	protected abstract void inject(BriarUiTestComponent component);
+
+	@NotNullByDefault
+	protected class CleanAccountTestRule<A extends Activity>
+			extends IntentsTestRule<A> {
+
+		@Nullable
+		private final Runnable runnable;
+
+		public CleanAccountTestRule(Class<A> activityClass) {
+			super(activityClass);
+			this.runnable = null;
+		}
+
+		/**
+		 * Use this if you need to run code before launching the activity.
+		 * Note: You need to use {@link #launchActivity(Intent)} yourself
+		 * to start the activity.
+		 */
+		public CleanAccountTestRule(Class<A> activityClass, Runnable runnable) {
+			super(activityClass, false, false);
+			this.runnable = runnable;
+		}
+
+		@Override
+		protected void beforeActivityLaunched() {
+			super.beforeActivityLaunched();
+			accountManager.deleteAccount();
+			accountManager.createAccount(USERNAME, PASSWORD);
+			if (runnable != null) {
+				Intent serviceIntent =
+						new Intent(getTargetContext(), BriarService.class);
+				getTargetContext().startService(serviceIntent);
+				try {
+					lifecycleManager.waitForStartup();
+				} catch (InterruptedException e) {
+					throw new AssertionError(e);
+				}
+				runnable.run();
+			}
+		}
+	}
+
+}

briar-android/src/androidTest/java/org/briarproject/briar/android/ViewActions.java

@@ -1,4 +1,4 @@
-package org.briarproject.briar.android.test;
+package org.briarproject.briar.android;
 
 import android.app.Activity;
 import android.support.test.espresso.PerformException;

briar-android/src/androidTest/java/org/briarproject/briar/android/test/ScreenshotTest.java

@@ -1,73 +0,0 @@
-package org.briarproject.briar.android.test;
-
-import android.app.Activity;
-import android.support.test.espresso.intent.rule.IntentsTestRule;
-import android.util.Log;
-
-import org.briarproject.bramble.api.account.AccountManager;
-import org.briarproject.bramble.api.lifecycle.LifecycleManager;
-import org.briarproject.briar.android.BriarTestComponentApplication;
-import org.briarproject.briar.android.BriarUiTestComponent;
-import org.junit.ClassRule;
-
-import javax.inject.Inject;
-
-import tools.fastlane.screengrab.Screengrab;
-import tools.fastlane.screengrab.UiAutomatorScreenshotStrategy;
-import tools.fastlane.screengrab.locale.LocaleTestRule;
-
-import static android.support.test.InstrumentationRegistry.getTargetContext;
-import static tools.fastlane.screengrab.Screengrab.setDefaultScreenshotStrategy;
-
-public abstract class ScreenshotTest {
-
-	@ClassRule
-	public static final LocaleTestRule localeTestRule = new LocaleTestRule();
-
-	protected static final String USERNAME = "Alice";
-	protected static final String PASSWORD = "123456";
-
-	@Inject
-	protected AccountManager accountManager;
-	@Inject
-	protected LifecycleManager lifecycleManager;
-
-	public ScreenshotTest() {
-		super();
-		setDefaultScreenshotStrategy(new UiAutomatorScreenshotStrategy());
-		BriarTestComponentApplication app =
-				(BriarTestComponentApplication) getTargetContext()
-						.getApplicationContext();
-		inject((BriarUiTestComponent) app.getApplicationComponent());
-	}
-
-	protected abstract void inject(BriarUiTestComponent component);
-
-	protected void screenshot(String name) {
-		try {
-			Screengrab.screenshot(name);
-		} catch (RuntimeException e) {
-			if (!e.getMessage().equals("Unable to capture screenshot."))
-				throw e;
-			// The tests should still pass when run from AndroidStudio
-			// without manually granting permissions like fastlane does.
-			Log.w("Screengrab", "Permission to write screenshot is missing.");
-		}
-	}
-
-	protected class CleanAccountTestRule<A extends Activity>
-			extends IntentsTestRule<A> {
-
-		public CleanAccountTestRule(Class<A> activityClass) {
-			super(activityClass);
-		}
-
-		@Override
-		protected void beforeActivityLaunched() {
-			super.beforeActivityLaunched();
-			accountManager.deleteAccount();
-			accountManager.createAccount(USERNAME, PASSWORD);
-		}
-	}
-
-}

briar-android/src/androidTestOfficial/java/org/briarproject/briar/android/BriarUiTestComponent.java

@@ -0,0 +1,25 @@
+package org.briarproject.briar.android;
+
+import org.briarproject.bramble.BrambleAndroidModule;
+import org.briarproject.bramble.BrambleCoreModule;
+import org.briarproject.bramble.account.BriarAccountModule;
+import org.briarproject.briar.BriarCoreModule;
+import org.briarproject.briar.android.navdrawer.NavDrawerActivityTest;
+
+import javax.inject.Singleton;
+
+import dagger.Component;
+
+@Singleton
+@Component(modules = {
+		AppModule.class,
+		BriarCoreModule.class,
+		BrambleAndroidModule.class,
+		BriarAccountModule.class,
+		BrambleCoreModule.class
+})
+public interface BriarUiTestComponent extends AndroidComponent {
+
+	void inject(NavDrawerActivityTest test);
+
+}

briar-android/src/androidTestOfficial/java/org/briarproject/briar/android/navdrawer/NavDrawerActivityTest.java

@@ -6,8 +6,8 @@ import android.view.Gravity;
 
 import org.briarproject.briar.R;
 import org.briarproject.briar.android.BriarUiTestComponent;
+import org.briarproject.briar.android.UiTest;
 import org.briarproject.briar.android.settings.SettingsActivity;
-import org.briarproject.briar.android.test.ScreenshotTest;
 import org.junit.Rule;
 import org.junit.Test;
 import org.junit.runner.RunWith;
@@ -23,7 +23,7 @@ import static android.support.test.espresso.matcher.ViewMatchers.withId;
 import static android.support.test.espresso.matcher.ViewMatchers.withText;
 
 @RunWith(AndroidJUnit4.class)
-public class NavDrawerActivityTest extends ScreenshotTest {
+public class NavDrawerActivityTest extends UiTest {
 
 	@Rule
 	public CleanAccountTestRule<NavDrawerActivity> testRule =

briar-android/src/androidTestScreenshot/java/org/briarproject/briar/android/BriarUiTestComponent.java

@@ -4,8 +4,7 @@ import org.briarproject.bramble.BrambleAndroidModule;
 import org.briarproject.bramble.BrambleCoreModule;
 import org.briarproject.bramble.account.BriarAccountModule;
 import org.briarproject.briar.BriarCoreModule;
-import org.briarproject.briar.android.login.SetupActivityScreenshotTest;
-import org.briarproject.briar.android.navdrawer.NavDrawerActivityTest;
+import org.briarproject.briar.android.contact.ConversationActivityScreenshotTest;
 import org.briarproject.briar.android.settings.SettingsActivityScreenshotTest;
 
 import javax.inject.Singleton;
@@ -22,8 +21,9 @@ import dagger.Component;
 })
 public interface BriarUiTestComponent extends AndroidComponent {
 
-	void inject(SetupActivityScreenshotTest test);
-	void inject(NavDrawerActivityTest test);
+	void inject(SetupDataTest test);
+
+	void inject(ConversationActivityScreenshotTest test);
 	void inject(SettingsActivityScreenshotTest test);
 
 }

briar-android/src/androidTestScreenshot/java/org/briarproject/briar/android/ScreenshotTest.java

@@ -0,0 +1,45 @@
+package org.briarproject.briar.android;
+
+import android.app.Activity;
+import android.util.Log;
+
+import org.briarproject.bramble.api.plugin.ConnectionRegistry;
+import org.briarproject.bramble.api.system.Clock;
+import org.briarproject.briar.api.test.TestDataCreator;
+import org.junit.ClassRule;
+
+import javax.inject.Inject;
+
+import tools.fastlane.screengrab.FalconScreenshotStrategy;
+import tools.fastlane.screengrab.Screengrab;
+import tools.fastlane.screengrab.locale.LocaleTestRule;
+
+public abstract class ScreenshotTest extends UiTest {
+
+	@ClassRule
+	public static final LocaleTestRule localeTestRule = new LocaleTestRule();
+
+	@Inject
+	protected TestDataCreator testDataCreator;
+	@Inject
+	protected ConnectionRegistry connectionRegistry;
+	@Inject
+	protected Clock clock;
+
+	protected void screenshot(String name, Activity activity) {
+		try {
+			Screengrab.screenshot(name, new FalconScreenshotStrategy(activity));
+		} catch (RuntimeException e) {
+			if (!e.getMessage().equals("Unable to capture screenshot."))
+				throw e;
+			// The tests should still pass when run from AndroidStudio
+			// without manually granting permissions like fastlane does.
+			Log.w("Screengrab", "Permission to write screenshot is missing.");
+		}
+	}
+
+	protected long getMinutesAgo(int minutes) {
+		return clock.currentTimeMillis() - minutes * 60 * 1000;
+	}
+
+}

briar-android/src/androidTestScreenshot/java/org/briarproject/briar/android/SetupDataTest.java

@@ -1,4 +1,4 @@
-package org.briarproject.briar.android.login;
+package org.briarproject.briar.android;
 
 import android.support.test.espresso.intent.rule.IntentsTestRule;
 import android.support.test.runner.AndroidJUnit4;
@@ -6,9 +6,12 @@ import android.support.test.uiautomator.UiDevice;
 import android.support.test.uiautomator.UiObject;
 import android.support.test.uiautomator.UiSelector;
 
+import org.briarproject.bramble.api.FormatException;
+import org.briarproject.bramble.api.contact.Contact;
+import org.briarproject.bramble.api.db.DbException;
 import org.briarproject.briar.R;
-import org.briarproject.briar.android.BriarUiTestComponent;
-import org.briarproject.briar.android.test.ScreenshotTest;
+import org.briarproject.briar.android.login.OpenDatabaseActivity;
+import org.briarproject.briar.android.login.SetupActivity;
 import org.junit.Rule;
 import org.junit.Test;
 import org.junit.runner.RunWith;
@@ -26,14 +29,14 @@ import static android.support.test.espresso.matcher.ViewMatchers.isRoot;
 import static android.support.test.espresso.matcher.ViewMatchers.withId;
 import static android.support.test.espresso.matcher.ViewMatchers.withText;
 import static android.support.test.runner.lifecycle.Stage.PAUSED;
-import static junit.framework.Assert.assertTrue;
-import static org.briarproject.briar.android.test.ViewActions.waitForActivity;
-import static org.briarproject.briar.android.test.ViewActions.waitUntilMatches;
+import static org.briarproject.bramble.api.plugin.LanTcpConstants.ID;
+import static org.briarproject.briar.android.ViewActions.waitForActivity;
+import static org.briarproject.briar.android.ViewActions.waitUntilMatches;
 import static org.briarproject.briar.android.util.UiUtils.needsDozeWhitelisting;
-
+import static org.junit.Assert.assertTrue;
 
 @RunWith(AndroidJUnit4.class)
-public class SetupActivityScreenshotTest extends ScreenshotTest {
+public class SetupDataTest extends ScreenshotTest {
 
 	@Rule
 	public IntentsTestRule<SetupActivity> testRule =
@@ -61,7 +64,7 @@ public class SetupActivityScreenshotTest extends ScreenshotTest {
 		onView(withId(R.id.nickname_entry))
 				.perform(waitUntilMatches(withText(USERNAME)));
 
-		screenshot("manual_create_account");
+		screenshot("manual_create_account", testRule.getActivity());
 
 		onView(withId(R.id.next))
 				.check(matches(isDisplayed()))
@@ -94,13 +97,54 @@ public class SetupActivityScreenshotTest extends ScreenshotTest {
 		}
 
 		// wait for OpenDatabaseActivity to show up
-		onView(withId(R.id.progress))
-				.check(matches(isDisplayed()));
 		onView(isRoot())
 				.perform(waitForActivity(testRule.getActivity(), PAUSED));
 		intended(hasComponent(OpenDatabaseActivity.class.getName()));
 
 		assertTrue(accountManager.hasDatabaseKey());
+
+		lifecycleManager.waitForStartup();
+		createTestData();
+
+		// close expiry warning
+		onView(withId(R.id.expiryWarning))
+				.perform(waitUntilMatches(isDisplayed()));
+		onView(withId(R.id.expiryWarningClose))
+				.check(matches(isDisplayed()));
+		onView(withId(R.id.expiryWarningClose))
+				.perform(click());
+	}
+
+	private void createTestData() {
+		try {
+			createTestDataExceptions();
+		} catch (DbException | FormatException e) {
+			throw new AssertionError(e);
+		}
+	}
+
+	private void createTestDataExceptions()
+			throws DbException, FormatException {
+		String bobName =
+				getTargetContext().getString(R.string.screenshot_bob);
+		Contact bob = testDataCreator.addContact(bobName);
+
+		String bobHi = getTargetContext()
+				.getString(R.string.screenshot_message_1);
+		long bobTime = getMinutesAgo(2);
+		testDataCreator.addPrivateMessage(bob, bobHi, bobTime, true);
+
+		String aliceHi = getTargetContext()
+				.getString(R.string.screenshot_message_2);
+		long aliceTime = getMinutesAgo(1);
+		testDataCreator.addPrivateMessage(bob, aliceHi, aliceTime, false);
+
+		String bobHi2 = getTargetContext()
+				.getString(R.string.screenshot_message_3);
+		long bobTime2 = getMinutesAgo(0);
+		testDataCreator.addPrivateMessage(bob, bobHi2, bobTime2, true);
+
+		connectionRegistry.registerConnection(bob.getId(), ID, true);
 	}
 
 }

briar-android/src/androidTestScreenshot/java/org/briarproject/briar/android/contact/ConversationActivityScreenshotTest.java

@@ -0,0 +1,52 @@
+package org.briarproject.briar.android.contact;
+
+import android.content.Context;
+import android.content.Intent;
+import android.support.test.rule.ActivityTestRule;
+import android.support.test.runner.AndroidJUnit4;
+
+import org.briarproject.briar.R;
+import org.briarproject.briar.android.BriarUiTestComponent;
+import org.briarproject.briar.android.ScreenshotTest;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import static android.support.test.InstrumentationRegistry.getInstrumentation;
+import static android.support.test.espresso.Espresso.onView;
+import static android.support.test.espresso.matcher.ViewMatchers.isCompletelyDisplayed;
+import static android.support.test.espresso.matcher.ViewMatchers.withId;
+import static android.support.test.espresso.matcher.ViewMatchers.withText;
+import static org.briarproject.briar.android.ViewActions.waitUntilMatches;
+import static org.briarproject.briar.android.contact.ConversationActivity.CONTACT_ID;
+import static org.hamcrest.Matchers.allOf;
+
+@RunWith(AndroidJUnit4.class)
+public class ConversationActivityScreenshotTest extends ScreenshotTest {
+
+	@Rule
+	public ActivityTestRule<ConversationActivity> testRule =
+			new ActivityTestRule<>(ConversationActivity.class, false, false);
+
+	@Override
+	protected void inject(BriarUiTestComponent component) {
+		component.inject(this);
+	}
+
+	@Test
+	public void messaging() throws Exception {
+		Context targetContext = getInstrumentation().getTargetContext();
+		Intent intent = new Intent(targetContext, ConversationActivity.class);
+		intent.putExtra(CONTACT_ID, 1);
+		testRule.launchActivity(intent);
+
+		onView(withId(R.id.conversationView))
+				.perform(waitUntilMatches(allOf(
+						withText(R.string.screenshot_message_3),
+						isCompletelyDisplayed())
+				));
+
+		screenshot("manual_messaging", testRule.getActivity());
+	}
+
+}

briar-android/src/androidTestScreenshot/java/org/briarproject/briar/android/settings/SettingsActivityScreenshotTest.java

@@ -2,14 +2,15 @@ package org.briarproject.briar.android.settings;
 
 import android.content.Intent;
 import android.support.test.espresso.contrib.DrawerActions;
+import android.support.test.rule.ActivityTestRule;
 import android.support.test.runner.AndroidJUnit4;
 import android.support.v7.widget.RecyclerView;
 import android.view.Gravity;
 
 import org.briarproject.briar.R;
 import org.briarproject.briar.android.BriarUiTestComponent;
+import org.briarproject.briar.android.ScreenshotTest;
 import org.briarproject.briar.android.navdrawer.NavDrawerActivity;
-import org.briarproject.briar.android.test.ScreenshotTest;
 import org.junit.Rule;
 import org.junit.Test;
 import org.junit.runner.RunWith;
@@ -26,15 +27,15 @@ import static android.support.test.espresso.matcher.ViewMatchers.withChild;
 import static android.support.test.espresso.matcher.ViewMatchers.withClassName;
 import static android.support.test.espresso.matcher.ViewMatchers.withId;
 import static android.support.test.espresso.matcher.ViewMatchers.withText;
-import static org.briarproject.briar.android.test.ViewActions.waitUntilMatches;
+import static org.briarproject.briar.android.ViewActions.waitUntilMatches;
 import static org.hamcrest.CoreMatchers.is;
 
 @RunWith(AndroidJUnit4.class)
 public class SettingsActivityScreenshotTest extends ScreenshotTest {
 
 	@Rule
-	public CleanAccountTestRule<SettingsActivity> testRule =
-			new CleanAccountTestRule<>(SettingsActivity.class);
+	public ActivityTestRule<SettingsActivity> testRule =
+			new ActivityTestRule<>(SettingsActivity.class);
 
 	@Override
 	protected void inject(BriarUiTestComponent component) {
@@ -46,7 +47,7 @@ public class SettingsActivityScreenshotTest extends ScreenshotTest {
 		onView(withText(R.string.settings_button))
 				.check(matches(isDisplayed()));
 
-		screenshot("manual_dark_theme_settings");
+		screenshot("manual_dark_theme_settings", testRule.getActivity());
 
 		// switch to dark theme
 		onView(withText(R.string.pref_theme_title))
@@ -56,10 +57,20 @@ public class SettingsActivityScreenshotTest extends ScreenshotTest {
 				.check(matches(isDisplayed()))
 				.perform(click());
 
-		// open nav drawer and remove expiry warning
-		openNavDrawer(true);
+		openNavDrawer();
 
-		screenshot("manual_dark_theme_nav_drawer");
+		screenshot("manual_dark_theme_nav_drawer", testRule.getActivity());
+
+		// switch to back to light theme
+		onView(withText(R.string.settings_button))
+				.check(matches(isDisplayed()))
+				.perform(click());
+		onView(withText(R.string.pref_theme_title))
+				.check(matches(isDisplayed()))
+				.perform(click());
+		onView(withText(R.string.pref_theme_light))
+				.check(matches(isDisplayed()))
+				.perform(click());
 	}
 
 	@Test
@@ -83,12 +94,11 @@ public class SettingsActivityScreenshotTest extends ScreenshotTest {
 				.check(matches(isDisplayed()))
 				.check(matches(isEnabled()));
 
-		screenshot("manual_app_lock");
+		screenshot("manual_app_lock", testRule.getActivity());
 
-		// no more expiry warning to remove, because sharedprefs cached?
-		openNavDrawer(false);
+		openNavDrawer();
 
-		screenshot("manual_app_lock_nav_drawer");
+		screenshot("manual_app_lock_nav_drawer", testRule.getActivity());
 	}
 
 	@Test
@@ -104,23 +114,15 @@ public class SettingsActivityScreenshotTest extends ScreenshotTest {
 				.check(matches(isDisplayed()))
 				.perform(waitUntilMatches(isEnabled()));
 
-		screenshot("manual_tor_settings");
+		screenshot("manual_tor_settings", testRule.getActivity());
 	}
 
-	private void openNavDrawer(boolean expiry) {
+	private void openNavDrawer() {
 		// start main activity
 		Intent i =
 				new Intent(testRule.getActivity(), NavDrawerActivity.class);
 		testRule.getActivity().startActivity(i);
 
-		// close expiry warning
-		if (expiry) {
-			onView(withId(R.id.expiryWarningClose))
-					.check(matches(isDisplayed()));
-			onView(withId(R.id.expiryWarningClose))
-					.perform(click());
-		}
-
 		// open navigation drawer
 		onView(withId(R.id.drawer_layout))
 				.check(matches(isClosed(Gravity.START)))

briar-android/src/main/res/values/strings.xml

@@ -480,4 +480,20 @@
 	<string name="lock_is_locked">Briar is locked</string>
 	<string name="lock_tap_to_unlock">Tap to unlock</string>
 
+	<!-- Screenshots -->
+
+	<!-- This is a name to be used in screenshots. Feel free to change it to a local name. -->
+	<string name="screenshot_alice">Alice</string>
+	<!-- This is a name to be used in screenshots. Feel free to change it to a local name. -->
+	<string name="screenshot_bob">Bob</string>
+	<!-- This is a name to be used in screenshots. Feel free to change it to a local name. -->
+	<string name="screenshot_carol">Carol</string>
+	<!-- This is a message to be used in screenshots. Please use the same translation for Bob! -->
+	<string name="screenshot_message_1">Hi Bob!</string>
+	<!-- This is a message to be used in screenshots. Please use the same translation for Alice! -->
+	<string name="screenshot_message_2">Hi Alice! Thanks for telling me about Briar!</string>
+	<!-- This is a message to be used in screenshots. -->
+	<string name="screenshot_message_3">No problem, hope you like it 😀</string>
+
+
 </resources>