git.basschouten.com Git - openhab-addons.git/blob

   1 /**
   2  * Copyright (c) 2010-2021 Contributors to the openHAB project
   3  *
   4  * See the NOTICE file(s) distributed with this work for additional
   5  * information.
   6  *
   7  * This program and the accompanying materials are made available under the
   8  * terms of the Eclipse Public License 2.0 which is available at
   9  * http://www.eclipse.org/legal/epl-2.0
  10  *
  11  * SPDX-License-Identifier: EPL-2.0
  12  */
  13 package org.openhab.persistence.influxdb.internal;
  14
  15 import static org.hamcrest.CoreMatchers.equalTo;
  16 import static org.hamcrest.MatcherAssert.assertThat;
  17 import static org.mockito.Mockito.when;
  18
  19 import java.time.ZoneId;
  20 import java.time.ZonedDateTime;
  21 import java.time.format.DateTimeFormatter;
  22 import java.time.temporal.ChronoUnit;
  23 import java.util.Map;
  24
  25 import org.eclipse.jdt.annotation.DefaultLocation;
  26 import org.eclipse.jdt.annotation.NonNullByDefault;
  27 import org.junit.jupiter.api.AfterEach;
  28 import org.junit.jupiter.api.BeforeEach;
  29 import org.junit.jupiter.api.Test;
  30 import org.junit.jupiter.api.extension.ExtendWith;
  31 import org.mockito.Mock;
  32 import org.mockito.junit.jupiter.MockitoExtension;
  33 import org.openhab.core.items.Metadata;
  34 import org.openhab.core.items.MetadataKey;
  35 import org.openhab.core.items.MetadataRegistry;
  36 import org.openhab.core.library.types.PercentType;
  37 import org.openhab.core.persistence.FilterCriteria;
  38 import org.openhab.persistence.influxdb.InfluxDBPersistenceService;
  39 import org.openhab.persistence.influxdb.internal.influx1.Influx1FilterCriteriaQueryCreatorImpl;
  40 import org.openhab.persistence.influxdb.internal.influx2.Influx2FilterCriteriaQueryCreatorImpl;
  41
  42 /**
  43  * @author Joan Pujol Espinar - Initial contribution
  44  */
  45 @ExtendWith(MockitoExtension.class)
  46 @NonNullByDefault({ DefaultLocation.RETURN_TYPE, DefaultLocation.PARAMETER })
  47 public class InfluxFilterCriteriaQueryCreatorImplTest {
  48     private static final String RETENTION_POLICY = "origin";
  49     public static final String ITEM_NAME = "sampleItem";
  50
  51     private static final DateTimeFormatter INFLUX2_DATE_FORMATTER = DateTimeFormatter
  52             .ofPattern("yyyy-MM-dd'T'HH:mm:ss.nnnnnnnnn'Z'").withZone(ZoneId.of("UTC"));
  53
  54     private @Mock InfluxDBConfiguration influxDBConfiguration;
  55     private @Mock MetadataRegistry metadataRegistry;
  56
  57     private Influx1FilterCriteriaQueryCreatorImpl instanceV1;
  58     private Influx2FilterCriteriaQueryCreatorImpl instanceV2;
  59
  60     @BeforeEach
  61     public void before() {
  62         instanceV1 = new Influx1FilterCriteriaQueryCreatorImpl(influxDBConfiguration, metadataRegistry);
  63         instanceV2 = new Influx2FilterCriteriaQueryCreatorImpl(influxDBConfiguration, metadataRegistry);
  64     }
  65
  66     @AfterEach
  67     public void after() {
  68         instanceV1 = null;
  69         instanceV2 = null;
  70         influxDBConfiguration = null;
  71         metadataRegistry = null;
  72     }
  73
  74     @Test
  75     public void testSimpleItemQueryWithoutParams() {
  76         FilterCriteria criteria = createBaseCriteria();
  77
  78         String queryV1 = instanceV1.createQuery(criteria, RETENTION_POLICY);
  79         assertThat(queryV1, equalTo("SELECT \"value\"::field,\"item\"::tag FROM origin.sampleItem;"));
  80
  81         String queryV2 = instanceV2.createQuery(criteria, RETENTION_POLICY);
  82         assertThat(queryV2, equalTo("from(bucket:\"origin\")\n\t" + "|> range(start:-100y)\n\t"
  83                 + "|> filter(fn: (r) => r[\"_measurement\"] == \"sampleItem\")"));
  84     }
  85
  86     @Test
  87     public void testSimpleUnboundedItemWithoutParams() {
  88         FilterCriteria criteria = new FilterCriteria();
  89         criteria.setOrdering(null);
  90
  91         String queryV1 = instanceV1.createQuery(criteria, RETENTION_POLICY);
  92         assertThat(queryV1, equalTo("SELECT \"value\"::field,\"item\"::tag FROM origin./.*/;"));
  93
  94         String queryV2 = instanceV2.createQuery(criteria, RETENTION_POLICY);
  95         assertThat(queryV2, equalTo("from(bucket:\"origin\")\n\t" + "|> range(start:-100y)"));
  96     }
  97
  98     @Test
  99     public void testRangeCriteria() {
 100         FilterCriteria criteria = createBaseCriteria();
 101         ZonedDateTime now = ZonedDateTime.now();
 102         ZonedDateTime tomorrow = now.plus(1, ChronoUnit.DAYS);
 103         criteria.setBeginDate(now);
 104         criteria.setEndDate(tomorrow);
 105
 106         String queryV1 = instanceV1.createQuery(criteria, RETENTION_POLICY);
 107         String expectedQueryV1 = String.format(
 108                 "SELECT \"value\"::field,\"item\"::tag FROM origin.sampleItem WHERE time >= '%s' AND time <= '%s';",
 109                 now.toInstant(), tomorrow.toInstant());
 110         assertThat(queryV1, equalTo(expectedQueryV1));
 111
 112         String queryV2 = instanceV2.createQuery(criteria, RETENTION_POLICY);
 113         String expectedQueryV2 = String.format(
 114                 "from(bucket:\"origin\")\n\t" + "|> range(start:%s, stop:%s)\n\t"
 115                         + "|> filter(fn: (r) => r[\"_measurement\"] == \"sampleItem\")",
 116                 INFLUX2_DATE_FORMATTER.format(now.toInstant()), INFLUX2_DATE_FORMATTER.format(tomorrow.toInstant()));
 117         assertThat(queryV2, equalTo(expectedQueryV2));
 118     }
 119
 120     @Test
 121     public void testValueOperator() {
 122         FilterCriteria criteria = createBaseCriteria();
 123         criteria.setOperator(FilterCriteria.Operator.LTE);
 124         criteria.setState(new PercentType(90));
 125
 126         String query = instanceV1.createQuery(criteria, RETENTION_POLICY);
 127         assertThat(query, equalTo("SELECT \"value\"::field,\"item\"::tag FROM origin.sampleItem WHERE value <= 90;"));
 128
 129         String queryV2 = instanceV2.createQuery(criteria, RETENTION_POLICY);
 130         assertThat(queryV2,
 131                 equalTo("from(bucket:\"origin\")\n\t" + "|> range(start:-100y)\n\t"
 132                         + "|> filter(fn: (r) => r[\"_measurement\"] == \"sampleItem\")\n\t"
 133                         + "|> filter(fn: (r) => (r[\"_field\"] == \"value\" and r[\"_value\"] <= 90))"));
 134     }
 135
 136     @Test
 137     public void testPagination() {
 138         FilterCriteria criteria = createBaseCriteria();
 139         criteria.setPageNumber(2);
 140         criteria.setPageSize(10);
 141
 142         String query = instanceV1.createQuery(criteria, RETENTION_POLICY);
 143         assertThat(query, equalTo("SELECT \"value\"::field,\"item\"::tag FROM origin.sampleItem LIMIT 10 OFFSET 20;"));
 144
 145         String queryV2 = instanceV2.createQuery(criteria, RETENTION_POLICY);
 146         assertThat(queryV2, equalTo("from(bucket:\"origin\")\n\t" + "|> range(start:-100y)\n\t"
 147                 + "|> filter(fn: (r) => r[\"_measurement\"] == \"sampleItem\")\n\t" + "|> limit(n:10, offset:20)"));
 148     }
 149
 150     @Test
 151     public void testOrdering() {
 152         FilterCriteria criteria = createBaseCriteria();
 153         criteria.setOrdering(FilterCriteria.Ordering.ASCENDING);
 154
 155         String query = instanceV1.createQuery(criteria, RETENTION_POLICY);
 156         assertThat(query, equalTo("SELECT \"value\"::field,\"item\"::tag FROM origin.sampleItem ORDER BY time ASC;"));
 157
 158         String queryV2 = instanceV2.createQuery(criteria, RETENTION_POLICY);
 159         assertThat(queryV2,
 160                 equalTo("from(bucket:\"origin\")\n\t" + "|> range(start:-100y)\n\t"
 161                         + "|> filter(fn: (r) => r[\"_measurement\"] == \"sampleItem\")\n\t"
 162                         + "|> sort(desc:false, columns:[\"_time\"])"));
 163     }
 164
 165     private FilterCriteria createBaseCriteria() {
 166         return createBaseCriteria(ITEM_NAME);
 167     }
 168
 169     private FilterCriteria createBaseCriteria(String sampleItem) {
 170         FilterCriteria criteria = new FilterCriteria();
 171         criteria.setItemName(sampleItem);
 172         criteria.setOrdering(null);
 173         return criteria;
 174     }
 175
 176     @Test
 177     public void testMeasurementNameFromMetadata() {
 178         FilterCriteria criteria = createBaseCriteria();
 179         MetadataKey metadataKey = new MetadataKey(InfluxDBPersistenceService.SERVICE_NAME, "sampleItem");
 180
 181         when(metadataRegistry.get(metadataKey))
 182                 .thenReturn(new Metadata(metadataKey, "measurementName", Map.of("key1", "val1", "key2", "val2")));
 183
 184         String queryV1 = instanceV1.createQuery(criteria, RETENTION_POLICY);
 185         assertThat(queryV1, equalTo(
 186                 "SELECT \"value\"::field,\"item\"::tag FROM origin.measurementName WHERE item = 'sampleItem';"));
 187
 188         String queryV2 = instanceV2.createQuery(criteria, RETENTION_POLICY);
 189         assertThat(queryV2,
 190                 equalTo("from(bucket:\"origin\")\n\t" + "|> range(start:-100y)\n\t"
 191                         + "|> filter(fn: (r) => r[\"_measurement\"] == \"measurementName\")\n\t"
 192                         + "|> filter(fn: (r) => r[\"item\"] == \"sampleItem\")"));
 193
 194         when(metadataRegistry.get(metadataKey))
 195                 .thenReturn(new Metadata(metadataKey, "", Map.of("key1", "val1", "key2", "val2")));
 196
 197         queryV1 = instanceV1.createQuery(criteria, RETENTION_POLICY);
 198         assertThat(queryV1, equalTo("SELECT \"value\"::field,\"item\"::tag FROM origin.sampleItem;"));
 199
 200         queryV2 = instanceV2.createQuery(criteria, RETENTION_POLICY);
 201         assertThat(queryV2, equalTo("from(bucket:\"origin\")\n\t" + "|> range(start:-100y)\n\t"
 202                 + "|> filter(fn: (r) => r[\"_measurement\"] == \"sampleItem\")"));
 203     }
 204 }