Introduce CommandResultSubject
"Truth" allows us to write readable code and generate more informational
error message for debugging. This change introduces the Truth "Subject"
for CommandResult.
Bug: None
Test: atest AuthFsHostTest ComposHostTestCases MicrodroidTestCase
Change-Id: I00cfc452a67dcb915ce80ee391f0ef53127b5408
diff --git a/tests/hostside/helper/Android.bp b/tests/hostside/helper/Android.bp
index 4ca0bf0..6ab02f8 100644
--- a/tests/hostside/helper/Android.bp
+++ b/tests/hostside/helper/Android.bp
@@ -6,7 +6,8 @@
name: "VirtualizationTestHelper",
srcs: ["java/**/*.java"],
libs: [
- "tradefed",
"compatibility-tradefed",
+ "tradefed",
+ "truth-prebuilt",
],
}
diff --git a/tests/hostside/helper/java/android/virt/test/CommandResultSubject.java b/tests/hostside/helper/java/android/virt/test/CommandResultSubject.java
new file mode 100644
index 0000000..5312f5a
--- /dev/null
+++ b/tests/hostside/helper/java/android/virt/test/CommandResultSubject.java
@@ -0,0 +1,74 @@
+/*
+ * Copyright (C) 2022 The Android Open Source Project
+ *
+ * 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.
+ */
+package android.virt.test;
+
+import static com.google.common.truth.Truth.assertAbout;
+
+import com.android.tradefed.util.CommandResult;
+import com.android.tradefed.util.CommandStatus;
+
+import com.google.common.truth.FailureMetadata;
+import com.google.common.truth.IntegerSubject;
+import com.google.common.truth.StringSubject;
+import com.google.common.truth.Subject;
+
+/**
+ * A <a href="https://github.com/google/truth">Truth</a> subject for {@link CommandResult}.
+ */
+public class CommandResultSubject extends Subject {
+ private final CommandResult mActual;
+
+ public static Factory<CommandResultSubject, CommandResult> command_results() {
+ return CommandResultSubject::new;
+ }
+
+ public static CommandResultSubject assertThat(CommandResult actual) {
+ return assertAbout(command_results()).that(actual);
+ }
+
+ private CommandResultSubject(FailureMetadata metadata, CommandResult actual) {
+ super(metadata, actual);
+ this.mActual = actual;
+ }
+
+ public void isSuccess() {
+ check("isSuccess()").that(mActual.getStatus()).isEqualTo(CommandStatus.SUCCESS);
+ }
+
+ public void isFailed() {
+ check("isFailed()").that(mActual.getStatus()).isEqualTo(CommandStatus.FAILED);
+ }
+
+ public void isTimedOut() {
+ check("isTimedOut()").that(mActual.getStatus()).isEqualTo(CommandStatus.TIMED_OUT);
+ }
+
+ public void isException() {
+ check("isException()").that(mActual.getStatus()).isEqualTo(CommandStatus.EXCEPTION);
+ }
+
+ public IntegerSubject exitCode() {
+ return check("exitCode()").that(mActual.getExitCode());
+ }
+
+ public StringSubject stdoutTrimmed() {
+ return check("stdout()").that(mActual.getStdout().trim());
+ }
+
+ public StringSubject stderrTrimmed() {
+ return check("stderr()").that(mActual.getStderr().trim());
+ }
+}
diff --git a/tests/hostside/helper/java/android/virt/test/VirtualizationTestCaseBase.java b/tests/hostside/helper/java/android/virt/test/VirtualizationTestCaseBase.java
index dc0284f..a55ebe1 100644
--- a/tests/hostside/helper/java/android/virt/test/VirtualizationTestCaseBase.java
+++ b/tests/hostside/helper/java/android/virt/test/VirtualizationTestCaseBase.java
@@ -16,10 +16,13 @@
package android.virt.test;
+import static android.virt.test.CommandResultSubject.assertThat;
+import static android.virt.test.CommandResultSubject.command_results;
+
import static com.android.tradefed.testtype.DeviceJUnit4ClassRunner.TestLogData;
-import static org.hamcrest.CoreMatchers.is;
-import static org.junit.Assert.assertThat;
+import static com.google.common.truth.Truth.assertWithMessage;
+
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import static org.junit.Assume.assumeTrue;
@@ -29,10 +32,8 @@
import com.android.tradefed.device.DeviceNotAvailableException;
import com.android.tradefed.device.ITestDevice;
import com.android.tradefed.device.TestDevice;
-import com.android.tradefed.log.LogUtil.CLog;
import com.android.tradefed.testtype.junit4.BaseHostJUnit4Test;
import com.android.tradefed.util.CommandResult;
-import com.android.tradefed.util.CommandStatus;
import com.android.tradefed.util.RunUtil;
import java.io.File;
@@ -113,16 +114,17 @@
private static String runOnHostWithTimeout(long timeoutMillis, String... cmd) {
assertTrue(timeoutMillis >= 0);
CommandResult result = RunUtil.getDefault().runTimedCmd(timeoutMillis, cmd);
- assertThat(result.getStatus(), is(CommandStatus.SUCCESS));
+ assertThat(result).isSuccess();
return result.getStdout().trim();
}
// Run a shell command on Microdroid
public static String runOnMicrodroid(String... cmd) {
CommandResult result = runOnMicrodroidForResult(cmd);
- if (result.getStatus() != CommandStatus.SUCCESS) {
- fail(join(cmd) + " has failed: " + result);
- }
+ assertWithMessage("microdroid shell cmd `" + join(cmd) + "`")
+ .about(command_results())
+ .that(result)
+ .isSuccess();
return result.getStdout().trim();
}
@@ -133,23 +135,13 @@
CommandResult result = RunUtil.getDefault()
.runTimedCmdRetry(timeoutMs, 500, attempts,
"adb", "-s", MICRODROID_SERIAL, "shell", join(cmd));
- if (result.getStatus() != CommandStatus.SUCCESS) {
- fail(join(cmd) + " has failed: " + result);
- }
+ assertWithMessage("Command `" + cmd + "` has failed")
+ .about(command_results())
+ .that(result)
+ .isSuccess();
return result.getStdout().trim();
}
- // Same as runOnMicrodroid, but returns null on error.
- public static String tryRunOnMicrodroid(String... cmd) {
- CommandResult result = runOnMicrodroidForResult(cmd);
- if (result.getStatus() == CommandStatus.SUCCESS) {
- return result.getStdout().trim();
- } else {
- CLog.d(join(cmd) + " has failed (but ok): " + result);
- return null;
- }
- }
-
public static CommandResult runOnMicrodroidForResult(String... cmd) {
final long timeoutMs = 30000; // 30 sec. Microdroid is extremely slow on GCE-on-CF.
return RunUtil.getDefault()
@@ -168,15 +160,15 @@
"pull",
path,
target.getPath());
- if (result.getStatus() != CommandStatus.SUCCESS) {
- fail("pulling " + path + " has failed: " + result);
- }
+ assertWithMessage("pulling " + path + " from microdroid")
+ .about(command_results())
+ .that(result)
+ .isSuccess();
}
// Asserts the command will fail on Microdroid.
public static void assertFailedOnMicrodroid(String... cmd) {
- CommandResult result = runOnMicrodroidForResult(cmd);
- assertThat(result.getStatus(), is(CommandStatus.FAILED));
+ assertThat(runOnMicrodroidForResult(cmd)).isFailed();
}
private static String join(String... strs) {
@@ -390,6 +382,8 @@
}
// Check if it actually booted by reading a sysprop.
- assertThat(runOnMicrodroid("getprop", "ro.hardware"), is("microdroid"));
+ assertThat(runOnMicrodroidForResult("getprop", "ro.hardware"))
+ .stdoutTrimmed()
+ .isEqualTo("microdroid");
}
}
diff --git a/tests/hostside/java/android/virt/test/MicrodroidTestCase.java b/tests/hostside/java/android/virt/test/MicrodroidTestCase.java
index 32bdf3b..435740f 100644
--- a/tests/hostside/java/android/virt/test/MicrodroidTestCase.java
+++ b/tests/hostside/java/android/virt/test/MicrodroidTestCase.java
@@ -16,11 +16,16 @@
package android.virt.test;
+import static android.virt.test.CommandResultSubject.assertThat;
+import static android.virt.test.CommandResultSubject.command_results;
+
import static com.android.tradefed.testtype.DeviceJUnit4ClassRunner.TestLogData;
+import static com.google.common.truth.Truth.assertThat;
+import static com.google.common.truth.Truth.assertWithMessage;
+
import static org.hamcrest.CoreMatchers.containsString;
import static org.hamcrest.CoreMatchers.is;
-import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotEquals;
import static org.junit.Assert.assertThat;
@@ -34,7 +39,6 @@
import com.android.tradefed.testtype.DeviceJUnit4ClassRunner;
import com.android.tradefed.testtype.junit4.DeviceTestRunOptions;
import com.android.tradefed.util.CommandResult;
-import com.android.tradefed.util.CommandStatus;
import com.android.tradefed.util.FileUtil;
import com.android.tradefed.util.RunUtil;
@@ -105,7 +109,7 @@
// the microdroid boot procedure. Therefore, waiting for the service means that we wait for
// the boot to complete. TODO: we need a better marker eventually.
private void waitForLogdInit() {
- tryRunOnMicrodroid("watch -e \"getprop init.svc.logd-reinit | grep '^$'\"");
+ runOnMicrodroidForResult("watch -e \"getprop init.svc.logd-reinit | grep '^$'\"");
}
@Test
@@ -122,7 +126,7 @@
assertFalse(runDeviceTests(options));
Map<TestDescription, TestResult> results = getLastDeviceRunResults().getTestResults();
- assertThat(results.size(), is(1));
+ assertThat(results).hasSize(1);
TestResult result = results.values().toArray(new TestResult[0])[0];
assertTrue("The test should fail with a permission error",
result.getStackTrace()
@@ -161,9 +165,11 @@
String.join(" ", command));
String out = result.getStdout();
String err = result.getStderr();
- assertEquals(
- "resigning the Virt APEX failed:\n\tout: " + out + "\n\terr: " + err + "\n",
- CommandStatus.SUCCESS, result.getStatus());
+ assertWithMessage(
+ "resigning the Virt APEX failed:\n\tout: " + out + "\n\terr: " + err + "\n")
+ .about(command_results())
+ .that(result)
+ .isSuccess();
}
private static <T> void assertThatEventually(long timeoutMillis, Callable<T> callable,
@@ -458,10 +464,10 @@
"-w",
"-f",
generalPolicyConfFile.getPath());
- assertEquals(
- "neverallow check failed: " + result.getStderr().trim(),
- result.getStatus(),
- CommandStatus.SUCCESS);
+ assertWithMessage("neverallow check failed: " + result.getStderr().trim())
+ .about(command_results())
+ .that(result)
+ .isSuccess();
}
shutdownMicrodroid(getDevice(), cid);