Fix libadblockplus-android tests

adblock-android-tests/src/org/adblockplus/libadblockplus/tests/FilterEngineTest.java

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-present eyeo GmbH
  *
  * Adblock Plus is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 3 as
  * published by the Free Software Foundation.
  *
  * Adblock Plus is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 package org.adblockplus.libadblockplus.tests;
 
+import android.util.Log;
+
+import org.adblockplus.libadblockplus.BaseFilterEngineTest;
 import org.adblockplus.libadblockplus.Filter;
 import org.adblockplus.libadblockplus.FilterEngine;
 import org.adblockplus.libadblockplus.MockFilterChangeCallback;
 import org.adblockplus.libadblockplus.Subscription;
 
 import org.junit.Test;
 
 import java.util.List;
 
 public class FilterEngineTest extends BaseFilterEngineTest
 {
+  private static final String TAG = FilterEngineTest.class.getSimpleName();
+
   @Test
   public void testFilterCreation()
   {
     Filter filter1 = filterEngine.getFilter("foo");
     assertEquals(Filter.Type.BLOCKING, filter1.getType());
     Filter filter2 = filterEngine.getFilter("@@foo");
     assertEquals(Filter.Type.EXCEPTION, filter2.getType());
     Filter filter3 = filterEngine.getFilter("example.com##foo");
     assertEquals(Filter.Type.ELEMHIDE, filter3.getType());
     Filter filter4 = filterEngine.getFilter("example.com#@#foo");
     assertEquals(Filter.Type.ELEMHIDE_EXCEPTION, filter4.getType());
     Filter filter5 = filterEngine.getFilter("  foo  ");
     assertEquals(filter1, filter5);
   }
 
   @Test
   public void testAddRemoveFilters()
   {
     while (filterEngine.getListedFilters().size() > 0)
     {
+      int prev = filterEngine.getListedFilters().size();

[anton, 2018/08/24 12:25:04]

Can you please explain what's happening here?
Is it to make sure `removeFromList()` really deletes a filter?

Originally it was just removing all the filters until we have it.

[René Jeschke, 2018/08/27 20:02:15]

There was a change in the way subscriptions work in libapb. The AA subscription
can not be removed from listed subscriptions as soon as it has been enabled.
Disabling is possible, but it will stay listed. This caused many tests to fail
or run in endless loops. The 'prev' thing now checks if we really removed a
subscription and breaks the loop otherwise. So we only end up with failing test
in the worst case and not endless loops.

       filterEngine.getListedFilters().get(0).removeFromList();
+      if (prev == filterEngine.getListedFilters().size())
+      {
+        Log.e(TAG, "Failed to clear listed filters.");
+      }
     }
 
     assertEquals(0, filterEngine.getListedFilters().size());
     Filter filter = filterEngine.getFilter("foo");
     assertEquals(0, filterEngine.getListedFilters().size());
     assertFalse(filter.isListed());
 
     filter.addToList();
     assertEquals(1, filterEngine.getListedFilters().size());
     assertEquals(filter, filterEngine.getListedFilters().get(0));
     assertTrue(filter.isListed());
 
     filter.addToList();
     assertEquals(1, filterEngine.getListedFilters().size());
     assertEquals(filter, filterEngine.getListedFilters().get(0));
     assertTrue(filter.isListed());
 
     filter.removeFromList();
     assertEquals(0, filterEngine.getListedFilters().size());
     assertFalse(filter.isListed());
 
     filter.removeFromList();
     assertEquals(0, filterEngine.getListedFilters().size());
     assertFalse(filter.isListed());
   }
 
   @Test
+  public void testAddedSubscriptionIsEnabled()
+  {
+    Subscription subscription = filterEngine.getSubscription("foo");
+    assertFalse(subscription.isDisabled());
+  }
+
+  @Test
+  public void testDisablingSubscriptionDisablesItAndFiresEvent()
+  {
+    Subscription subscription = filterEngine.getSubscription("foo");
+    MockFilterChangeCallback callback = new MockFilterChangeCallback("subscription.disabled", "url","foo");
+    filterEngine.setFilterChangeCallback(callback);
+    assertFalse(subscription.isDisabled());
+    subscription.setDisabled(true);
+    assertEquals(1, callback.getTimesCalled());
+    assertTrue(subscription.isDisabled());
+    filterEngine.removeFilterChangeCallback();
+  }
+
+  @Test
+  public void testEnablingSubscriptionEnablesItAndFiresEvent()
+  {
+    Subscription subscription = filterEngine.getSubscription("foo");
+    assertFalse(subscription.isDisabled());
+    subscription.setDisabled(true);
+    assertTrue(subscription.isDisabled());
+
+    MockFilterChangeCallback callback = new MockFilterChangeCallback("subscription.disabled", "url", "foo");
+    filterEngine.setFilterChangeCallback(callback);
+    subscription.setDisabled(false);
+    assertEquals(1, callback.getTimesCalled());
+    assertFalse(subscription.isDisabled());
+    filterEngine.removeFilterChangeCallback();
+  }
+
+  @Test
   public void testAddRemoveSubscriptions()
   {
     while (filterEngine.getListedSubscriptions().size() > 0)

[anton, 2018/08/24 12:25:04]

copy-paste from above. Can you create separate function like `clearFilters()`
and call it from there and here?
I agree it was also copy-paster before but it was 2 lines and now it's much
more.

[René Jeschke, 2018/08/27 20:02:15]

Done.

     {
+      int prev = filterEngine.getListedSubscriptions().size();
       filterEngine.getListedSubscriptions().get(0).removeFromList();
+      if (prev == filterEngine.getListedSubscriptions().size())
+      {
+        Log.e(TAG, "Failed to clear listed subscriptions.");
+        break;
+      }
     }
 
     assertEquals(0, filterEngine.getListedSubscriptions().size());
     Subscription subscription = filterEngine.getSubscription("foo");
     assertEquals(0, filterEngine.getListedSubscriptions().size());
     assertFalse(subscription.isListed());
     subscription.addToList();
     assertEquals(1, filterEngine.getListedSubscriptions().size());
     assertEquals(subscription, filterEngine.getListedSubscriptions().get(0));
     assertTrue(subscription.isListed());
@@ skipping 223 matching lines @@
         {
           "http://ads.com/frame/",
           "http://example.org/",
           "http://example.com/"
         });
     assertNotNull(match5);
     assertEquals(Filter.Type.EXCEPTION, match5.getType());
   }
 
   @Test
