[GitHub] [accumulo] ctubbsii commented on a change in pull request #1765: Issue #1742 - Added forEach to ScannerBase. Added test in ScannerIT.

[GitBox <gi...@apache.org>]

ctubbsii commented on a change in pull request #1765:
URL: https://github.com/apache/accumulo/pull/1765#discussion_r520702472



##########
File path: core/src/test/java/org/apache/accumulo/core/clientImpl/ScannerBaseTest.java
##########
@@ -0,0 +1,117 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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 org.apache.accumulo.core.clientImpl;
+
+import static org.easymock.EasyMock.createMock;
+import static org.easymock.EasyMock.expect;
+import static org.easymock.EasyMock.replay;
+import static org.junit.Assert.assertEquals;
+
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.Map;
+import java.util.function.BiConsumer;
+
+import org.apache.accumulo.core.client.ScannerBase;
+import org.apache.accumulo.core.data.Key;
+import org.apache.accumulo.core.data.Value;
+import org.apache.hadoop.io.Text;
+import org.junit.Before;
+import org.junit.Test;
+
+public class ScannerBaseTest {
+
+  private ScannerBase s;
+  private Map<Key,Value> scannerMap;
+  private Iterator<Map.Entry<Key,Value>> it;
+  private Key key;
+  private Value val;
+  private BiConsumer<Key,Value> keyValueConsumer;
+  private forEachTester fet;
+
+  private static class forEachTester {
+
+    private Map<Key,Value> map;
+
+    forEachTester(Map<Key,Value> map) {
+      this.map = map;
+    }
+
+    public void forEach(BiConsumer<? super Key,? super Value> keyValueConsumer) {
+      for (Map.Entry<Key,Value> entry : this.map.entrySet()) {
+        keyValueConsumer.accept(entry.getKey(), entry.getValue());
+      }
+    }
+  }
+
+  @Before
+  public void setUp() throws Exception {
+    s = createMock(ScannerBase.class);
+  }
+
+  @Test
+  public void testScannerBaseForEach() throws Exception {
+    key = new Key(new Text("a"), new Text("cf1"), new Text("cq1"));
+    val = new Value(new Text("v1"));
+    scannerMap = new HashMap<>();
+
+    scannerMap.put(key, val);
+
+    fet = new forEachTester(scannerMap);
+
+    it = scannerMap.entrySet().iterator();
+
+    expect(s.iterator()).andReturn(it).times(3);
+    replay(s);
+
+    Map<Key,Value> map = new HashMap<>();
+
+    class MyBiConsumer implements BiConsumer<Key,Value> {
+      @Override
+      public void accept(Key key, Value value) {
+        map.put(key, value);
+      }
+    }
+
+    keyValueConsumer = new MyBiConsumer();
+
+    fet.forEach(keyValueConsumer);
+
+    // Test the Scanner values put into the map via keyValueConsumer
+
+    for (Map.Entry<Key,Value> entry : map.entrySet()) {
+      Map.Entry<Key,Value> expectedEntry = s.iterator().next();
+      Key expectedKey = expectedEntry.getKey();
+      Value expectedValue = expectedEntry.getValue();
+
+      String expectedCf = expectedKey.getColumnFamily().toString();
+      String actualCf = entry.getKey().getColumnFamily().toString();
+
+      String expectedCq = expectedKey.getColumnQualifier().toString();
+      String actualCq = entry.getKey().getColumnQualifier().toString();
+
+      String expectedVal = expectedValue.toString();
+      String actualVal = entry.getValue().toString();
+
+      assertEquals(expectedCf, actualCf);
+      assertEquals(expectedCq, actualCq);
+      assertEquals(expectedVal, actualVal);

Review comment:
       You don't need to compare CF and CQ, you can compare Key equality directly. That will shorten the test code a bit. You also don't need to call `toString()` on anything.
   
   ```suggestion
         Map.Entry<Key,Value> expectedEntry = s.iterator().next();
         assertEquals(expectedEntry.getKey(), entry.getKey());
         assertEquals(expectedEntry.getValue(), entry.getValue());
   ```

##########
File path: core/src/test/java/org/apache/accumulo/core/clientImpl/ScannerBaseTest.java
##########
@@ -0,0 +1,117 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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 org.apache.accumulo.core.clientImpl;
+
+import static org.easymock.EasyMock.createMock;
+import static org.easymock.EasyMock.expect;
+import static org.easymock.EasyMock.replay;
+import static org.junit.Assert.assertEquals;
+
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.Map;
+import java.util.function.BiConsumer;
+
+import org.apache.accumulo.core.client.ScannerBase;
+import org.apache.accumulo.core.data.Key;
+import org.apache.accumulo.core.data.Value;
+import org.apache.hadoop.io.Text;
+import org.junit.Before;
+import org.junit.Test;
+
+public class ScannerBaseTest {
+
+  private ScannerBase s;
+  private Map<Key,Value> scannerMap;
+  private Iterator<Map.Entry<Key,Value>> it;
+  private Key key;
+  private Value val;
+  private BiConsumer<Key,Value> keyValueConsumer;
+  private forEachTester fet;
+
+  private static class forEachTester {
+
+    private Map<Key,Value> map;
+
+    forEachTester(Map<Key,Value> map) {
+      this.map = map;
+    }
+
+    public void forEach(BiConsumer<? super Key,? super Value> keyValueConsumer) {
+      for (Map.Entry<Key,Value> entry : this.map.entrySet()) {
+        keyValueConsumer.accept(entry.getKey(), entry.getValue());
+      }
+    }
+  }
+
+  @Before
+  public void setUp() throws Exception {
+    s = createMock(ScannerBase.class);
+  }
+
+  @Test
+  public void testScannerBaseForEach() throws Exception {
+    key = new Key(new Text("a"), new Text("cf1"), new Text("cq1"));
+    val = new Value(new Text("v1"));
+    scannerMap = new HashMap<>();
+
+    scannerMap.put(key, val);
+
+    fet = new forEachTester(scannerMap);
+
+    it = scannerMap.entrySet().iterator();
+
+    expect(s.iterator()).andReturn(it).times(3);
+    replay(s);
+
+    Map<Key,Value> map = new HashMap<>();
+
+    class MyBiConsumer implements BiConsumer<Key,Value> {
+      @Override
+      public void accept(Key key, Value value) {
+        map.put(key, value);
+      }
+    }
+
+    keyValueConsumer = new MyBiConsumer();
+
+    fet.forEach(keyValueConsumer);

Review comment:
       ```suggestion
       Map<Key,Value> map = new HashMap<>();
       fet.forEach((k,v) -> map.put(k,v));
   ```

##########
File path: core/src/test/java/org/apache/accumulo/core/clientImpl/ScannerBaseTest.java
##########
@@ -0,0 +1,117 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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 org.apache.accumulo.core.clientImpl;
+
+import static org.easymock.EasyMock.createMock;
+import static org.easymock.EasyMock.expect;
+import static org.easymock.EasyMock.replay;
+import static org.junit.Assert.assertEquals;
+
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.Map;
+import java.util.function.BiConsumer;
+
+import org.apache.accumulo.core.client.ScannerBase;
+import org.apache.accumulo.core.data.Key;
+import org.apache.accumulo.core.data.Value;
+import org.apache.hadoop.io.Text;
+import org.junit.Before;
+import org.junit.Test;
+
+public class ScannerBaseTest {
+
+  private ScannerBase s;
+  private Map<Key,Value> scannerMap;
+  private Iterator<Map.Entry<Key,Value>> it;
+  private Key key;
+  private Value val;
+  private BiConsumer<Key,Value> keyValueConsumer;
+  private forEachTester fet;
+
+  private static class forEachTester {
+
+    private Map<Key,Value> map;
+
+    forEachTester(Map<Key,Value> map) {
+      this.map = map;
+    }
+
+    public void forEach(BiConsumer<? super Key,? super Value> keyValueConsumer) {
+      for (Map.Entry<Key,Value> entry : this.map.entrySet()) {
+        keyValueConsumer.accept(entry.getKey(), entry.getValue());
+      }
+    }
+  }
+
+  @Before
+  public void setUp() throws Exception {
+    s = createMock(ScannerBase.class);
+  }
+
+  @Test
+  public void testScannerBaseForEach() throws Exception {
+    key = new Key(new Text("a"), new Text("cf1"), new Text("cq1"));
+    val = new Value(new Text("v1"));
+    scannerMap = new HashMap<>();
+
+    scannerMap.put(key, val);
+
+    fet = new forEachTester(scannerMap);
+
+    it = scannerMap.entrySet().iterator();
+
+    expect(s.iterator()).andReturn(it).times(3);
+    replay(s);
+
+    Map<Key,Value> map = new HashMap<>();
+
+    class MyBiConsumer implements BiConsumer<Key,Value> {
+      @Override
+      public void accept(Key key, Value value) {
+        map.put(key, value);
+      }
+    }
+
+    keyValueConsumer = new MyBiConsumer();
+
+    fet.forEach(keyValueConsumer);
+
+    // Test the Scanner values put into the map via keyValueConsumer
+
+    for (Map.Entry<Key,Value> entry : map.entrySet()) {
+      Map.Entry<Key,Value> expectedEntry = s.iterator().next();
+      Key expectedKey = expectedEntry.getKey();
+      Value expectedValue = expectedEntry.getValue();
+
+      String expectedCf = expectedKey.getColumnFamily().toString();
+      String actualCf = entry.getKey().getColumnFamily().toString();
+
+      String expectedCq = expectedKey.getColumnQualifier().toString();
+      String actualCq = entry.getKey().getColumnQualifier().toString();
+
+      String expectedVal = expectedValue.toString();
+      String actualVal = entry.getValue().toString();
+
+      assertEquals(expectedCf, actualCf);
+      assertEquals(expectedCq, actualCq);
+      assertEquals(expectedVal, actualVal);
+    }

Review comment:
       Should verify mock objects at the end of the test.

##########
File path: core/src/test/java/org/apache/accumulo/core/clientImpl/ScannerBaseTest.java
##########
@@ -0,0 +1,117 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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 org.apache.accumulo.core.clientImpl;
+
+import static org.easymock.EasyMock.createMock;
+import static org.easymock.EasyMock.expect;
+import static org.easymock.EasyMock.replay;
+import static org.junit.Assert.assertEquals;
+
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.Map;
+import java.util.function.BiConsumer;
+
+import org.apache.accumulo.core.client.ScannerBase;
+import org.apache.accumulo.core.data.Key;
+import org.apache.accumulo.core.data.Value;
+import org.apache.hadoop.io.Text;
+import org.junit.Before;
+import org.junit.Test;
+
+public class ScannerBaseTest {
+
+  private ScannerBase s;
+  private Map<Key,Value> scannerMap;
+  private Iterator<Map.Entry<Key,Value>> it;
+  private Key key;
+  private Value val;
+  private BiConsumer<Key,Value> keyValueConsumer;
+  private forEachTester fet;

Review comment:
       I don't think most (if any) of these should be class members. They can be local variables in the test case.

##########
File path: core/src/test/java/org/apache/accumulo/core/clientImpl/ScannerBaseTest.java
##########
@@ -0,0 +1,117 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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 org.apache.accumulo.core.clientImpl;
+
+import static org.easymock.EasyMock.createMock;
+import static org.easymock.EasyMock.expect;
+import static org.easymock.EasyMock.replay;
+import static org.junit.Assert.assertEquals;
+
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.Map;
+import java.util.function.BiConsumer;
+
+import org.apache.accumulo.core.client.ScannerBase;
+import org.apache.accumulo.core.data.Key;
+import org.apache.accumulo.core.data.Value;
+import org.apache.hadoop.io.Text;
+import org.junit.Before;
+import org.junit.Test;
+
+public class ScannerBaseTest {
+
+  private ScannerBase s;
+  private Map<Key,Value> scannerMap;
+  private Iterator<Map.Entry<Key,Value>> it;
+  private Key key;
+  private Value val;
+  private BiConsumer<Key,Value> keyValueConsumer;
+  private forEachTester fet;
+
+  private static class forEachTester {
+
+    private Map<Key,Value> map;
+
+    forEachTester(Map<Key,Value> map) {
+      this.map = map;
+    }
+
+    public void forEach(BiConsumer<? super Key,? super Value> keyValueConsumer) {
+      for (Map.Entry<Key,Value> entry : this.map.entrySet()) {
+        keyValueConsumer.accept(entry.getKey(), entry.getValue());
+      }
+    }
+  }
+
+  @Before
+  public void setUp() throws Exception {
+    s = createMock(ScannerBase.class);
+  }

Review comment:
       This can be done in the test. It doesn't need to be here, unless it's common code for multiple tests.




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org