hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-timelineservice-hbase/hadoop-yarn-server-timelineservice-hbase-common/src/test/java/org/apache/hadoop/yarn/server/timelineservice/storage/common/TestRowKeysAsString.java

/**
 * 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.hadoop.yarn.server.timelineservice.storage.common;

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.Timeout;

import org.apache.hadoop.yarn.api.records.ApplicationId;
import org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity;
import org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderUtils;
import org.apache.hadoop.yarn.server.timelineservice.storage.application.ApplicationRowKey;
import org.apache.hadoop.yarn.server.timelineservice.storage.entity.EntityRowKey;
import org.apache.hadoop.yarn.server.timelineservice.storage.flow.FlowActivityRowKey;
import org.apache.hadoop.yarn.server.timelineservice.storage.flow.FlowRunRowKey;
import org.apache.hadoop.yarn.server.timelineservice.storage.subapplication.SubApplicationRowKey;

import static org.junit.jupiter.api.Assertions.assertEquals;

/**
 * Test for row key as string.
 */
public class TestRowKeysAsString {

  private final static String CLUSTER =
      "cl" + TimelineReaderUtils.DEFAULT_DELIMITER_CHAR + "uster"
          + TimelineReaderUtils.DEFAULT_ESCAPE_CHAR;
  private final static String USER =
      TimelineReaderUtils.DEFAULT_ESCAPE_CHAR + "user";
  private final static String SUB_APP_USER =
      TimelineReaderUtils.DEFAULT_ESCAPE_CHAR + "subAppUser";

  private final static String FLOW_NAME =
      "dummy_" + TimelineReaderUtils.DEFAULT_DELIMITER_CHAR
          + TimelineReaderUtils.DEFAULT_ESCAPE_CHAR + "flow"
          + TimelineReaderUtils.DEFAULT_DELIMITER_CHAR;
  private final static Long FLOW_RUN_ID = System.currentTimeMillis();
  private final static String APPLICATION_ID =
      ApplicationId.newInstance(System.currentTimeMillis(), 1).toString();

  @Test
  @Timeout(10000)
  void testApplicationRow() {
    String rowKeyAsString = new ApplicationRowKey(CLUSTER, USER, FLOW_NAME,
        FLOW_RUN_ID, APPLICATION_ID).getRowKeyAsString();
    ApplicationRowKey rowKey =
        ApplicationRowKey.parseRowKeyFromString(rowKeyAsString);
    assertEquals(CLUSTER, rowKey.getClusterId());
    assertEquals(USER, rowKey.getUserId());
    assertEquals(FLOW_NAME, rowKey.getFlowName());
    assertEquals(FLOW_RUN_ID, rowKey.getFlowRunId());
    assertEquals(APPLICATION_ID, rowKey.getAppId());
  }

  @Test
  @Timeout(10000)
  void testEntityRowKey() {
    char del = TimelineReaderUtils.DEFAULT_DELIMITER_CHAR;
    char esc = TimelineReaderUtils.DEFAULT_ESCAPE_CHAR;
    String id = del + esc + "ent" + esc + del + "ity" + esc + del + esc + "id"
        + esc + del + esc;
    String type = "entity" + esc + del + esc + "Type";
    TimelineEntity entity = new TimelineEntity();
    entity.setId(id);
    entity.setType(type);
    entity.setIdPrefix(54321);

    String rowKeyAsString =
        new EntityRowKey(CLUSTER, USER, FLOW_NAME, FLOW_RUN_ID, APPLICATION_ID,
            entity.getType(), entity.getIdPrefix(), entity.getId())
            .getRowKeyAsString();
    EntityRowKey rowKey = EntityRowKey.parseRowKeyFromString(rowKeyAsString);
    assertEquals(CLUSTER, rowKey.getClusterId());
    assertEquals(USER, rowKey.getUserId());
    assertEquals(FLOW_NAME, rowKey.getFlowName());
    assertEquals(FLOW_RUN_ID, rowKey.getFlowRunId());
    assertEquals(APPLICATION_ID, rowKey.getAppId());
    assertEquals(entity.getType(), rowKey.getEntityType());
    assertEquals(entity.getIdPrefix(), rowKey.getEntityIdPrefix().longValue());
    assertEquals(entity.getId(), rowKey.getEntityId());

  }

  @Test
  @Timeout(10000)
  void testFlowActivityRowKey() {
    Long ts = 1459900830000L;
    Long dayTimestamp = HBaseTimelineSchemaUtils.getTopOfTheDayTimestamp(ts);
    String rowKeyAsString = new FlowActivityRowKey(CLUSTER, ts, USER, FLOW_NAME)
        .getRowKeyAsString();
    FlowActivityRowKey rowKey =
        FlowActivityRowKey.parseRowKeyFromString(rowKeyAsString);
    assertEquals(CLUSTER, rowKey.getClusterId());
    assertEquals(dayTimestamp, rowKey.getDayTimestamp());
    assertEquals(USER, rowKey.getUserId());
    assertEquals(FLOW_NAME, rowKey.getFlowName());
  }

  @Test
  @Timeout(10000)
  void testFlowRunRowKey() {
    String rowKeyAsString =
        new FlowRunRowKey(CLUSTER, USER, FLOW_NAME, FLOW_RUN_ID)
            .getRowKeyAsString();
    FlowRunRowKey rowKey = FlowRunRowKey.parseRowKeyFromString(rowKeyAsString);
    assertEquals(CLUSTER, rowKey.getClusterId());
    assertEquals(USER, rowKey.getUserId());
    assertEquals(FLOW_NAME, rowKey.getFlowName());
    assertEquals(FLOW_RUN_ID, rowKey.getFlowRunId());
  }

  @Test
  @Timeout(10000)
  void testSubApplicationRowKey() {
    char del = TimelineReaderUtils.DEFAULT_DELIMITER_CHAR;
    char esc = TimelineReaderUtils.DEFAULT_ESCAPE_CHAR;
    String id = del + esc + "ent" + esc + del + "ity" + esc + del + esc + "id"
        + esc + del + esc;
    String type = "entity" + esc + del + esc + "Type";
    TimelineEntity entity = new TimelineEntity();
    entity.setId(id);
    entity.setType(type);
    entity.setIdPrefix(54321);

    String rowKeyAsString = new SubApplicationRowKey(SUB_APP_USER, CLUSTER,
        entity.getType(), entity.getIdPrefix(), entity.getId(), USER)
        .getRowKeyAsString();
    SubApplicationRowKey rowKey = SubApplicationRowKey
        .parseRowKeyFromString(rowKeyAsString);
    assertEquals(SUB_APP_USER, rowKey.getSubAppUserId());
    assertEquals(CLUSTER, rowKey.getClusterId());
    assertEquals(entity.getType(), rowKey.getEntityType());
    assertEquals(entity.getIdPrefix(), rowKey.getEntityIdPrefix().longValue());
    assertEquals(entity.getId(), rowKey.getEntityId());
    assertEquals(USER, rowKey.getUserId());
  }
}