firebase-ios-sdk/Firestore/core/test/unit/testutil/testutil.h

/*
 * Copyright 2018 Google
 *
 * Licensed 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.
 */

#ifndef FIRESTORE_CORE_TEST_UNIT_TESTUTIL_TESTUTIL_H_
#define FIRESTORE_CORE_TEST_UNIT_TESTUTIL_TESTUTIL_H_

#include <cstdint>
#include <memory>
#include <string>
#include <utility>
#include <vector>

#include "Firestore/core/src/core/core_fwd.h"
#include "Firestore/core/src/model/field_value.h"
#include "Firestore/core/src/model/model_fwd.h"
#include "absl/strings/string_view.h"

namespace firebase {
class Timestamp;

namespace firestore {
class GeoPoint;

namespace nanopb {
class ByteString;
}  // namespace nanopb

namespace testutil {
namespace details {

model::FieldValue BlobValue(std::initializer_list<uint8_t>);

}  // namespace details

// Convenience methods for creating instances for tests.

nanopb::ByteString Bytes(std::initializer_list<uint8_t>);

model::FieldValue Value(std::nullptr_t);

/**
 * A type definition that evaluates to type V only if T is exactly type `bool`.
 */
template <typename T, typename V>
using EnableForExactlyBool =
    typename std::enable_if<std::is_same<bool, T>::value, V>::type;

/**
 * A type definition that evaluates to type V only if T is an integral type but
 * not `bool`.
 */
template <typename T, typename V>
using EnableForInts = typename std::enable_if<std::is_integral<T>::value &&
                                                  !std::is_same<bool, T>::value,
                                              V>::type;

/**
 * Creates a boolean FieldValue.
 *
 * @tparam T A type that must be exactly bool. Any T that is not bool causes
 *     this declaration to be disabled.
 * @param bool_value A boolean value that disallows implicit conversions.
 */
template <typename T>
EnableForExactlyBool<T, model::FieldValue> Value(T bool_value) {
  return model::FieldValue::FromBoolean(bool_value);
}

/**
 * Creates an integer FieldValue.
 *
 * This is defined as a template to capture all integer literals. Just defining
 * this as taking int64_t would make integer literals ambiguous because int64_t
 * and double are equally good choices according to the standard.
 *
 * @tparam T Any integral type (but not bool). Types larger than int64_t will
 *     likely generate a warning.
 * @param value An integer value.
 */
template <typename T>
EnableForInts<T, model::FieldValue> Value(T value) {
  return model::FieldValue::FromInteger(value);
}

model::FieldValue Value(double value);

model::FieldValue Value(Timestamp value);

model::FieldValue Value(const char* value);

model::FieldValue Value(const std::string& value);

model::FieldValue Value(const GeoPoint& value);

template <typename... Ints>
model::FieldValue BlobValue(Ints... octets) {
  return details::BlobValue({static_cast<uint8_t>(octets)...});
}

// This overload allows Object() to appear as a value (along with any explicitly
// constructed FieldValues).
model::FieldValue Value(const model::FieldValue& value);

model::FieldValue Value(const model::ObjectValue& value);

model::FieldValue Value(const model::FieldValue::Map& value);

namespace details {

/**
 * Recursive base case for AddPairs, below. Returns the map.
 */
inline model::FieldValue::Map AddPairs(const model::FieldValue::Map& prior) {
  return prior;
}

/**
 * Inserts the given key-value pair into the map, and then recursively calls
 * AddPairs to add any remaining arguments.
 *
 * @param prior A map into which the values should be inserted.
 * @param key The key naming the field to insert.
 * @param value A value to wrap with a call to Value(), above.
 * @param rest Any remaining arguments
 *
 * @return The resulting map.
 */
template <typename ValueType, typename... Args>
model::FieldValue::Map AddPairs(const model::FieldValue::Map& prior,
                                const std::string& key,
                                const ValueType& value,
                                Args... rest) {
  return AddPairs(prior.insert(key, Value(value)), rest...);
}

/**
 * Creates an immutable sorted map from the given key/value pairs.
 *
 * @param key_value_pairs Alternating strings naming keys and values that can
 *     be passed to Value().
 */
template <typename... Args>
model::FieldValue::Map MakeMap(Args... key_value_pairs) {
  return AddPairs(model::FieldValue::Map(), key_value_pairs...);
}

}  // namespace details

template <typename... Args>
model::FieldValue Array(Args... values) {
  std::vector<model::FieldValue> contents{Value(values)...};
  return model::FieldValue::FromArray(std::move(contents));
}

/** Wraps an immutable sorted map into an ObjectValue. */
model::ObjectValue WrapObject(const model::FieldValue::Map& value);

/**
 * Creates an ObjectValue from the given key/value pairs.
 *
 * @param key_value_pairs Alternating strings naming keys and values that can
 *     be passed to Value().
 */
template <typename... Args>
model::ObjectValue WrapObject(Args... key_value_pairs) {
  return WrapObject(details::MakeMap(key_value_pairs...));
}

/**
 * Creates an ObjectValue from the given key/value pairs with Type::Object.
 *
 * @param key_value_pairs Alternating strings naming keys and values that can
 *     be passed to Value().
 */
template <typename... Args>
model::FieldValue::Map Map(Args... key_value_pairs) {
  return details::MakeMap(key_value_pairs...);
}

model::DocumentKey Key(absl::string_view path);

model::FieldPath Field(absl::string_view field);

model::DatabaseId DbId(std::string project = "project/(default)");

model::FieldValue Ref(std::string project, absl::string_view path);

model::ResourcePath Resource(absl::string_view field);

/**
 * Creates a snapshot version from the given version timestamp.
 *
 * @param version a timestamp in microseconds since the epoch.
 */
model::SnapshotVersion Version(int64_t version);

model::Document Doc(
    absl::string_view key,
    int64_t version = 0,
    const model::FieldValue::Map& data = model::FieldValue::Map());

model::Document Doc(absl::string_view key,
                    int64_t version,
                    const model::FieldValue::Map& data,
                    model::DocumentState document_state);

model::Document Doc(absl::string_view key,
                    int64_t version,
                    const model::FieldValue& data);

model::Document Doc(absl::string_view key,
                    int64_t version,
                    const model::FieldValue& data,
                    model::DocumentState document_state);

/** A convenience method for creating deleted docs for tests. */
model::NoDocument DeletedDoc(absl::string_view key,
                             int64_t version = 0,
                             bool has_committed_mutations = false);

/** A convenience method for creating deleted docs for tests. */
model::NoDocument DeletedDoc(model::DocumentKey key,
                             int64_t version = 0,
                             bool has_committed_mutations = false);

/** A convenience method for creating unknown docs for tests. */
model::UnknownDocument UnknownDoc(absl::string_view key, int64_t version);

/**
 * Creates a DocumentComparator that will compare Documents by the given
 * field_path string then by key.
 */
model::DocumentComparator DocComparator(absl::string_view field_path);

/**
 * Creates a DocumentSet based on the given comparator, initially containing the
 * given documents.
 */
model::DocumentSet DocSet(model::DocumentComparator comp,
                          std::vector<model::Document> docs);

core::FieldFilter Filter(absl::string_view key,
                         absl::string_view op,
                         model::FieldValue value);

core::FieldFilter Filter(absl::string_view key,
                         absl::string_view op,
                         model::FieldValue::Map value);

core::FieldFilter Filter(absl::string_view key,
                         absl::string_view op,
                         std::nullptr_t);

core::FieldFilter Filter(absl::string_view key,
                         absl::string_view op,
                         const char* value);

template <typename T>
EnableForExactlyBool<T, core::FieldFilter> Filter(absl::string_view key,
                                                  absl::string_view op,
                                                  T value) {
  return Filter(key, op, Value(value));
}

core::FieldFilter Filter(absl::string_view key,
                         absl::string_view op,
                         int value);

core::FieldFilter Filter(absl::string_view key,
                         absl::string_view op,
                         double value);

core::Direction Direction(absl::string_view direction);

core::OrderBy OrderBy(absl::string_view key,
                      absl::string_view direction = "asc");

core::OrderBy OrderBy(model::FieldPath field_path, core::Direction direction);

core::Query Query(absl::string_view path);

core::Query CollectionGroupQuery(absl::string_view collection_id);

model::SetMutation SetMutation(
    absl::string_view path,
    const model::FieldValue::Map& values = model::FieldValue::Map());

model::PatchMutation PatchMutation(
    absl::string_view path,
    model::FieldValue::Map values = model::FieldValue::Map(),
    std::vector<model::FieldPath> update_mask = {});

model::TransformMutation TransformMutation(
    absl::string_view path,
    std::vector<std::pair<std::string, model::TransformOperation>> transforms);

/**
 * Creates a pair of field name, TransformOperation that represents a numeric
 * increment on the given field, suitable for passing to TransformMutation,
 * above.
 */
std::pair<std::string, model::TransformOperation> Increment(
    std::string field, model::FieldValue operand);

/**
 * Creates a pair of field name, TransformOperation that represents an array
 * union on the given field, suitable for passing to TransformMutation,
 * above.
 */
std::pair<std::string, model::TransformOperation> ArrayUnion(
    std::string field, std::vector<model::FieldValue> operands);

model::DeleteMutation DeleteMutation(absl::string_view path);

model::VerifyMutation VerifyMutation(absl::string_view path, int64_t version);

model::MutationResult MutationResult(int64_t version);

nanopb::ByteString ResumeToken(int64_t snapshot_version);

template <typename T, typename... Ts>
std::vector<T> Vector(T&& arg1, Ts&&... args) {
  return {std::forward<T>(arg1), std::forward<Ts>(args)...};
}

// Degenerate case to end recursion of `MoveIntoVector`.
template <typename T>
void MoveIntoVector(std::vector<std::unique_ptr<T>>*) {
}

template <typename T, typename Head, typename... Tail>
void MoveIntoVector(std::vector<std::unique_ptr<T>>* result,
                    Head head,
                    Tail... tail) {
  result->push_back(std::move(head));
  MoveIntoVector(result, std::move(tail)...);
}

// Works around the fact that move-only types (in this case, `unique_ptr`) don't
// work with `initializer_list`. Desired (doesn't work):
//
//   std::unique_ptr<int> x, y;
//   std::vector<std::unique_ptr>> foo{std::move(x), std::move(y)};
//
// Actual:
//
//   std::unique_ptr<int> x, y;
//   std::vector<std::unique_ptr<int>> foo = Changes(std::move(x),
//   std::move(y));
template <typename T, typename... Elems>
std::vector<std::unique_ptr<T>> VectorOfUniquePtrs(Elems... elems) {
  std::vector<std::unique_ptr<T>> result;
  MoveIntoVector<T>(&result, std::move(elems)...);
  return result;
}

}  // namespace testutil
}  // namespace firestore
}  // namespace firebase

#endif  // FIRESTORE_CORE_TEST_UNIT_TESTUTIL_TESTUTIL_H_