diff options
Diffstat (limited to '')
8 files changed, 112 insertions, 15 deletions
diff --git a/libs/thedevstacklogcat/src/androidTest/java/de/thedevstack/android/logcat/ApplicationTest.java b/libs/thedevstacklogcat/src/androidTest/java/de/thedevstack/android/logcat/ApplicationTest.java new file mode 100644 index 00000000..2e381ee7 --- /dev/null +++ b/libs/thedevstacklogcat/src/androidTest/java/de/thedevstack/android/logcat/ApplicationTest.java @@ -0,0 +1,13 @@ +package de.thedevstack.android.logcat; + +import android.app.Application; +import android.test.ApplicationTestCase; + +/** + * <a href="http://d.android.com/tools/testing/testing_android.html">Testing Fundamentals</a> + */ +public class ApplicationTest extends ApplicationTestCase<Application> { + public ApplicationTest() { + super(Application.class); + } +}
\ No newline at end of file diff --git a/libs/thedevstacklogcat/src/main/AndroidManifest.xml b/libs/thedevstacklogcat/src/main/AndroidManifest.xml new file mode 100644 index 00000000..59448708 --- /dev/null +++ b/libs/thedevstacklogcat/src/main/AndroidManifest.xml @@ -0,0 +1,4 @@ +<manifest xmlns:android="http://schemas.android.com/apk/res/android" + package="de.thedevstack.android.logcat"> + +</manifest> diff --git a/src/main/java/de/thedevstack/conversationsplus/utils/Logging.java b/libs/thedevstacklogcat/src/main/java/de/thedevstack/android/logcat/Logging.java index 40ec66a0..6af7a70e 100644 --- a/src/main/java/de/thedevstack/conversationsplus/utils/Logging.java +++ b/libs/thedevstacklogcat/src/main/java/de/thedevstack/android/logcat/Logging.java @@ -1,12 +1,36 @@ -package de.thedevstack.conversationsplus.utils; +package de.thedevstack.android.logcat; import android.util.Log; /** - * Created by tzur on 20.11.2015. + * Utility class to prefix every log tag. + * This can be used for better filtering in the log cat output activity. */ public class Logging { - protected static final String LOG_TAG_PREFIX = "thedevstack."; + /** + * The prefix for every log tag. + */ + protected static String LOG_TAG_PREFIX = "thedevstack."; + + /** + * Changes the default log tag prefix. + * The default value is <code>thedevstack.</code> + * @param logTagPrefix the new log tag prefix to use + */ + public static void initLogTagPrefix(String logTagPrefix) { + if (null != logTagPrefix) { + LOG_TAG_PREFIX = logTagPrefix; + } + } + + /** + * Returns the current log tag prefix. + * @return value of Logging.LOG_TAG_PREFIX + */ + public static String getLogTagPrefix() { + return LOG_TAG_PREFIX; + } + /** * Send a {@link Log#VERBOSE} log message. * @param tag Used to identify the source of a log message. It usually identifies diff --git a/src/main/java/de/thedevstack/android/logcat/adapters/LogCatArrayAdapter.java b/libs/thedevstacklogcat/src/main/java/de/thedevstack/android/logcat/adapters/LogCatArrayAdapter.java index c8a96ea3..c8a96ea3 100644 --- a/src/main/java/de/thedevstack/android/logcat/adapters/LogCatArrayAdapter.java +++ b/libs/thedevstacklogcat/src/main/java/de/thedevstack/android/logcat/adapters/LogCatArrayAdapter.java diff --git a/src/main/java/de/thedevstack/android/logcat/tasks/ReadLogCatAsyncTask.java b/libs/thedevstacklogcat/src/main/java/de/thedevstack/android/logcat/tasks/ReadLogCatAsyncTask.java index b9fa450b..1136faf8 100644 --- a/src/main/java/de/thedevstack/android/logcat/tasks/ReadLogCatAsyncTask.java +++ b/libs/thedevstacklogcat/src/main/java/de/thedevstack/android/logcat/tasks/ReadLogCatAsyncTask.java @@ -1,7 +1,6 @@ package de.thedevstack.android.logcat.tasks; import android.os.AsyncTask; -import de.thedevstack.conversationsplus.utils.Logging; import android.widget.ArrayAdapter; import java.io.BufferedReader; @@ -9,20 +8,46 @@ import java.io.IOException; import java.io.InputStreamReader; import java.util.ArrayList; -import de.thedevstack.conversationsplus.utils.StreamUtil; +import de.thedevstack.android.logcat.Logging; /** - * Created by tzur on 20.11.2015. + * Task to read the logcat of the App. + * The command <code>logcat -d -v time</code> is used to load the logs. + * This reader uses a white list to restrict the messages to display, otherwise it might be flooded with useless log messages. + * The white list checks if a log messages contains one of the following strings: + * <ul> + * <li>{@value Logging#LOG_TAG_PREFIX}</li> + * <li><code>E/</code> - for every error message</li> + * <li><code>W/</code> - for every warning message</li> + * </ul> */ public class ReadLogCatAsyncTask extends AsyncTask<Void, Void, String[]> { + /** + * The array adapter to publish the log messages to. + */ private final ArrayAdapter<String> arrayAdapter; + /** + * The command to execute logcat. + */ private static final String[] LOG_CAT_CMD = { "logcat", "-d", "-v", "time"}; - private static final String[] WHITE_LIST = { "thedevstack.", "E/", "W/" }; - private static final String[] BLACK_LIST = { "D/TextLayoutCache" }; + /** + * The white list to filter log messages. + */ + private static final String[] WHITE_LIST = { Logging.getLogTagPrefix(), "E/", "W/" }; + /** + * Initializes the Task with the array adapter to publish the log messages to. + * @param arrayAdapter the array adapter + */ public ReadLogCatAsyncTask(ArrayAdapter<String> arrayAdapter) { this.arrayAdapter = arrayAdapter; } + + /** + * Executes the logcat command, reads the output of the command and returns all log messages. + * @param params no params will be passed. (interface compliance) + * @return the array of log messages + */ @Override protected String[] doInBackground(Void... params) { ArrayList<String> logCatOutput = new ArrayList<>(); @@ -34,16 +59,24 @@ public class ReadLogCatAsyncTask extends AsyncTask<Void, Void, String[]> { while ((line = bufferedReader.readLine()) != null) { logCatOutput.add(line); } - bufferedReader.close(); } catch (IOException e) { Logging.e("ReadLogCat", "error while retrieving information from logcat: " + e.getMessage(), e); } finally { - StreamUtil.close(bufferedReader); + if (null != bufferedReader) { + try { + bufferedReader.close(); + } catch (IOException e) { + } + } } logCatOutput.trimToSize(); return logCatOutput.toArray(new String[0]); } + /** + * Clears the array adapter and adds the filtered log messages. + * @param items all log messages + */ @Override protected void onPostExecute(String[] items) { this.arrayAdapter.clear(); @@ -56,6 +89,11 @@ public class ReadLogCatAsyncTask extends AsyncTask<Void, Void, String[]> { } } + /** + * Checks whether a log message contains a white listed string or not. + * @param item the item to filter + * @return <code>true</code> if the string should be filtered (removed from the list) <code>false</code> otherwise. + */ protected boolean filter(String item) { for (String whiteListed : ReadLogCatAsyncTask.WHITE_LIST) { if (item.contains(whiteListed)) { diff --git a/src/main/java/de/thedevstack/android/logcat/ui/LogCatOutputCopyOnClickListener.java b/libs/thedevstacklogcat/src/main/java/de/thedevstack/android/logcat/ui/LogCatOutputCopyOnClickListener.java index da82fc7f..6568a2c5 100644 --- a/src/main/java/de/thedevstack/android/logcat/ui/LogCatOutputCopyOnClickListener.java +++ b/libs/thedevstacklogcat/src/main/java/de/thedevstack/android/logcat/ui/LogCatOutputCopyOnClickListener.java @@ -9,8 +9,6 @@ import android.widget.Toast; import java.util.ArrayList; import de.thedevstack.android.logcat.adapters.LogCatArrayAdapter; -import de.thedevstack.conversationsplus.ConversationsPlusApplication; -import de.thedevstack.conversationsplus.R; /** * Created by tzur on 20.11.2015. @@ -18,10 +16,12 @@ import de.thedevstack.conversationsplus.R; public class LogCatOutputCopyOnClickListener implements View.OnClickListener { private final LogCatArrayAdapter logCatOutputAdapter; private final Context context; + private final int resIdForToast; - public LogCatOutputCopyOnClickListener(Context context, LogCatArrayAdapter logCatOutputAdapter) { + public LogCatOutputCopyOnClickListener(Context context, LogCatArrayAdapter logCatOutputAdapter, int resIdForToast) { this.logCatOutputAdapter = logCatOutputAdapter; this.context = context; + this.resIdForToast = resIdForToast; } @Override @@ -33,10 +33,10 @@ public class LogCatOutputCopyOnClickListener implements View.OnClickListener { sb.append(item); sb.append("\n"); } - ClipboardManager clipboard = (ClipboardManager) ConversationsPlusApplication.getInstance().getSystemService(Context.CLIPBOARD_SERVICE); + ClipboardManager clipboard = (ClipboardManager) this.context.getSystemService(Context.CLIPBOARD_SERVICE); ClipData clip = ClipData.newPlainText("c+logcat", sb.toString()); clipboard.setPrimaryClip(clip); - Toast.makeText(this.context, R.string.cplus_copied_to_clipboard, Toast.LENGTH_LONG).show(); + Toast.makeText(this.context, this.context.getText(this.resIdForToast), Toast.LENGTH_LONG).show(); } } } diff --git a/libs/thedevstacklogcat/src/main/res/values/strings.xml b/libs/thedevstacklogcat/src/main/res/values/strings.xml new file mode 100644 index 00000000..45f5e7fd --- /dev/null +++ b/libs/thedevstacklogcat/src/main/res/values/strings.xml @@ -0,0 +1,3 @@ +<resources> + <string name="thedevstack_logcat_copy">Copy</string> +</resources> diff --git a/libs/thedevstacklogcat/src/test/java/de/thedevstack/android/logcat/ExampleUnitTest.java b/libs/thedevstacklogcat/src/test/java/de/thedevstack/android/logcat/ExampleUnitTest.java new file mode 100644 index 00000000..1d2bc545 --- /dev/null +++ b/libs/thedevstacklogcat/src/test/java/de/thedevstack/android/logcat/ExampleUnitTest.java @@ -0,0 +1,15 @@ +package de.thedevstack.android.logcat; + +import org.junit.Test; + +import static org.junit.Assert.*; + +/** + * To work on unit tests, switch the Test Artifact in the Build Variants view. + */ +public class ExampleUnitTest { + @Test + public void addition_isCorrect() throws Exception { + assertEquals(4, 2 + 2); + } +}
\ No newline at end of file |