Merge changes I5d55b287,I3d39c193,If60282ad,I132fd395,I09a7f6f5

* changes:
  WifiLog: add CheckReturnValue annotation
  logging: add convenience APIs for literal messages
  WifiDiagnostics: migrate to chained logging API
  logging: add chained logging API
  WifiDiagnostics: remove getAllRingBufferData()

2 files changed, 266 insertions, 10 deletions

diff --git a/tests/wifitests/src/com/android/server/wifi/LogcatLogTest.java b/tests/wifitests/src/com/android/server/wifi/LogcatLogTest.java
new file mode 100644
index 000000000..ac5afe7fd
--- /dev/null
+++ b/tests/wifitests/src/com/android/server/wifi/LogcatLogTest.java
@@ -0,0 +1,256 @@
+/*
+ * Copyright (C) 2016 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 com.android.server.wifi;
+
+import static org.junit.Assert.assertEquals;
+
+import android.test.suitebuilder.annotation.SmallTest;
+
+import org.junit.Before;
+import org.junit.Test;
+
+/**
+ * Unit tests for {@link LogcatLog}.
+ */
+@SmallTest
+public class LogcatLogTest {
+    private static final String TAG = "LogcatLogTest";
+    private LogcatLog mLogger;
+
+    /** Initializes test fixture. */
+    @Before
+    public void setUp() {
+        mLogger = new LogcatLog(TAG);
+    }
+
+    /**
+     * Verifies that LogcatLog's LogMessage implementation correctly
+     * handles a format with no parameters.
+     *
+     * Note: In practice, we expect clients to use eC() and friends
+     * when the message is a literal. But we still want to make sure
+     * this functionality works.
+     */
+    @Test
+    public void logMessageWorksWithParameterlessFormat() {
+        WifiLog.LogMessage logMessage = mLogger.err("hello world");
+        logMessage.flush();
+        assertEquals("hello world", logMessage.toString());
+    }
+
+    /** Verifies that LogMessage works with an empty format. */
+    @Test
+    public void logMessageWorksWithEmptyFormat() {
+        WifiLog.LogMessage logMessage = mLogger.err("");
+        logMessage.flush();
+        assertEquals("", logMessage.toString());
+    }
+
+    /** Verifies that LogMessage works with a value-only format. */
+    @Test
+    public void logMessageWorksWithValueOnly() {
+        WifiLog.LogMessage logMessage = mLogger.err("%");
+        logMessage.c(1).flush();
+        assertEquals("1", logMessage.toString());
+    }
+
+    /**
+     * Verifies that LogMessage works when the placeholder is replaced
+     * by the placeholder character.
+     */
+    @Test
+    public void logMessageIsNotConfusedByPlaceholderInValue() {
+        WifiLog.LogMessage logMessage = mLogger.err("%");
+        logMessage.c('%').flush();
+        assertEquals("%", logMessage.toString());
+    }
+
+    /** Verifies that LogMessage works when a value is at the start of the format. */
+    @Test
+    public void logMessageWorksWithValueAtBegin() {
+        WifiLog.LogMessage logMessage = mLogger.err("%stuff");
+        logMessage.c(1).flush();
+        assertEquals("1stuff", logMessage.toString());
+    }
+
+    /** Verifies that LogMessage works when a value is in the middle of the format. */
+    @Test
+    public void logMessageWorksWithValueInMiddle() {
+        WifiLog.LogMessage logMessage = mLogger.err("s%uff");
+        logMessage.c(1).flush();
+        assertEquals("s1uff", logMessage.toString());
+    }
+
+    /** Verifies that LogMessage works when a value is at the end of the format. */
+    @Test
+    public void logMessageWorksWithValueAtEnd() {
+        WifiLog.LogMessage logMessage = mLogger.err("stuff%");
+        logMessage.c(1).flush();
+        assertEquals("stuff1", logMessage.toString());
+    }
+
+    /** Verifies that LogMessage works when a format has multiple values. */
+    @Test
+    public void logMessageWorksWithMultipleValues() {
+        WifiLog.LogMessage logMessage = mLogger.err("% %");
+        logMessage.c("hello").c("world").flush();
+        assertEquals("hello world", logMessage.toString());
+    }
+
+    /** Verifies that LogMessage works when a format has multiple values and literals. */
+    @Test
+    public void logMessageWorksWithMultipleValuesAndLiterals() {
+        WifiLog.LogMessage logMessage = mLogger.err("first:% second:%");
+        logMessage.c("hello").c("world").flush();
+        assertEquals("first:hello second:world", logMessage.toString());
+    }
+
+    /** Verifies that LogMessage works when a format has multiple adjacent values. */
+    @Test
+    public void logMessageWorksWithAdjacentValues() {
+        WifiLog.LogMessage logMessage = mLogger.err("%%");
+        logMessage.c("hello").c("world").flush();
+        assertEquals("helloworld", logMessage.toString());
+    }
+
+    /** Verifies that LogMessage silently ignores extraneous values. */
+    @Test
+    public void logMessageSilentlyIgnoresExtraneousValues() {
+        WifiLog.LogMessage logMessage = mLogger.err("%");
+        logMessage.c("hello world");
+        logMessage.c("more stuff");
+        logMessage.flush();
+        assertEquals("hello world", logMessage.toString());
+    }
+
+    /**
+     * Verifies that LogMessage silently ignores extraneous values,
+     * even with an empty format string.
+     */
+    @Test
+    public void logMessageSilentlyIgnoresExtraneousValuesEvenForEmptyFormat() {
+        WifiLog.LogMessage logMessage = mLogger.err("");
+        logMessage.c("hello world");
+        logMessage.c("more stuff");
+        logMessage.flush();
+        assertEquals("", logMessage.toString());
+    }
+
+    /**
+     * Verifies that LogMessage silently ignores extraneous values,
+     * even if the format string is all literals.
+     */
+    @Test
+    public void logMessageSilentlyIgnoresExtraneousValuesEvenForFormatWithoutPlaceholders() {
+        WifiLog.LogMessage logMessage = mLogger.err("literal format");
+        logMessage.c("hello world");
+        logMessage.c("more stuff");
+        logMessage.flush();
+        assertEquals("literal format", logMessage.toString());
+    }
+
+    /** Verifies that LogMessage copies an unused placeholder to output. */
+    @Test
+    public void logMessageCopiesUnusedPlaceholderToOutput() {
+        WifiLog.LogMessage logMessage = mLogger.err("%");
+        logMessage.flush();
+        assertEquals("%", logMessage.toString());
+    }
+
+    /** Verifies that LogMessage copies multiple unused placeholders to output. */
+    @Test
+    public void logMessageCopiesMultipleUnusedPlaceholdersToOutput() {
+        WifiLog.LogMessage logMessage = mLogger.err("%%%%%");
+        logMessage.flush();
+        assertEquals("%%%%%", logMessage.toString());
+    }
+
+    /**
+     * Verifies that LogMessage copies an unused placeholder to output,
+     * even if preceded by non-placeholders.
+     */
+    @Test
+    public void logMessageCopiesUnusedPlaceholderAtEndToOutput() {
+        WifiLog.LogMessage logMessage = mLogger.err("foo%");
+        logMessage.flush();
+        assertEquals("foo%", logMessage.toString());
+    }
+
+    /**
+     * Verifies that LogMessage copies an unused placeholder to output,
+     * even if followed by non-placeholders.
+     */
+    @Test
+    public void logMessageCopiesUnusedPlaceholderAtBeginToOutput() {
+        WifiLog.LogMessage logMessage = mLogger.err("%foo");
+        logMessage.flush();
+        assertEquals("%foo", logMessage.toString());
+    }
+
+    /**
+     * Verifies that LogMessage copies an unused placeholder to output,
+     * even if it is in the middle of non-placeholders.
+     */
+    @Test
+    public void logMessageCopiesUnusedPlaceholderInMiddleToOutput() {
+        WifiLog.LogMessage logMessage = mLogger.err("f%o");
+        logMessage.flush();
+        assertEquals("f%o", logMessage.toString());
+    }
+
+    /**
+     * Verifies that LogMessage copies multiple unused placeholders to output,
+     * even if they are embedded amongst non-placeholders.
+     */
+    @Test
+    public void logMessageCopiesUnusedPlaceholdersInMiddleToOutput() {
+        WifiLog.LogMessage logMessage = mLogger.err("f%o%o%d");
+        logMessage.flush();
+        assertEquals("f%o%o%d", logMessage.toString());
+    }
+
+    /**
+     * Verifies that LogMessage preserves meta-characters in format string.
+     *
+     * Note that we deliberately test only the meta-characters that we
+     * expect to find in log messages. (Newline might also be
+     * preserved, but clients shouldn't depend on that, as messages
+     * that have newlines make logs hard to read.)
+     */
+    @Test
+    public void logMessagePreservesMetaCharactersInFormat() {
+        WifiLog.LogMessage logMessage = mLogger.err("\\hello\tworld\\");
+        logMessage.flush();
+        assertEquals("\\hello\tworld\\", logMessage.toString());
+    }
+
+    /** Verifies that LogMessage propagates meta-characters in char values. */
+    @Test
+    public void logMessagePropagatesMetaCharactersInCharValues() {
+        WifiLog.LogMessage logMessage = mLogger.err("hello%big%world");
+        logMessage.c('\t').c('\\').flush();
+        assertEquals("hello\tbig\\world", logMessage.toString());
+    }
+
+    /** Verifies that LogMessage propagates meta-characters in String values. */
+    @Test
+    public void logMessagePropagatesMetaCharactersInStringValues() {
+        WifiLog.LogMessage logMessage = mLogger.err("%%world");
+        logMessage.c("hello\t").c("big\\").flush();
+        assertEquals("hello\tbig\\world", logMessage.toString());
+    }
+}
diff --git a/tests/wifitests/src/com/android/server/wifi/WifiDiagnosticsTest.java b/tests/wifitests/src/com/android/server/wifi/WifiDiagnosticsTest.java
index ce5ba7bf0..3f1d72b5f 100644
--- a/tests/wifitests/src/com/android/server/wifi/WifiDiagnosticsTest.java
+++ b/tests/wifitests/src/com/android/server/wifi/WifiDiagnosticsTest.java
@@ -16,12 +16,6 @@
 
 package com.android.server.wifi;
 
