tests/src/integration/dse_integration.hpp

/*
  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.
*/

#ifndef __DSE_INTEGRATION_HPP__
#define __DSE_INTEGRATION_HPP__
#include "integration.hpp"

#include "dse.h"

#include "dse_objects.hpp"
#include "dse_values.hpp"

#undef SKIP_TEST_VERSION
#define SKIP_TEST_VERSION(server_version_string, version_string) \
  SKIP_TEST("Unsupported for DataStax Enterprise Version "       \
            << server_version_string << ": Server version " << version_string << "+ is required")

#undef CHECK_VERSION
#define CHECK_VERSION(version)                                              \
  if (!Options::is_dse()) {                                                 \
    SKIP_TEST("DataStax Enterprise Version " << #version << " is required") \
  } else if (this->server_version_ < #version) {                            \
    SKIP_TEST_VERSION(this->server_version_.to_string(), #version)          \
  }

#undef CHECK_VALUE_TYPE_VERSION
#define CHECK_VALUE_TYPE_VERSION(type)                                                     \
  if (this->server_version_ < type::supported_server_version()) {                          \
    SKIP_TEST_VERSION(this->server_version_.to_string(), type::supported_server_version()) \
  }

// Macros to use for grouping DSE integration tests together
#define DSE_INTEGRATION_TEST(test_case, test_name) INTEGRATION_TEST(DSE, test_case, test_name)
#define DSE_INTEGRATION_TEST_F(test_case, test_name) INTEGRATION_TEST_F(DSE, test_case, test_name)
#define DSE_INTEGRATION_TYPED_TEST_P(test_case, test_name) \
  INTEGRATION_TYPED_TEST_P(DSE, test_case, test_name)
#define DSE_INTEGRATION_DISABLED_TEST_F(test_case, test_name) \
  INTEGRATION_DISABLED_TEST_F(DSE, test_case, test_name)
#define DSE_INTEGRATION_DISABLED_TYPED_TEST_P(test_case, test_name) \
  INTEGRATION_DISABLED_TYPED_TEST_P(DSE, test_case, test_name)

/**
 * Extended class to provide common integration test functionality for DSE
 * tests
 */
class DseIntegration : public Integration {
public:
  using Integration::connect;

  DseIntegration();

  virtual void SetUp();

  /**
   * Establish the session connection using provided cluster object.
   *
   * @param cluster Cluster object to use when creating session connection
   */
  virtual void connect(dse::Cluster cluster);

  /**
   * Create the cluster configuration and establish the session connection using
   * provided cluster object.
   */
  virtual void connect();

  /**
   * Get the default DSE cluster configuration
   *
   * @param is_with_default_contact_points True if default contact points
                                           should be added to the cluster
   * @return DSE Cluster object (default)
   */
  virtual Cluster default_cluster(bool is_with_default_contact_points = true);

protected:
  /**
   * Configured DSE cluster
   */
  dse::Cluster dse_cluster_;
  /**
   * Connected database DSE session
   */
  dse::Session dse_session_;
};

#endif //__DSE_INTEGRATION_HPP__