it/splunk/src/main/java/org/apache/beam/it/splunk/matchers/SplunkAsserts.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.beam.it.splunk.matchers;

import static org.apache.beam.it.splunk.SplunkResourceManagerUtils.splunkEventToMap;
import static org.apache.beam.it.truthmatchers.PipelineAsserts.assertThatRecords;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import org.apache.beam.it.truthmatchers.RecordsSubject;
import org.apache.beam.sdk.io.splunk.SplunkEvent;

/** Assert utilities for Splunk tests. */
public class SplunkAsserts {

  /**
   * Convert Splunk {@link SplunkEvent} to a list of maps.
   *
   * @param events List of SplunkEvents to parse
   * @return List of maps to use in {@link RecordsSubject}
   */
  public static List<Map<String, Object>> splunkEventsToRecords(Collection<SplunkEvent> events) {
    try {
      List<Map<String, Object>> records = new ArrayList<>();

      for (SplunkEvent event : events) {
        Map<String, Object> converted = splunkEventToMap(event);
        records.add(converted);
      }

      return records;
    } catch (Exception e) {
      throw new RuntimeException("Error converting SplunkEvents to Records", e);
    }
  }

  /**
   * Creates a {@link RecordsSubject} to assert information within a list of records.
   *
   * @param events List of SplunkEvents in Splunk {@link SplunkEvent} format to use in the
   *     comparison.
   * @return Truth subject to chain assertions.
   */
  public static RecordsSubject assertThatSplunkEvents(Collection<SplunkEvent> events) {
    return assertThatRecords(splunkEventsToRecords(events));
  }
}