james-server-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From btell...@apache.org
Subject [4/7] james-project git commit: JAMES-2599 Propose MetricableBlobStoreContract
Date Thu, 22 Nov 2018 10:51:37 GMT
JAMES-2599 Propose MetricableBlobStoreContract


Project: http://git-wip-us.apache.org/repos/asf/james-project/repo
Commit: http://git-wip-us.apache.org/repos/asf/james-project/commit/d81ab10c
Tree: http://git-wip-us.apache.org/repos/asf/james-project/tree/d81ab10c
Diff: http://git-wip-us.apache.org/repos/asf/james-project/diff/d81ab10c

Branch: refs/heads/master
Commit: d81ab10cd034eeee9ae9b88731763cac407d3a7e
Parents: bcfb5b8
Author: tran tien duc <dtran@linagora.com>
Authored: Thu Nov 22 09:57:42 2018 +0700
Committer: Benoit Tellier <btellier@linagora.com>
Committed: Thu Nov 22 17:50:42 2018 +0700

----------------------------------------------------------------------
 server/blob/blob-api/pom.xml                    |   9 ++
 .../blob/api/MetricableBlobStoreContract.java   | 110 +++++++++++++++++++
 2 files changed, 119 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/james-project/blob/d81ab10c/server/blob/blob-api/pom.xml
----------------------------------------------------------------------
diff --git a/server/blob/blob-api/pom.xml b/server/blob/blob-api/pom.xml
index 5c68370..07e6517 100644
--- a/server/blob/blob-api/pom.xml
+++ b/server/blob/blob-api/pom.xml
@@ -38,6 +38,10 @@
             <artifactId>james-server-util</artifactId>
         </dependency>
         <dependency>
+            <groupId>${james.groupId}</groupId>
+            <artifactId>metrics-api</artifactId>
+        </dependency>
+        <dependency>
             <groupId>commons-io</groupId>
             <artifactId>commons-io</artifactId>
             <scope>test</scope>
@@ -70,6 +74,11 @@
             <artifactId>junit-platform-launcher</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-core</artifactId>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
     
 </project>

http://git-wip-us.apache.org/repos/asf/james-project/blob/d81ab10c/server/blob/blob-api/src/test/java/org/apache/james/blob/api/MetricableBlobStoreContract.java
----------------------------------------------------------------------
diff --git a/server/blob/blob-api/src/test/java/org/apache/james/blob/api/MetricableBlobStoreContract.java
b/server/blob/blob-api/src/test/java/org/apache/james/blob/api/MetricableBlobStoreContract.java
new file mode 100644
index 0000000..f645589
--- /dev/null
+++ b/server/blob/blob-api/src/test/java/org/apache/james/blob/api/MetricableBlobStoreContract.java
@@ -0,0 +1,110 @@
+/****************************************************************
+ * 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.james.blob.api;
+
+import static org.apache.james.blob.api.MetricableBlobStore.READ_BYTES_TIMER_NAME;
+import static org.apache.james.blob.api.MetricableBlobStore.READ_TIMER_NAME;
+import static org.apache.james.blob.api.MetricableBlobStore.SAVE_BYTES_TIMER_NAME;
+import static org.apache.james.blob.api.MetricableBlobStore.SAVE_INPUT_STREAM_TIMER_NAME;
+import static org.mockito.Mockito.spy;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+
+import java.io.ByteArrayInputStream;
+import java.nio.charset.StandardCharsets;
+
+import org.apache.james.metrics.api.MetricFactory;
+import org.apache.james.metrics.api.TimeMetric;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.BeforeEachCallback;
+import org.junit.jupiter.api.extension.ExtensionContext;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+public interface MetricableBlobStoreContract extends BlobStoreContract {
+
+    class MetricableBlobStoreExtension implements BeforeEachCallback {
+        private MetricFactory metricFactory;
+        private TimeMetric saveBytesTimeMetric;
+        private TimeMetric saveInputStreamTimeMetric;
+        private TimeMetric readBytesTimeMetric;
+        private TimeMetric readTimeMetric;
+
+        @Override
+        public void beforeEach(ExtensionContext extensionContext) {
+            this.metricFactory = spy(MetricFactory.class);
+            this.saveBytesTimeMetric = spy(TimeMetric.class);
+            this.saveInputStreamTimeMetric = spy(TimeMetric.class);
+            this.readBytesTimeMetric = spy(TimeMetric.class);
+            this.readTimeMetric = spy(TimeMetric.class);
+            setupExpectations();
+        }
+
+        public MetricFactory getMetricFactory() {
+            return metricFactory;
+        }
+
+        private void setupExpectations() {
+            when(metricFactory.timer(SAVE_BYTES_TIMER_NAME))
+                .thenReturn(saveBytesTimeMetric);
+            when(metricFactory.timer(SAVE_INPUT_STREAM_TIMER_NAME))
+                .thenReturn(saveInputStreamTimeMetric);
+            when(metricFactory.timer(READ_BYTES_TIMER_NAME))
+                .thenReturn(readBytesTimeMetric);
+            when(metricFactory.timer(READ_TIMER_NAME))
+                .thenReturn(readTimeMetric);
+        }
+    }
+
+    @RegisterExtension
+    MetricableBlobStoreExtension metricsTestExtension = new MetricableBlobStoreExtension();
+    byte[] BYTES_CONTENT = "bytes content".getBytes(StandardCharsets.UTF_8);
+
+    @Test
+    default void saveBytesShouldPublishSaveBytesTimerMetrics() {
+        testee().save(BYTES_CONTENT).join();
+        testee().save(BYTES_CONTENT).join();
+        verify(metricsTestExtension.saveBytesTimeMetric, times(2)).stopAndPublish();
+    }
+
+    @Test
+    default void saveInputStreamShouldPublishSaveInputStreamTimerMetrics() {
+        testee().save(new ByteArrayInputStream(BYTES_CONTENT)).join();
+        testee().save(new ByteArrayInputStream(BYTES_CONTENT)).join();
+        testee().save(new ByteArrayInputStream(BYTES_CONTENT)).join();
+        verify(metricsTestExtension.saveInputStreamTimeMetric, times(3)).stopAndPublish();
+    }
+
+    @Test
+    default void readBytesShouldPublishReadBytesTimerMetrics() {
+        BlobId blobId = testee().save(BYTES_CONTENT).join();
+        testee().readBytes(blobId).join();
+        testee().readBytes(blobId).join();
+        verify(metricsTestExtension.readBytesTimeMetric, times(2)).stopAndPublish();
+    }
+
+    @Test
+    default void readShouldPublishReadTimerMetrics() {
+        BlobId blobId = testee().save(BYTES_CONTENT).join();
+        testee().read(blobId);
+        testee().read(blobId);
+        verify(metricsTestExtension.readTimeMetric, times(2)).stopAndPublish();
+    }
+}
\ No newline at end of file


---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org


Mime
View raw message