[MOB-8360] Add Expirements APIs (#219)

* Add Experiments APIs (Flutter)

* Add Experiments APIs (Android)

* Add Experiments APIs (iOS)

* Update Changelog

* Add Experiments APIs tests

Author: TheBuggedYRN

CHANGELOG.md

@@ -1,6 +1,7 @@
 ## master
 
 * Fixes iOS platform calls not completing with `void` return type
+* Adds Experiments APIs.
 
 ## v10.11.0 (2022-01-04)
 

android/src/main/java/com/instabug/instabugflutter/InstabugFlutterPlugin.java

@@ -303,6 +303,31 @@ public ArrayList<String> getTags() {
         return Instabug.getTags();
     }
 
+    /**
+     * Adds experiments to the next report.
+     *
+     * @param experiments An array of experiments to add.
+     */
+    public void addExperiments(ArrayList<String> experiments) {
+        Instabug.addExperiments(experiments);
+    }
+
+    /**
+     * Removes certain experiments from the next report.
+     *
+     * @param experiments An array of experiments to remove.
+     */
+    public void removeExperiments(ArrayList<String> experiments) {
+        Instabug.removeExperiments(experiments);
+    }
+
+    /**
+     * Clears all experiments from the next report.
+     */
+    public void clearAllExperiments() {
+        Instabug.clearAllExperiments();
+    }
+
     /**
      * Set custom user attributes that are going to be sent with each feedback, bug
      * or crash.

example/android/app/src/main/kotlin/com/example/InstabugSample/OnMethodCallTests.java

@@ -77,6 +77,37 @@ public void testAppendTags() {
         verify(instabugMock).appendTags(tags);
     }
 
+    public void testAddExperiments() {
+        String methodName = "addExperiments";
+        ArrayList<Object> argsList = new ArrayList<>();
+        ArrayList<String> experiments = new ArrayList<>();
+        experiments.add("exp1");
+        experiments.add("exp2");
+        argsList.add(experiments);
+        Mockito.doNothing().when(instabugMock).addExperiments(any(ArrayList.class));
+        testMethodCall(methodName, argsList);
+        verify(instabugMock).addExperiments(experiments);
+    }
+
+    public void testRemoveExperiments() {
+        String methodName = "removeExperiments";
+        ArrayList<Object> argsList = new ArrayList<>();
+        ArrayList<String> experiments = new ArrayList<>();
+        experiments.add("exp1");
+        experiments.add("exp2");
+        argsList.add(experiments);
+        Mockito.doNothing().when(instabugMock).removeExperiments(any(ArrayList.class));
+        testMethodCall(methodName, argsList);
+        verify(instabugMock).removeExperiments(experiments);
+    }
+
+    public void testClearAllExperiments() {
+        String methodName = "clearAllExperiments";
+        Mockito.doNothing().when(instabugMock).clearAllExperiments();
+        testMethodCall(methodName, null);
+        verify(instabugMock).clearAllExperiments();
+    }
+
     public void testShowBugReportingWithReportTypeAndOptions() {
         String methodName = "showBugReportingWithReportTypeAndOptions";
         ArrayList<Object> argsList = new ArrayList<>();

example/android/app/src/test/java/com/example/InstabugSample/InstabugFlutterPluginTest.java

@@ -41,6 +41,30 @@ public void testAppendTags() {
         new OnMethodCallTests().testAppendTags();
     }
 
+    /**
+     * (ArrayList<String>)
+     */
+    @Test
+    public void testAddExperiments() {
+        new OnMethodCallTests().testAddExperiments();
+    }
+
+    /**
+     * (ArrayList<String>)
+     */
+    @Test
+    public void testRemoveExperiments() {
+        new OnMethodCallTests().testRemoveExperiments();
+    }
+
+    /**
+     * ()
+     */
+    @Test
+    public void testClearAllExperiments() {
+        new OnMethodCallTests().testClearAllExperiments();
+    }
+
     /**
      * (String, ArrayList<String>)
      */

example/ios/InstabugSampleTests/InstabugSampleTests.m

@@ -89,6 +89,61 @@ - (void)testAppendTags {
      [self waitForExpectationsWithTimeout:kTimeout handler:nil];
  }
 
+- (void)testAddExperiments {
+    id mock = OCMClassMock([InstabugFlutterPlugin class]);
+    InstabugFlutterPlugin *instabug = [[InstabugFlutterPlugin alloc] init];
+    
+    NSArray *experiments = [NSArray arrayWithObjects:@"exp1", @"exp2", nil];
+    NSArray *arguments = [NSArray arrayWithObjects: experiments, nil];
+    FlutterMethodCall *call = [FlutterMethodCall methodCallWithMethodName:@"addExperiments:" arguments:arguments];
+    [[[mock stub] classMethod] addExperiments:experiments];
+
+    XCTestExpectation *expectation = [self expectationWithDescription:@"Result is called"];
+    [instabug  handleMethodCall:call result:^(id _Nullable result) {
+         XCTAssertNil(result);
+         [expectation fulfill];
+     }];
+
+    [[[mock verify] classMethod] addExperiments:experiments];
+    [self waitForExpectationsWithTimeout:kTimeout handler:nil];
+}
+
+- (void)testRemoveExperiments {
+    id mock = OCMClassMock([InstabugFlutterPlugin class]);
+    InstabugFlutterPlugin *instabug = [[InstabugFlutterPlugin alloc] init];
+    
+    NSArray *experiments = [NSArray arrayWithObjects:@"exp1", @"exp2", nil];
+    NSArray *arguments = [NSArray arrayWithObjects: experiments, nil];
+    FlutterMethodCall *call = [FlutterMethodCall methodCallWithMethodName:@"removeExperiments:" arguments:arguments];
+    [[[mock stub] classMethod] removeExperiments:experiments];
+
+    XCTestExpectation *expectation = [self expectationWithDescription:@"Result is called"];
+    [instabug  handleMethodCall:call result:^(id _Nullable result) {
+         XCTAssertNil(result);
+         [expectation fulfill];
+     }];
+
+    [[[mock verify] classMethod] removeExperiments:experiments];
+    [self waitForExpectationsWithTimeout:kTimeout handler:nil];
+}
+
+- (void)testClearAllExperiments {
+    id mock = OCMClassMock([InstabugFlutterPlugin class]);
+    InstabugFlutterPlugin *instabug = [[InstabugFlutterPlugin alloc] init];
+    
+    FlutterMethodCall *call = [FlutterMethodCall methodCallWithMethodName:@"clearAllExperiments" arguments:NULL];
+    [[[mock stub] classMethod] clearAllExperiments];
+
+    XCTestExpectation *expectation = [self expectationWithDescription:@"Result is called"];
+    [instabug  handleMethodCall:call result:^(id _Nullable result) {
+         XCTAssertNil(result);
+         [expectation fulfill];
+     }];
+
+    [[[mock verify] classMethod] clearAllExperiments];
+    [self waitForExpectationsWithTimeout:kTimeout handler:nil];
+}
+
  - (void)testShowBugReportingWithReportTypeAndOptions {
      id mock = OCMClassMock([InstabugFlutterPlugin class]);
      InstabugFlutterPlugin *instabug = [[InstabugFlutterPlugin alloc] init];

ios/Classes/InstabugFlutterPlugin.h

@@ -119,6 +119,23 @@
  */
 + (NSArray *)getTags;
 
+/**
+ * Adds experiments to the next report.
+ * @param experiments An array of experiments to add.
+ */
++ (void)addExperiments:(NSArray *)experiments;
+
+/**
+ * Removes certain experiments from the next report.
+ * @param experiments An array of experiments to remove.
+ */
++ (void)removeExperiments:(NSArray *)experiments;
+
+/**
+ * Clears all experiments from the next report.
+ */
++ (void)clearAllExperiments;
+
 /**
  * Set custom user attributes that are going to be sent with each feedback, bug or crash.
  * @param value User attribute value.

ios/Classes/InstabugFlutterPlugin.m

@@ -235,6 +235,29 @@ + (NSArray*)getTags {
     return [Instabug getTags];
 }
 
+/**
+ * Adds experiments to the next report.
+ * @param experiments An array of experiments to add.
+ */
++ (void)addExperiments:(NSArray *)experiments {
+    [Instabug addExperiments:experiments];
+}
+
+/**
+ * Removes certain experiments from the next report.
+ * @param experiments An array of experiments to remove.
+ */
++ (void)removeExperiments:(NSArray *)experiments {
+    [Instabug removeExperiments:experiments];
+}
+
+/**
+ * Clears all experiments from the next report.
+ */
++ (void)clearAllExperiments {
+    [Instabug clearAllExperiments];
+}
+
 /**
  * Set custom user attributes that are going to be sent with each feedback, bug or crash.
  * @param value User attribute value.

lib/Instabug.dart

@@ -178,6 +178,23 @@ class Instabug {
     return tags?.cast<String>();
   }
 
+  /// Adds experiments to the next report.
+  static Future<void> addExperiments(List<String> experiments) async {
+    final params = <dynamic>[experiments];
+    await _channel.invokeMethod<Object>('addExperiments:', params);
+  }
+
+  /// Removes certain experiments from the next report.
+  static Future<void> removeExperiments(List<String> experiments) async {
+    final params = <dynamic>[experiments];
+    await _channel.invokeMethod<Object>('removeExperiments:', params);
+  }
+
+  /// Clears all experiments from the next report.
+  static Future<void> clearAllExperiments() async {
+    await _channel.invokeMethod<Object>('clearAllExperiments');
+  }
+
   /// Add custom user attribute [value] with a [key] that is going to be sent with each feedback, bug or crash.
   static Future<void> setUserAttribute(String value, String key) async {
     final List<dynamic> params = <dynamic>[value, key];

test/instabug_flutter_test.dart

@@ -280,6 +280,49 @@ void main() {
     expect(tags, ['tag1', 'tag2']);
   });
 
+  test(
+    'test addExperiments should be called with argument List of strings',
+    () async {
+      const experiments = ['exp1', 'exp2'];
+      Instabug.addExperiments(experiments);
+      final args = <dynamic>[experiments];
+      expect(log, <Matcher>[
+        isMethodCall(
+          'addExperiments:',
+          arguments: args,
+        )
+      ]);
+    },
+  );
+
+  test(
+    'test removeExperiments should be called with argument List of strings',
+    () async {
+      const experiments = ['exp1', 'exp2'];
+      Instabug.removeExperiments(experiments);
+      final args = <dynamic>[experiments];
+      expect(log, <Matcher>[
+        isMethodCall(
+          'removeExperiments:',
+          arguments: args,
+        )
+      ]);
+    },
+  );
+
+  test(
+    'test clearAllExperiments should be called with no arguments',
+    () async {
+      Instabug.clearAllExperiments();
+      expect(log, <Matcher>[
+        isMethodCall(
+          'clearAllExperiments',
+          arguments: null,
+        )
+      ]);
+    },
+  );
+
   test(
       'test setUserAttributeWithKey should be called with two string arguments',
       () async {