-import android.app.test.MockAnswerUtil.AnswerWithArguments;
-import android.content.Context;
-import android.test.suitebuilder.annotation.SmallTest;
-import com.android.internal.R;
-import android.util.LocalLog;
-
 import static org.junit.Assert.assertArrayEquals;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
@@ -36,10 +30,18 @@ import static org.mockito.Mockito.reset;
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
 
+import android.app.test.MockAnswerUtil.AnswerWithArguments;
+import android.content.Context;
+import android.test.suitebuilder.annotation.SmallTest;
+import android.util.LocalLog;
+
+import com.android.internal.R;
+
 import org.junit.Before;
 import org.junit.Test;
 import org.mockito.Mock;
 import org.mockito.MockitoAnnotations;
+import org.mockito.Spy;
 
 import java.io.FileDescriptor;
 import java.io.PrintWriter;
@@ -51,14 +53,12 @@ import java.util.regex.Pattern;
  */
 @SmallTest
 public class WifiDiagnosticsTest {
-    public static final String TAG = "WifiDiagsTest";
-
     @Mock WifiStateMachine mWsm;
     @Mock WifiNative mWifiNative;
     @Mock BuildProperties mBuildProperties;
     @Mock Context mContext;
     @Mock WifiInjector mWifiInjector;
-    @Mock WifiLog mLog;
+    @Spy FakeWifiLog mLog;
     WifiDiagnostics mWifiDiagnostics;
 
     private static final String FAKE_RING_BUFFER_NAME = "fake-ring-buffer";
@@ -275,7 +275,7 @@ public class WifiDiagnosticsTest {
         final boolean verbosityToggle = true;
         when(mWifiNative.startPktFateMonitoring()).thenReturn(false);
         mWifiDiagnostics.startLogging(verbosityToggle);
-        verify(mLog).e(contains("Failed"));
+        verify(mLog).wC(contains("Failed"));
     }
 
     /**