Gh-2560 get traits operation configurable (#2579)

* Update docs links in README * Revert "Update docs links in README" This reverts commit 2d87bf3. * gh-2559 added hasTrait, its handler and corresponding tests (#2561) * gh-2559 added hasTrait, its handler and corresponding tests * gh-2559 amended comment in HasTrait, added additional tests for the handler * gh-2559 null check & tidy test Co-authored-by: t92549 <80890692+t92549@users.noreply.github.com> * Update links to Gaffer docs in all files (#2566) Co-authored-by: t92549 <80890692+t92549@users.noreply.github.com> * gh-2560 GetTraitsHandler is initalised with traits dependednt on store type * gh-2560 reviewed comments * gh-2560 unused imports * gh-2560 review comments * checkstyle * gh-2560 fixed federated test * gh-2560 fixed GraphTest * gh-2560 fixed TestStore * gh-2560-getTraitsOperation (#2582) Removing redundant adding of GetTraitHandler from addAdditionalOperationHandlers() because it has its own method getGetTraitsHandler(). * gh-2560: Added fix to SingleUseMapStoreWithoutVisibilitySupport * gh-2560: Fixed Set copy issue in GetTraitsHandler constructor * gh-2560: Added extra protections to GetTraitsHandler Co-authored-by: GCHQDeveloper314 <94527357+GCHQDeveloper314@users.noreply.github.com> Co-authored-by: t92549 <80890692+t92549@users.noreply.github.com> Co-authored-by: GCHQDev404 <45399082+GCHQDev404@users.noreply.github.com>
gchq · Feb 4, 2022 · 28e9411 · 28e9411
1 parent f83376d
commit 28e9411
Show file tree

Hide file tree

Showing 15 changed files with 115 additions and 5 deletions.
diff --git a/core/graph/src/test/java/uk/gov/gchq/gaffer/graph/GraphTest.java b/core/graph/src/test/java/uk/gov/gchq/gaffer/graph/GraphTest.java
@@ -75,6 +75,8 @@
 import uk.gov.gchq.gaffer.store.TestTypes;
 import uk.gov.gchq.gaffer.store.library.GraphLibrary;
 import uk.gov.gchq.gaffer.store.library.HashMapGraphLibrary;
+import uk.gov.gchq.gaffer.store.operation.GetTraits;
+import uk.gov.gchq.gaffer.store.operation.handler.GetTraitsHandler;
 import uk.gov.gchq.gaffer.store.operation.handler.OperationHandler;
 import uk.gov.gchq.gaffer.store.operation.handler.OutputOperationHandler;
 import uk.gov.gchq.gaffer.store.schema.Schema;
@@ -2725,6 +2727,11 @@ protected OperationHandler<? extends AddElements> getAddElementsHandler() {
             return null;
         }
 
+        @Override
+        protected OutputOperationHandler<GetTraits, Set<StoreTrait>> getGetTraitsHandler() {
+            return new GetTraitsHandler(new HashSet<>(0));
+        }
+
         @Override
         protected Class<? extends Serialiser> getRequiredParentSerialiserClass() {
             return ToBytesSerialiser.class;

diff --git a/core/graph/src/test/java/uk/gov/gchq/gaffer/integration/store/TestStore.java b/core/graph/src/test/java/uk/gov/gchq/gaffer/integration/store/TestStore.java
@@ -31,6 +31,8 @@
 import uk.gov.gchq.gaffer.store.Context;
 import uk.gov.gchq.gaffer.store.Store;
 import uk.gov.gchq.gaffer.store.StoreTrait;
+import uk.gov.gchq.gaffer.store.operation.GetTraits;
+import uk.gov.gchq.gaffer.store.operation.handler.GetTraitsHandler;
 import uk.gov.gchq.gaffer.store.operation.handler.OperationHandler;
 import uk.gov.gchq.gaffer.store.operation.handler.OutputOperationHandler;
 
@@ -85,6 +87,12 @@ protected OperationHandler<? extends AddElements> getAddElementsHandler() {
         return null;
     }
 
+    @Override
+    protected OutputOperationHandler<GetTraits, Set<StoreTrait>> getGetTraitsHandler() {
+        // mockStore.getGetTraitsHandler() would be better but protected
+        return new GetTraitsHandler(mockStore.getTraits());
+    }
+
     @Override
     public boolean isSupported(final Class<? extends Operation> operationClass) {
         return mockStore.isSupported(operationClass);

diff --git a/core/store/src/main/java/uk/gov/gchq/gaffer/store/Store.java b/core/store/src/main/java/uk/gov/gchq/gaffer/store/Store.java
@@ -112,7 +112,6 @@
 import uk.gov.gchq.gaffer.store.operation.handler.DiscardOutputHandler;
 import uk.gov.gchq.gaffer.store.operation.handler.ForEachHandler;
 import uk.gov.gchq.gaffer.store.operation.handler.GetSchemaHandler;
-import uk.gov.gchq.gaffer.store.operation.handler.GetTraitsHandler;
 import uk.gov.gchq.gaffer.store.operation.handler.GetVariableHandler;
 import uk.gov.gchq.gaffer.store.operation.handler.GetVariablesHandler;
 import uk.gov.gchq.gaffer.store.operation.handler.GetWalksHandler;
@@ -866,6 +865,16 @@ public List<OperationChainOptimiser> getOperationChainOptimisers() {
      */
     protected abstract OperationHandler<? extends AddElements> getAddElementsHandler();
 
+    /**
+     * Get this Stores implementation of the handler for {@link
+     * uk.gov.gchq.gaffer.store.operation.GetTraits}.
+     * All Stores must implement this.
+     *
+     * @return the implementation of the handler for {@link
+     * uk.gov.gchq.gaffer.store.operation.GetTraits}
+     */
+    protected abstract OutputOperationHandler<GetTraits, Set<StoreTrait>>  getGetTraitsHandler();
+
     /**
      * Get this Store's implementation of the handler for {@link
      * uk.gov.gchq.gaffer.operation.OperationChain}.
@@ -1073,7 +1082,7 @@ private void addCoreOpHandlers() {
 
         // Traits
         addOperationHandler(HasTrait.class, new HasTraitHandler());
-        addOperationHandler(GetTraits.class, new GetTraitsHandler());
+        addOperationHandler(GetTraits.class, getGetTraitsHandler());
     }
 
     private void addConfiguredOperationHandlers() {

diff --git a/core/store/src/main/java/uk/gov/gchq/gaffer/store/operation/handler/GetTraitsHandler.java b/core/store/src/main/java/uk/gov/gchq/gaffer/store/operation/handler/GetTraitsHandler.java
@@ -34,12 +34,17 @@
 import static org.apache.commons.collections.CollectionUtils.isNotEmpty;
 
 public class GetTraitsHandler implements OutputOperationHandler<GetTraits, Set<StoreTrait>> {
+    private final Set<StoreTrait> storeTraits;
     private Set<StoreTrait> currentTraits;
 
+    public GetTraitsHandler(final Set<StoreTrait> storeTraits) {
+        this.storeTraits = Collections.unmodifiableSet(Sets.newHashSet(storeTraits));
+    }
+
     @Override
     public Set<StoreTrait> doOperation(final GetTraits operation, final Context context, final Store store) throws OperationException {
         if (!operation.isCurrentTraits()) {
-            return store.getTraits();
+            return storeTraits;
         }
 
         if (null == currentTraits) {
@@ -49,7 +54,7 @@ public Set<StoreTrait> doOperation(final GetTraits operation, final Context cont
     }
 
     private Set<StoreTrait> createCurrentTraits(final Store store) {
-        final Set<StoreTrait> traits = Sets.newHashSet(store.getTraits());
+        final Set<StoreTrait> traits = Sets.newHashSet(storeTraits);
         final Schema schema = store.getSchema();
 
         final boolean hasAggregatedGroups = isNotEmpty(schema.getAggregatedGroups());

diff --git a/core/store/src/test/java/uk/gov/gchq/gaffer/store/StoreTest.java b/core/store/src/test/java/uk/gov/gchq/gaffer/store/StoreTest.java
@@ -116,6 +116,7 @@
 import uk.gov.gchq.gaffer.store.operation.declaration.OperationDeclaration;
 import uk.gov.gchq.gaffer.store.operation.declaration.OperationDeclarations;
 import uk.gov.gchq.gaffer.store.operation.handler.CountGroupsHandler;
+import uk.gov.gchq.gaffer.store.operation.handler.GetTraitsHandler;
 import uk.gov.gchq.gaffer.store.operation.handler.OperationHandler;
 import uk.gov.gchq.gaffer.store.operation.handler.OutputOperationHandler;
 import uk.gov.gchq.gaffer.store.operation.handler.export.set.ExportToSetHandler;
@@ -1152,6 +1153,11 @@ protected OperationHandler<AddElements> getAddElementsHandler() {
             return addElementsHandler;
         }
 
+        @Override
+        protected OutputOperationHandler<GetTraits, Set<StoreTrait>> getGetTraitsHandler() {
+            return new GetTraitsHandler(traits);
+        }
+
         @Override
         protected Object doUnhandledOperation(final Operation operation, final Context context) {
             doUnhandledOperationCalls.add(operation);
@@ -1247,6 +1253,11 @@ protected OperationHandler<AddElements> getAddElementsHandler() {
             return addElementsHandler;
         }
 
+        @Override
+        protected OutputOperationHandler<GetTraits, Set<StoreTrait>> getGetTraitsHandler() {
+            return new GetTraitsHandler(traits);
+        }
+
         @Override
         protected Object doUnhandledOperation(final Operation operation, final Context context) {
             doUnhandledOperationCalls.add(operation);

diff --git a/core/store/src/test/java/uk/gov/gchq/gaffer/store/integration/StoreIT.java b/core/store/src/test/java/uk/gov/gchq/gaffer/store/integration/StoreIT.java
@@ -34,6 +34,8 @@
 import uk.gov.gchq.gaffer.store.StoreException;
 import uk.gov.gchq.gaffer.store.StoreProperties;
 import uk.gov.gchq.gaffer.store.StoreTrait;
+import uk.gov.gchq.gaffer.store.operation.GetTraits;
+import uk.gov.gchq.gaffer.store.operation.handler.GetTraitsHandler;
 import uk.gov.gchq.gaffer.store.operation.handler.OperationHandler;
 import uk.gov.gchq.gaffer.store.operation.handler.OutputOperationHandler;
 import uk.gov.gchq.gaffer.store.schema.Schema;
@@ -107,6 +109,11 @@ protected OperationHandler<? extends AddElements> getAddElementsHandler() {
             return null;
         }
 
+        @Override
+        protected OutputOperationHandler<GetTraits, Set<StoreTrait>> getGetTraitsHandler() {
+            return new GetTraitsHandler(traits);
+        }
+
         @Override
         protected Class<? extends Serialiser> getRequiredParentSerialiserClass() {
             return ToBytesSerialiser.class;

diff --git a/.../store/src/test/java/uk/gov/gchq/gaffer/store/operation/handler/GetTraitsHandlerTest.java b/.../store/src/test/java/uk/gov/gchq/gaffer/store/operation/handler/GetTraitsHandlerTest.java
@@ -59,6 +59,10 @@ public void setUp() throws Exception {
             public Set<StoreTrait> getTraits() {
                 return Sets.newHashSet(expectedTraits);
             }
+            @Override
+            protected OutputOperationHandler<GetTraits, Set<StoreTrait>> getGetTraitsHandler() {
+                return new GetTraitsHandler(expectedTraits);
+            }
         };
         assertNotEquals(StoreTrait.ALL_TRAITS, expectedTraits);
         string = new Schema.Builder().type(STRING, String.class).build();

diff --git a/core/store/src/test/java/uk/gov/gchq/gaffer/store/operation/handler/HasTraitHandlerTest.java b/core/store/src/test/java/uk/gov/gchq/gaffer/store/operation/handler/HasTraitHandlerTest.java
@@ -28,6 +28,7 @@
 import uk.gov.gchq.gaffer.store.StoreException;
 import uk.gov.gchq.gaffer.store.StoreProperties;
 import uk.gov.gchq.gaffer.store.StoreTrait;
+import uk.gov.gchq.gaffer.store.operation.GetTraits;
 import uk.gov.gchq.gaffer.store.operation.HasTrait;
 import uk.gov.gchq.gaffer.store.schema.Schema;
 import uk.gov.gchq.gaffer.store.schema.SchemaEntityDefinition;
@@ -63,6 +64,10 @@ public void setUp() throws Exception {
             public Set<StoreTrait> getTraits() {
                 return Sets.newHashSet(expectedTraits);
             }
+            @Override
+            protected OutputOperationHandler<GetTraits, Set<StoreTrait>> getGetTraitsHandler() {
+                return new GetTraitsHandler(expectedTraits);
+            }
         };
         assertNotEquals(StoreTrait.ALL_TRAITS, expectedTraits);
         string = new Schema.Builder().type(STRING, String.class).build();

diff --git a/...e/src/test/java/uk/gov/gchq/gaffer/store/operation/handler/TestAddToGraphLibraryImpl.java b/...e/src/test/java/uk/gov/gchq/gaffer/store/operation/handler/TestAddToGraphLibraryImpl.java
@@ -27,6 +27,7 @@
 import uk.gov.gchq.gaffer.serialisation.ToBytesSerialiser;
 import uk.gov.gchq.gaffer.store.Store;
 import uk.gov.gchq.gaffer.store.StoreTrait;
+import uk.gov.gchq.gaffer.store.operation.GetTraits;
 
 import java.util.HashSet;
 import java.util.Set;
@@ -61,6 +62,11 @@ protected OperationHandler<? extends AddElements> getAddElementsHandler() {
         return null;
     }
 
+    @Override
+    protected OutputOperationHandler<GetTraits, Set<StoreTrait>> getGetTraitsHandler() {
+        return new GetTraitsHandler(new HashSet<>(0));
+    }
+
     @Override
     protected Class<? extends Serialiser> getRequiredParentSerialiserClass() {
         return ToBytesSerialiser.class;

diff --git a/...entation/accumulo-store/src/main/java/uk/gov/gchq/gaffer/accumulostore/AccumuloStore.java b/...entation/accumulo-store/src/main/java/uk/gov/gchq/gaffer/accumulostore/AccumuloStore.java
@@ -91,6 +91,8 @@
 import uk.gov.gchq.gaffer.store.StoreException;
 import uk.gov.gchq.gaffer.store.StoreProperties;
 import uk.gov.gchq.gaffer.store.StoreTrait;
+import uk.gov.gchq.gaffer.store.operation.GetTraits;
+import uk.gov.gchq.gaffer.store.operation.handler.GetTraitsHandler;
 import uk.gov.gchq.gaffer.store.operation.handler.OperationHandler;
 import uk.gov.gchq.gaffer.store.operation.handler.OutputOperationHandler;
 import uk.gov.gchq.gaffer.store.schema.Schema;
@@ -395,6 +397,11 @@ protected OperationHandler<? extends AddElements> getAddElementsHandler() {
         return new AddElementsHandler();
     }
 
+    @Override
+    protected OutputOperationHandler<GetTraits, Set<StoreTrait>> getGetTraitsHandler() {
+        return new GetTraitsHandler(TRAITS);
+    }
+
     @Override
     public Set<StoreTrait> getTraits() {
         return TRAITS;

diff --git a/...ation/federated-store/src/main/java/uk/gov/gchq/gaffer/federatedstore/FederatedStore.java b/...ation/federated-store/src/main/java/uk/gov/gchq/gaffer/federatedstore/FederatedStore.java
@@ -411,7 +411,6 @@ protected void addAdditionalOperationHandlers() {
         addOperationHandler(RemoveGraph.class, new FederatedRemoveGraphHandler());
 
         addOperationHandler(FederatedOperationChain.class, new FederatedOperationChainHandler());
-        addOperationHandler(GetTraits.class, new FederatedGetTraitsHandler());
         addOperationHandler(GetAllGraphInfo.class, new FederatedGetAllGraphInfoHandler());
         addOperationHandler(ChangeGraphAccess.class, new FederatedChangeGraphAccessHandler());
         addOperationHandler(ChangeGraphId.class, new FederatedChangeGraphIdHandler());
@@ -442,6 +441,11 @@ protected OperationHandler<? extends AddElements> getAddElementsHandler() {
         return (OperationHandler) new FederatedOperationHandler();
     }
 
+    @Override
+    protected OutputOperationHandler<GetTraits, Set<StoreTrait>> getGetTraitsHandler() {
+        return new FederatedGetTraitsHandler();
+    }
+
     @Override
     protected Class<? extends Serialiser> getRequiredParentSerialiserClass() {
         return Serialiser.class;

diff --git a/.../gov/gchq/gaffer/federatedstore/operation/handler/impl/FederatedGetTraitsHandlerTest.java b/.../gov/gchq/gaffer/federatedstore/operation/handler/impl/FederatedGetTraitsHandlerTest.java
@@ -42,6 +42,7 @@
 import uk.gov.gchq.gaffer.store.StoreTrait;
 import uk.gov.gchq.gaffer.store.library.HashMapGraphLibrary;
 import uk.gov.gchq.gaffer.store.operation.GetTraits;
+import uk.gov.gchq.gaffer.store.operation.handler.GetTraitsHandler;
 import uk.gov.gchq.gaffer.store.operation.handler.OperationHandler;
 import uk.gov.gchq.gaffer.store.operation.handler.OutputOperationHandler;
 import uk.gov.gchq.gaffer.store.schema.Schema;
@@ -287,6 +288,11 @@ protected OperationHandler<? extends AddElements> getAddElementsHandler() {
             return null;
         }
 
+        @Override
+        protected OutputOperationHandler<GetTraits, Set<StoreTrait>> getGetTraitsHandler() {
+            return new GetTraitsHandler(STORE_TRAITS);
+        }
+
         @Override
         protected Class<? extends Serialiser> getRequiredParentSerialiserClass() {
             return null;
@@ -301,6 +307,11 @@ public static class TestStoreAltImpl extends TestStoreImpl {
         public Set<StoreTrait> getTraits() {
             return STORE_TRAITS;
         }
+
+        @Override
+        protected OutputOperationHandler<GetTraits, Set<StoreTrait>> getGetTraitsHandler() {
+            return new GetTraitsHandler(STORE_TRAITS);
+        }
     }
 
 }
diff --git a/store-implementation/map-store/src/main/java/uk/gov/gchq/gaffer/mapstore/MapStore.java b/store-implementation/map-store/src/main/java/uk/gov/gchq/gaffer/mapstore/MapStore.java
@@ -40,6 +40,8 @@
 import uk.gov.gchq.gaffer.store.StoreException;
 import uk.gov.gchq.gaffer.store.StoreProperties;
 import uk.gov.gchq.gaffer.store.StoreTrait;
+import uk.gov.gchq.gaffer.store.operation.GetTraits;
+import uk.gov.gchq.gaffer.store.operation.handler.GetTraitsHandler;
 import uk.gov.gchq.gaffer.store.operation.handler.OperationHandler;
 import uk.gov.gchq.gaffer.store.operation.handler.OutputOperationHandler;
 import uk.gov.gchq.gaffer.store.operation.handler.job.GetAllJobDetailsHandler;
@@ -152,6 +154,11 @@ protected OperationHandler<? extends AddElements> getAddElementsHandler() {
         return new AddElementsHandler();
     }
 
+    @Override
+    protected OutputOperationHandler<GetTraits, Set<StoreTrait>> getGetTraitsHandler() {
+        return new GetTraitsHandler(TRAITS);
+    }
+
     @Override
     protected Class<? extends Serialiser> getRequiredParentSerialiserClass() {
         return Serialiser.class;

diff --git a/.../src/main/java/uk/gov/gchq/gaffer/mapstore/SingleUseMapStoreWithoutVisibilitySupport.java b/.../src/main/java/uk/gov/gchq/gaffer/mapstore/SingleUseMapStoreWithoutVisibilitySupport.java
@@ -16,6 +16,9 @@
 package uk.gov.gchq.gaffer.mapstore;
 
 import uk.gov.gchq.gaffer.store.StoreTrait;
+import uk.gov.gchq.gaffer.store.operation.GetTraits;
+import uk.gov.gchq.gaffer.store.operation.handler.GetTraitsHandler;
+import uk.gov.gchq.gaffer.store.operation.handler.OutputOperationHandler;
 
 import java.util.HashSet;
 import java.util.Set;
@@ -32,4 +35,9 @@ public class SingleUseMapStoreWithoutVisibilitySupport extends SingleUseMapStore
     public Set<StoreTrait> getTraits() {
         return TRAITS;
     }
+
+    @Override
+    protected OutputOperationHandler<GetTraits, Set<StoreTrait>> getGetTraitsHandler() {
+        return new GetTraitsHandler(TRAITS);
+    }
 }
diff --git a/store-implementation/proxy-store/src/main/java/uk/gov/gchq/gaffer/proxystore/ProxyStore.java b/store-implementation/proxy-store/src/main/java/uk/gov/gchq/gaffer/proxystore/ProxyStore.java
@@ -55,6 +55,8 @@
 import uk.gov.gchq.gaffer.store.StoreProperties;
 import uk.gov.gchq.gaffer.store.StoreTrait;
 import uk.gov.gchq.gaffer.store.TypeReferenceStoreImpl;
+import uk.gov.gchq.gaffer.store.operation.GetTraits;
+import uk.gov.gchq.gaffer.store.operation.handler.GetTraitsHandler;
 import uk.gov.gchq.gaffer.store.operation.handler.OperationHandler;
 import uk.gov.gchq.gaffer.store.operation.handler.OutputOperationHandler;
 import uk.gov.gchq.gaffer.store.schema.Schema;
@@ -323,6 +325,15 @@ protected OperationHandler<? extends AddElements> getAddElementsHandler() {
         return null;
     }
 
+    @Override
+    protected OutputOperationHandler<GetTraits, Set<StoreTrait>> getGetTraitsHandler() {
+        try {
+            return new GetTraitsHandler(fetchTraits());
+        } catch (final StoreException e) {
+            throw new GafferRuntimeException(e.getMessage(), e);
+        }
+    }
+
     @Override
     protected OperationHandler<? extends OperationChain<?>> getOperationChainHandler() {
         return new uk.gov.gchq.gaffer.proxystore.operation.handler.OperationChainHandler<>(opChainValidator, opChainOptimisers);