-  public void testFirstRunFlag()
-  {
-    assertFalse(filterEngine.isFirstRun());
-  }
-
-  @Test
   public void testSetRemoveFilterChangeCallback()
   {
-    MockFilterChangeCallback mockFilterChangeCallback = new MockFilterChangeCallback(0);
+    MockFilterChangeCallback callback = new MockFilterChangeCallback("subscription.added", "defaults", "blocking");
 
-    filterEngine.setFilterChangeCallback(mockFilterChangeCallback);
-    filterEngine.getFilter("foo").addToList();
-    assertEquals(1, mockFilterChangeCallback.getTimesCalled());
+    filterEngine.setFilterChangeCallback(callback);
+    Filter filter = filterEngine.getFilter("foo");
+    assertFalse(filter.isListed());
+    filter.addToList();
+    assertEquals(1, callback.getTimesCalled());
 
     filterEngine.removeFilterChangeCallback();
-    filterEngine.getFilter("foo").removeFromList();
-    assertEquals(1, mockFilterChangeCallback.getTimesCalled());
+    callback.clearCheckValues();
+    filter.removeFromList();
+    assertFalse(filter.isListed());
+    assertEquals(1, callback.getTimesCalled());
   }
 
   @Test
   public void testDocumentWhitelisting()
   {
     filterEngine.getFilter("@@||example.org^$document").addToList();
     filterEngine.getFilter("@@||example.com^$document,domain=example.de").addToList();
 
     String[] emptyArray = new String[]
       {
@@ skipping 124 matching lines @@
     listedSubscriptions = filterEngine.getListedSubscriptions();
     for (Subscription eachSubscription : listedSubscriptions)
     {
       if (eachSubscription.isAcceptableAds())
       {
         assertFalse(eachSubscription.isDisabled());
       }
     }
   }
 }