You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@druid.apache.org by GitBox <gi...@apache.org> on 2021/08/07 04:35:58 UTC

[GitHub] [druid] wx930910 opened a new pull request #11561: refactor MacroTestBase by using Mockito

wx930910 opened a new pull request #11561:
URL: https://github.com/apache/druid/pull/11561


   <!-- Thanks for trying to help us make Apache Druid be the best it can be! Please fill out as much of the following information as is possible (where relevant, and remove it when irrelevant) to help make the intention and scope of this PR clear in order to ease review. -->
   
   <!-- Please read the doc for contribution (https://github.com/apache/druid/blob/master/CONTRIBUTING.md) before making this PR. Also, once you open a PR, please _avoid using force pushes and rebasing_ since these make it difficult for reviewers to see what you've changed in response to their reviews. See [the 'If your pull request shows conflicts with master' section](https://github.com/apache/druid/blob/master/CONTRIBUTING.md#if-your-pull-request-shows-conflicts-with-master) for more details. -->
   
   Fixes #11560 
   
   <!-- Replace XXXX with the id of the issue fixed in this PR. Remove this section if there is no corresponding issue. Don't reference the issue in the title of this pull-request. -->
   
   <!-- If you are a committer, follow the PR action item checklist for committers:
   https://github.com/apache/druid/blob/master/dev/committer-instructions.md#pr-and-issue-action-item-checklist-for-committers. -->
   
   ### Description
   
   Refactor test class [MacroTestBase](https://github.com/apache/druid/blob/8296123d895db7d06bc4517db5e767afb7862b83/processing/src/test/java/org/apache/druid/query/expression/MacroTestBase.java#L35).
   <!-- Describe the goal of this PR, what problem are you fixing. If there is a corresponding issue (referenced above), it's not necessary to repeat the description here, however, you may choose to keep one summary sentence. -->
   
   <!-- Describe your patch: what did you change in code? How did you fix the problem? -->
   
   <!-- If there are several relatively logically separate changes in this PR, create a mini-section for each of them. For example: -->
   
   <!--
   In each section, please describe design decisions made, including:
    - Choice of algorithms
    - Behavioral aspects. What configuration values are acceptable? How are corner cases and error conditions handled, such as when there are insufficient resources?
    - Class organization and design (how the logic is split between classes, inheritance, composition, design patterns)
    - Method organization and design (how the logic is split between methods, parameters and return types)
    - Naming (class, method, API, configuration, HTTP endpoint, names of emitted metrics)
   -->
   
   
   <!-- It's good to describe an alternative design (or mention an alternative name) for every design (or naming) decision point and compare the alternatives with the designs that you've implemented (or the names you've chosen) to highlight the advantages of the chosen designs and names. -->
   
   <!-- If there was a discussion of the design of the feature implemented in this PR elsewhere (e. g. a "Proposal" issue, any other issue, or a thread in the development mailing list), link to that discussion from this PR description and explain what have changed in your final design compared to your original proposal or the consensus version in the end of the discussion. If something hasn't changed since the original discussion, you can omit a detailed discussion of those aspects of the design here, perhaps apart from brief mentioning for the sake of readability of this PR description. -->
   
   <!-- Some of the aspects mentioned above may be omitted for simple and small changes. -->
   
   <hr>
   
   ##### Key changed/added classes in this PR
   - Create mocking object to replace test subclass `WrappedExprMacro`, decouple test from production code.
   - Make test logic more clear by using method stub instead of method overriding.
   - Extract AtomicLong variable out of the test subclass. Use the extracted variable in assertation statement to check `apply(List)` method invocation status.
   
   <hr>
   
   <!-- Check the items by putting "x" in the brackets for the done things. Not all of these items apply to every PR. Remove the items which are not done or not relevant to the PR. None of the items from the checklist below are strictly necessary, but it would be very helpful if you at least self-review the PR. -->
   
   This PR has:
   - [x] been self-reviewed.
   - [x] added documentation for new or modified features or behaviors.
   - [ ] added Javadocs for most classes and all non-trivial methods. Linked related entities via Javadoc links.
   - [ ] added or updated version, license, or notice information in [licenses.yaml](https://github.com/apache/druid/blob/master/dev/license.md)
   - [x] added comments explaining the "why" and the intent of the code wherever would not be obvious for an unfamiliar reader.
   - [ ] added unit tests or modified existing tests to cover new code paths, ensuring the threshold for [code coverage](https://github.com/apache/druid/blob/master/dev/code-review/code-coverage.md) is met.
   - [ ] added integration tests.
   - [ ] been tested in a test Druid cluster.
   


-- 
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.

To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org

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



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org


[GitHub] [druid] kfaraz commented on pull request #11561: refactor MacroTestBase by using Mockito

Posted by GitBox <gi...@apache.org>.
kfaraz commented on pull request #11561:
URL: https://github.com/apache/druid/pull/11561#issuecomment-942167505


   Thanks for the quick changes @wx930910 , all LGTM.
   
   CI seems to be failing due to checkstyle (unused import/wrong import order), please fix that.


-- 
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.

To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org

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



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org


[GitHub] [druid] wx930910 commented on a change in pull request #11561: refactor MacroTestBase by using Mockito

Posted by GitBox <gi...@apache.org>.
wx930910 commented on a change in pull request #11561:
URL: https://github.com/apache/druid/pull/11561#discussion_r727756373



##########
File path: processing/src/test/java/org/apache/druid/query/expression/MacroTestBase.java
##########
@@ -58,40 +63,36 @@ protected Expr apply(final List<Expr> args)
   /**
    * Evalutes {@code expr} using our macro.
    *
-   * @param expression expression to evalute
-   * @param bindings   bindings for evaluation
+   * @param expression
+   *          expression to evalute
+   * @param bindings
+   *          bindings for evaluation
    *
-   * @throws AssertionError if {@link ExprMacroTable.ExprMacro#apply} is not called on our macro during parsing
+   * @throws AssertionError
+   *           if {@link ExprMacroTable.ExprMacro#apply} is not called on our
+   *           macro during parsing
    */
   protected ExprEval<?> eval(
       final String expression,
-      final Expr.ObjectBinding bindings
-  )
+      final Expr.ObjectBinding bindings)
   {
-    // WrappedExprMacro allows us to confirm that our ExprMacro was actually called.
-    class WrappedExprMacro implements ExprMacroTable.ExprMacro
-    {
-      private final AtomicLong calls = new AtomicLong();
-
-      @Override
-      public String name()
-      {
-        return macro.name();
-      }
-
-      @Override
-      public Expr apply(List<Expr> args)
-      {
-        calls.incrementAndGet();
-        return macro.apply(args);
-      }
-    }
-
-    final WrappedExprMacro wrappedMacro = new WrappedExprMacro();
+    // Create variables for tracking behaviors of mock object
+    AtomicLong wrappedMacroCalls = new AtomicLong();
+    // Construct mock object
+    final ExprMacro wrappedMacro = mock(ExprMacroTable.ExprMacro.class);
+    // Method Stubs
+    when(wrappedMacro.name()).thenAnswer((stubInvo) -> {
+      return macro.name();
+    });
+    when(wrappedMacro.apply(any(List.class))).thenAnswer((stubInvo) -> {
+      List<Expr> args = stubInvo.getArgument(0);
+      wrappedMacroCalls.incrementAndGet();

Review comment:
       @kfaraz Thanks for the suggestions! I agreed and will revise the code correspondingly.

##########
File path: processing/src/test/java/org/apache/druid/query/expression/MacroTestBase.java
##########
@@ -58,40 +63,36 @@ protected Expr apply(final List<Expr> args)
   /**
    * Evalutes {@code expr} using our macro.
    *
-   * @param expression expression to evalute
-   * @param bindings   bindings for evaluation
+   * @param expression
+   *          expression to evalute
+   * @param bindings
+   *          bindings for evaluation
    *
-   * @throws AssertionError if {@link ExprMacroTable.ExprMacro#apply} is not called on our macro during parsing
+   * @throws AssertionError
+   *           if {@link ExprMacroTable.ExprMacro#apply} is not called on our
+   *           macro during parsing
    */
   protected ExprEval<?> eval(
       final String expression,
-      final Expr.ObjectBinding bindings
-  )
+      final Expr.ObjectBinding bindings)
   {
-    // WrappedExprMacro allows us to confirm that our ExprMacro was actually called.
-    class WrappedExprMacro implements ExprMacroTable.ExprMacro
-    {
-      private final AtomicLong calls = new AtomicLong();
-
-      @Override
-      public String name()
-      {
-        return macro.name();
-      }
-
-      @Override
-      public Expr apply(List<Expr> args)
-      {
-        calls.incrementAndGet();
-        return macro.apply(args);
-      }
-    }
-
-    final WrappedExprMacro wrappedMacro = new WrappedExprMacro();
+    // Create variables for tracking behaviors of mock object
+    AtomicLong wrappedMacroCalls = new AtomicLong();
+    // Construct mock object
+    final ExprMacro wrappedMacro = mock(ExprMacroTable.ExprMacro.class);
+    // Method Stubs
+    when(wrappedMacro.name()).thenAnswer((stubInvo) -> {
+      return macro.name();
+    });
+    when(wrappedMacro.apply(any(List.class))).thenAnswer((stubInvo) -> {
+      List<Expr> args = stubInvo.getArgument(0);
+      wrappedMacroCalls.incrementAndGet();

Review comment:
       @kfaraz Thanks for the comments! I agreed and will revise the code correspondingly.

##########
File path: processing/src/test/java/org/apache/druid/query/expression/MacroTestBase.java
##########
@@ -58,40 +63,36 @@ protected Expr apply(final List<Expr> args)
   /**
    * Evalutes {@code expr} using our macro.
    *
-   * @param expression expression to evalute
-   * @param bindings   bindings for evaluation
+   * @param expression
+   *          expression to evalute
+   * @param bindings
+   *          bindings for evaluation
    *
-   * @throws AssertionError if {@link ExprMacroTable.ExprMacro#apply} is not called on our macro during parsing
+   * @throws AssertionError
+   *           if {@link ExprMacroTable.ExprMacro#apply} is not called on our
+   *           macro during parsing
    */
   protected ExprEval<?> eval(
       final String expression,
-      final Expr.ObjectBinding bindings
-  )
+      final Expr.ObjectBinding bindings)
   {
-    // WrappedExprMacro allows us to confirm that our ExprMacro was actually called.
-    class WrappedExprMacro implements ExprMacroTable.ExprMacro
-    {
-      private final AtomicLong calls = new AtomicLong();
-
-      @Override
-      public String name()
-      {
-        return macro.name();
-      }
-
-      @Override
-      public Expr apply(List<Expr> args)
-      {
-        calls.incrementAndGet();
-        return macro.apply(args);
-      }
-    }
-
-    final WrappedExprMacro wrappedMacro = new WrappedExprMacro();
+    // Create variables for tracking behaviors of mock object
+    AtomicLong wrappedMacroCalls = new AtomicLong();
+    // Construct mock object
+    final ExprMacro wrappedMacro = mock(ExprMacroTable.ExprMacro.class);

Review comment:
       @kfaraz I agree on one method of qualifying the class. But since the `ExprMacro` is an interface without any default methods, do we want to spy on an interface? I think it's better to mock interfaces and spy real classes IMO.

##########
File path: processing/src/test/java/org/apache/druid/query/expression/MacroTestBase.java
##########
@@ -58,40 +63,36 @@ protected Expr apply(final List<Expr> args)
   /**
    * Evalutes {@code expr} using our macro.
    *
-   * @param expression expression to evalute
-   * @param bindings   bindings for evaluation
+   * @param expression
+   *          expression to evalute
+   * @param bindings
+   *          bindings for evaluation
    *
-   * @throws AssertionError if {@link ExprMacroTable.ExprMacro#apply} is not called on our macro during parsing
+   * @throws AssertionError
+   *           if {@link ExprMacroTable.ExprMacro#apply} is not called on our
+   *           macro during parsing
    */
   protected ExprEval<?> eval(
       final String expression,
-      final Expr.ObjectBinding bindings
-  )
+      final Expr.ObjectBinding bindings)
   {
-    // WrappedExprMacro allows us to confirm that our ExprMacro was actually called.
-    class WrappedExprMacro implements ExprMacroTable.ExprMacro
-    {
-      private final AtomicLong calls = new AtomicLong();
-
-      @Override
-      public String name()
-      {
-        return macro.name();
-      }
-
-      @Override
-      public Expr apply(List<Expr> args)
-      {
-        calls.incrementAndGet();
-        return macro.apply(args);
-      }
-    }
-
-    final WrappedExprMacro wrappedMacro = new WrappedExprMacro();
+    // Create variables for tracking behaviors of mock object
+    AtomicLong wrappedMacroCalls = new AtomicLong();
+    // Construct mock object
+    final ExprMacro wrappedMacro = mock(ExprMacroTable.ExprMacro.class);

Review comment:
       @kfaraz I agree on one method of qualifying the class. But since the `ExprMacro` is an interface without any default methods, do we want to create spy for this interface? I think it's better to mock interfaces and spy real classes IMO.




-- 
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.

To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org

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



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org


[GitHub] [druid] wx930910 commented on a change in pull request #11561: refactor MacroTestBase by using Mockito

Posted by GitBox <gi...@apache.org>.
wx930910 commented on a change in pull request #11561:
URL: https://github.com/apache/druid/pull/11561#discussion_r727756373



##########
File path: processing/src/test/java/org/apache/druid/query/expression/MacroTestBase.java
##########
@@ -58,40 +63,36 @@ protected Expr apply(final List<Expr> args)
   /**
    * Evalutes {@code expr} using our macro.
    *
-   * @param expression expression to evalute
-   * @param bindings   bindings for evaluation
+   * @param expression
+   *          expression to evalute
+   * @param bindings
+   *          bindings for evaluation
    *
-   * @throws AssertionError if {@link ExprMacroTable.ExprMacro#apply} is not called on our macro during parsing
+   * @throws AssertionError
+   *           if {@link ExprMacroTable.ExprMacro#apply} is not called on our
+   *           macro during parsing
    */
   protected ExprEval<?> eval(
       final String expression,
-      final Expr.ObjectBinding bindings
-  )
+      final Expr.ObjectBinding bindings)
   {
-    // WrappedExprMacro allows us to confirm that our ExprMacro was actually called.
-    class WrappedExprMacro implements ExprMacroTable.ExprMacro
-    {
-      private final AtomicLong calls = new AtomicLong();
-
-      @Override
-      public String name()
-      {
-        return macro.name();
-      }
-
-      @Override
-      public Expr apply(List<Expr> args)
-      {
-        calls.incrementAndGet();
-        return macro.apply(args);
-      }
-    }
-
-    final WrappedExprMacro wrappedMacro = new WrappedExprMacro();
+    // Create variables for tracking behaviors of mock object
+    AtomicLong wrappedMacroCalls = new AtomicLong();
+    // Construct mock object
+    final ExprMacro wrappedMacro = mock(ExprMacroTable.ExprMacro.class);
+    // Method Stubs
+    when(wrappedMacro.name()).thenAnswer((stubInvo) -> {
+      return macro.name();
+    });
+    when(wrappedMacro.apply(any(List.class))).thenAnswer((stubInvo) -> {
+      List<Expr> args = stubInvo.getArgument(0);
+      wrappedMacroCalls.incrementAndGet();

Review comment:
       @kfaraz Thanks for the suggestions! I agreed and will revise the code correspondingly.

##########
File path: processing/src/test/java/org/apache/druid/query/expression/MacroTestBase.java
##########
@@ -58,40 +63,36 @@ protected Expr apply(final List<Expr> args)
   /**
    * Evalutes {@code expr} using our macro.
    *
-   * @param expression expression to evalute
-   * @param bindings   bindings for evaluation
+   * @param expression
+   *          expression to evalute
+   * @param bindings
+   *          bindings for evaluation
    *
-   * @throws AssertionError if {@link ExprMacroTable.ExprMacro#apply} is not called on our macro during parsing
+   * @throws AssertionError
+   *           if {@link ExprMacroTable.ExprMacro#apply} is not called on our
+   *           macro during parsing
    */
   protected ExprEval<?> eval(
       final String expression,
-      final Expr.ObjectBinding bindings
-  )
+      final Expr.ObjectBinding bindings)
   {
-    // WrappedExprMacro allows us to confirm that our ExprMacro was actually called.
-    class WrappedExprMacro implements ExprMacroTable.ExprMacro
-    {
-      private final AtomicLong calls = new AtomicLong();
-
-      @Override
-      public String name()
-      {
-        return macro.name();
-      }
-
-      @Override
-      public Expr apply(List<Expr> args)
-      {
-        calls.incrementAndGet();
-        return macro.apply(args);
-      }
-    }
-
-    final WrappedExprMacro wrappedMacro = new WrappedExprMacro();
+    // Create variables for tracking behaviors of mock object
+    AtomicLong wrappedMacroCalls = new AtomicLong();
+    // Construct mock object
+    final ExprMacro wrappedMacro = mock(ExprMacroTable.ExprMacro.class);
+    // Method Stubs
+    when(wrappedMacro.name()).thenAnswer((stubInvo) -> {
+      return macro.name();
+    });
+    when(wrappedMacro.apply(any(List.class))).thenAnswer((stubInvo) -> {
+      List<Expr> args = stubInvo.getArgument(0);
+      wrappedMacroCalls.incrementAndGet();

Review comment:
       @kfaraz Thanks for the comments! I agreed and will revise the code correspondingly.




-- 
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.

To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org

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



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org


[GitHub] [druid] wx930910 commented on pull request #11561: refactor MacroTestBase by using Mockito

Posted by GitBox <gi...@apache.org>.
wx930910 commented on pull request #11561:
URL: https://github.com/apache/druid/pull/11561#issuecomment-942919799


   @kfaraz Thanks for the prompt response! Just fixed the style and pushed again.


-- 
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.

To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org

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



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org


[GitHub] [druid] kfaraz commented on a change in pull request #11561: refactor MacroTestBase by using Mockito

Posted by GitBox <gi...@apache.org>.
kfaraz commented on a change in pull request #11561:
URL: https://github.com/apache/druid/pull/11561#discussion_r725673559



##########
File path: processing/src/test/java/org/apache/druid/query/expression/MacroTestBase.java
##########
@@ -58,40 +63,36 @@ protected Expr apply(final List<Expr> args)
   /**
    * Evalutes {@code expr} using our macro.
    *
-   * @param expression expression to evalute
-   * @param bindings   bindings for evaluation
+   * @param expression
+   *          expression to evalute
+   * @param bindings
+   *          bindings for evaluation
    *
-   * @throws AssertionError if {@link ExprMacroTable.ExprMacro#apply} is not called on our macro during parsing
+   * @throws AssertionError
+   *           if {@link ExprMacroTable.ExprMacro#apply} is not called on our
+   *           macro during parsing
    */
   protected ExprEval<?> eval(
       final String expression,
-      final Expr.ObjectBinding bindings
-  )
+      final Expr.ObjectBinding bindings)
   {
-    // WrappedExprMacro allows us to confirm that our ExprMacro was actually called.
-    class WrappedExprMacro implements ExprMacroTable.ExprMacro
-    {
-      private final AtomicLong calls = new AtomicLong();
-
-      @Override
-      public String name()
-      {
-        return macro.name();
-      }
-
-      @Override
-      public Expr apply(List<Expr> args)
-      {
-        calls.incrementAndGet();
-        return macro.apply(args);
-      }
-    }
-
-    final WrappedExprMacro wrappedMacro = new WrappedExprMacro();
+    // Create variables for tracking behaviors of mock object
+    AtomicLong wrappedMacroCalls = new AtomicLong();
+    // Construct mock object
+    final ExprMacro wrappedMacro = mock(ExprMacroTable.ExprMacro.class);
+    // Method Stubs
+    when(wrappedMacro.name()).thenAnswer((stubInvo) -> {
+      return macro.name();
+    });
+    when(wrappedMacro.apply(any(List.class))).thenAnswer((stubInvo) -> {
+      List<Expr> args = stubInvo.getArgument(0);
+      wrappedMacroCalls.incrementAndGet();

Review comment:
       Instead of using the AtomicLong counter `wrappedMacroCalls`, try using `Mockito.verify()` with `Mockito.times()`.

##########
File path: processing/src/test/java/org/apache/druid/query/expression/MacroTestBase.java
##########
@@ -58,40 +63,36 @@ protected Expr apply(final List<Expr> args)
   /**
    * Evalutes {@code expr} using our macro.
    *
-   * @param expression expression to evalute
-   * @param bindings   bindings for evaluation
+   * @param expression
+   *          expression to evalute
+   * @param bindings
+   *          bindings for evaluation
    *
-   * @throws AssertionError if {@link ExprMacroTable.ExprMacro#apply} is not called on our macro during parsing
+   * @throws AssertionError
+   *           if {@link ExprMacroTable.ExprMacro#apply} is not called on our
+   *           macro during parsing
    */
   protected ExprEval<?> eval(
       final String expression,
-      final Expr.ObjectBinding bindings
-  )
+      final Expr.ObjectBinding bindings)
   {
-    // WrappedExprMacro allows us to confirm that our ExprMacro was actually called.
-    class WrappedExprMacro implements ExprMacroTable.ExprMacro
-    {
-      private final AtomicLong calls = new AtomicLong();
-
-      @Override
-      public String name()
-      {
-        return macro.name();
-      }
-
-      @Override
-      public Expr apply(List<Expr> args)
-      {
-        calls.incrementAndGet();
-        return macro.apply(args);
-      }
-    }
-
-    final WrappedExprMacro wrappedMacro = new WrappedExprMacro();
+    // Create variables for tracking behaviors of mock object
+    AtomicLong wrappedMacroCalls = new AtomicLong();
+    // Construct mock object
+    final ExprMacro wrappedMacro = mock(ExprMacroTable.ExprMacro.class);

Review comment:
       Please use one method of qualifying the class here, either `ExprMacroTable.ExprMacro` or just `ExprMacro` (unless they are referring to two different classes).

##########
File path: processing/src/test/java/org/apache/druid/query/expression/MacroTestBase.java
##########
@@ -58,40 +63,36 @@ protected Expr apply(final List<Expr> args)
   /**
    * Evalutes {@code expr} using our macro.
    *
-   * @param expression expression to evalute
-   * @param bindings   bindings for evaluation
+   * @param expression
+   *          expression to evalute
+   * @param bindings
+   *          bindings for evaluation
    *
-   * @throws AssertionError if {@link ExprMacroTable.ExprMacro#apply} is not called on our macro during parsing
+   * @throws AssertionError
+   *           if {@link ExprMacroTable.ExprMacro#apply} is not called on our
+   *           macro during parsing
    */
   protected ExprEval<?> eval(
       final String expression,
-      final Expr.ObjectBinding bindings
-  )
+      final Expr.ObjectBinding bindings)
   {
-    // WrappedExprMacro allows us to confirm that our ExprMacro was actually called.
-    class WrappedExprMacro implements ExprMacroTable.ExprMacro
-    {
-      private final AtomicLong calls = new AtomicLong();
-
-      @Override
-      public String name()
-      {
-        return macro.name();
-      }
-
-      @Override
-      public Expr apply(List<Expr> args)
-      {
-        calls.incrementAndGet();
-        return macro.apply(args);
-      }
-    }
-
-    final WrappedExprMacro wrappedMacro = new WrappedExprMacro();
+    // Create variables for tracking behaviors of mock object
+    AtomicLong wrappedMacroCalls = new AtomicLong();
+    // Construct mock object
+    final ExprMacro wrappedMacro = mock(ExprMacroTable.ExprMacro.class);

Review comment:
       Also, instead of wrapping the macro, I would advise just using `Mockito.spy()` as you are essentially trying to do the same thing.

##########
File path: processing/src/test/java/org/apache/druid/query/expression/MacroTestBase.java
##########
@@ -58,40 +63,36 @@ protected Expr apply(final List<Expr> args)
   /**
    * Evalutes {@code expr} using our macro.
    *
-   * @param expression expression to evalute
-   * @param bindings   bindings for evaluation
+   * @param expression
+   *          expression to evalute
+   * @param bindings
+   *          bindings for evaluation
    *
-   * @throws AssertionError if {@link ExprMacroTable.ExprMacro#apply} is not called on our macro during parsing
+   * @throws AssertionError
+   *           if {@link ExprMacroTable.ExprMacro#apply} is not called on our
+   *           macro during parsing
    */
   protected ExprEval<?> eval(
       final String expression,
-      final Expr.ObjectBinding bindings
-  )
+      final Expr.ObjectBinding bindings)

Review comment:
       Please remove these code/doc style changes unless you are adding/removing content. This style does not align with the current style in the rest of the code either.




-- 
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.

To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org

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



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org


[GitHub] [druid] kfaraz commented on pull request #11561: refactor MacroTestBase by using Mockito

Posted by GitBox <gi...@apache.org>.
kfaraz commented on pull request #11561:
URL: https://github.com/apache/druid/pull/11561#issuecomment-942167505


   Thanks for the quick changes @wx930910 , all LGTM.
   
   CI seems to be failing due to checkstyle (unused import/wrong import order), please fix that.


-- 
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.

To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org

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



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org


[GitHub] [druid] wx930910 commented on a change in pull request #11561: refactor MacroTestBase by using Mockito

Posted by GitBox <gi...@apache.org>.
wx930910 commented on a change in pull request #11561:
URL: https://github.com/apache/druid/pull/11561#discussion_r727794326



##########
File path: processing/src/test/java/org/apache/druid/query/expression/MacroTestBase.java
##########
@@ -58,40 +63,36 @@ protected Expr apply(final List<Expr> args)
   /**
    * Evalutes {@code expr} using our macro.
    *
-   * @param expression expression to evalute
-   * @param bindings   bindings for evaluation
+   * @param expression
+   *          expression to evalute
+   * @param bindings
+   *          bindings for evaluation
    *
-   * @throws AssertionError if {@link ExprMacroTable.ExprMacro#apply} is not called on our macro during parsing
+   * @throws AssertionError
+   *           if {@link ExprMacroTable.ExprMacro#apply} is not called on our
+   *           macro during parsing
    */
   protected ExprEval<?> eval(
       final String expression,
-      final Expr.ObjectBinding bindings
-  )
+      final Expr.ObjectBinding bindings)
   {
-    // WrappedExprMacro allows us to confirm that our ExprMacro was actually called.
-    class WrappedExprMacro implements ExprMacroTable.ExprMacro
-    {
-      private final AtomicLong calls = new AtomicLong();
-
-      @Override
-      public String name()
-      {
-        return macro.name();
-      }
-
-      @Override
-      public Expr apply(List<Expr> args)
-      {
-        calls.incrementAndGet();
-        return macro.apply(args);
-      }
-    }
-
-    final WrappedExprMacro wrappedMacro = new WrappedExprMacro();
+    // Create variables for tracking behaviors of mock object
+    AtomicLong wrappedMacroCalls = new AtomicLong();
+    // Construct mock object
+    final ExprMacro wrappedMacro = mock(ExprMacroTable.ExprMacro.class);

Review comment:
       @kfaraz I agree on one method of qualifying the class. But since the `ExprMacro` is an interface without any default methods, do we want to create spy for this interface? I think it's better to mock interfaces and spy real classes IMO.




-- 
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.

To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org

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



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org


[GitHub] [druid] wx930910 commented on a change in pull request #11561: refactor MacroTestBase by using Mockito

Posted by GitBox <gi...@apache.org>.
wx930910 commented on a change in pull request #11561:
URL: https://github.com/apache/druid/pull/11561#discussion_r727794326



##########
File path: processing/src/test/java/org/apache/druid/query/expression/MacroTestBase.java
##########
@@ -58,40 +63,36 @@ protected Expr apply(final List<Expr> args)
   /**
    * Evalutes {@code expr} using our macro.
    *
-   * @param expression expression to evalute
-   * @param bindings   bindings for evaluation
+   * @param expression
+   *          expression to evalute
+   * @param bindings
+   *          bindings for evaluation
    *
-   * @throws AssertionError if {@link ExprMacroTable.ExprMacro#apply} is not called on our macro during parsing
+   * @throws AssertionError
+   *           if {@link ExprMacroTable.ExprMacro#apply} is not called on our
+   *           macro during parsing
    */
   protected ExprEval<?> eval(
       final String expression,
-      final Expr.ObjectBinding bindings
-  )
+      final Expr.ObjectBinding bindings)
   {
-    // WrappedExprMacro allows us to confirm that our ExprMacro was actually called.
-    class WrappedExprMacro implements ExprMacroTable.ExprMacro
-    {
-      private final AtomicLong calls = new AtomicLong();
-
-      @Override
-      public String name()
-      {
-        return macro.name();
-      }
-
-      @Override
-      public Expr apply(List<Expr> args)
-      {
-        calls.incrementAndGet();
-        return macro.apply(args);
-      }
-    }
-
-    final WrappedExprMacro wrappedMacro = new WrappedExprMacro();
+    // Create variables for tracking behaviors of mock object
+    AtomicLong wrappedMacroCalls = new AtomicLong();
+    // Construct mock object
+    final ExprMacro wrappedMacro = mock(ExprMacroTable.ExprMacro.class);

Review comment:
       @kfaraz I agree on one method of qualifying the class. But since the `ExprMacro` is an interface without any default methods, do we want to spy on an interface? I think it's better to mock interfaces and spy real classes IMO.




-- 
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.

To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org

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



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org