class RebalanceinJython(BaseTestCase):
def setUp(self):
super(RebalanceinJython, self).setUp()
self.task_manager = TaskManager()
self.load_gen_tasks = []
def tearDown(self):
self.task_manager.shutdown_task_manager()
super(RebalanceinJython, self).tearDown()
def start_load_gen(self, docs, bucket):
cluster = CouchbaseCluster.create(self.servers[0].ip)
cluster.authenticate("Administrator", "password")
bucket = cluster.openBucket(bucket)
k = "rebalance"
v = {"value": "asd"}
docloaders = []
num_executors = 5
total_num_executors = 5
num_docs = docs / total_num_executors
load_gen_task_name = "Loadgen"
for i in xrange(total_num_executors):
task_name = "{0}_{1}".format(load_gen_task_name, i)
self.load_gen_tasks.append(
DocloaderTask(bucket, num_docs, i * num_docs, k, v, task_name))
for task in self.load_gen_tasks:
self.task_manager.add_new_task(task)
def finish_load_gen(self):
for task in self.load_gen_tasks:
print self.task_manager.get_task_result(task)
def start_rebalance_nodes(self):
servs_in = [
self.servers[i + self.nodes_init] for i in range(self.nodes_in)
]
self.rebalance_task = rebalanceTask(self.servers[:self.nodes_init],
to_add=servs_in,
to_remove=[])
self.task_manager.add_new_task(self.rebalance_task)
def get_rebalance_result(self):
return self.task_manager.get_task_result(self.rebalance_task)
def test_rebalance_in(self):
self.start_load_gen(100000, self.buckets[0].name)
self.sleep(5)
#test_Task = TestTask(30)
#self.task_manager.add_new_task(test_Task)
self.start_rebalance_nodes()
print self.get_rebalance_result()
#print self.task_manager.get_task_result(test_Task)
self.finish_load_gen()
class CBASClusterOperations(CBASBaseTest):
def setUp(self):
self.input = TestInputSingleton.input
self.input.test_params.update({"default_bucket": False})
self.rebalanceServers = None
self.nodeType = "KV"
self.wait_for_rebalance = True
super(CBASClusterOperations, self).setUp()
self.num_items = self.input.param("items", 1000)
self.bucket_util.create_default_bucket()
# self.cbas_util.createConn("default")
if 'nodeType' in self.input.test_params:
self.nodeType = self.input.test_params['nodeType']
self.rebalance_both = self.input.param("rebalance_cbas_and_kv", False)
if not self.rebalance_both:
if self.nodeType == "KV":
self.rebalanceServers = self.kv_servers
self.wait_for_rebalance = False
elif self.nodeType == "CBAS":
self.rebalanceServers = [self.cbas_node] + self.cbas_servers
else:
self.rebalanceServers = self.kv_servers + [self.cbas_node
] + self.cbas_servers
self.nodeType = "KV" + "-" + "CBAS"
self.assertTrue(
len(self.rebalanceServers) > 1,
"Not enough %s servers to run tests." % self.rebalanceServers)
self.log.info("This test will be running in %s context." %
self.nodeType)
self.task_manager = TaskManager()
self.load_gen_tasks = []
def setup_for_test(self, skip_data_loading=False):
if not skip_data_loading:
# Load Couchbase bucket first.
self.perform_doc_ops_in_all_cb_buckets(self.num_items, "create", 0,
self.num_items)
self.cbas_util.createConn(self.cb_bucket_name)
# Create bucket on CBAS
self.assertTrue(
self.cbas_util.create_bucket_on_cbas(
cbas_bucket_name=self.cbas_bucket_name,
cb_bucket_name=self.cb_bucket_name,
cb_server_ip=self.cb_server_ip),
"bucket creation failed on cbas")
# Create dataset on the CBAS bucket
self.cbas_util.create_dataset_on_bucket(
cbas_bucket_name=self.cb_bucket_name,
cbas_dataset_name=self.cbas_dataset_name)
# Create indexes on the CBAS bucket
self.create_secondary_indexes = self.input.param(
"create_secondary_indexes", False)
if self.create_secondary_indexes:
self.index_fields = "profession:string,number:bigint"
create_idx_statement = "create index {0} on {1}({2});".format(
self.index_name, self.cbas_dataset_name, self.index_fields)
status, metrics, errors, results, _ = self.cbas_util.execute_statement_on_cbas_util(
create_idx_statement)
self.assertTrue(status == "success", "Create Index query failed")
self.assertTrue(
self.cbas_util.verify_index_created(
self.index_name, self.index_fields.split(","),
self.cbas_dataset_name)[0])
# Connect to Bucket
self.cbas_util.connect_to_bucket(
cbas_bucket_name=self.cbas_bucket_name,
cb_bucket_password=self.cb_bucket_password)
if not skip_data_loading:
# Validate no. of items in CBAS dataset
if not self.cbas_util.validate_cbas_dataset_items_count(
self.cbas_dataset_name, self.num_items):
self.fail(
"No. of items in CBAS dataset do not match that in the CB bucket"
)
def test_rebalance_in(self):
'''
Description: This will test the rebalance in feature i.e. one node coming in to the cluster.
Then Rebalance. Verify that is has no effect on the data ingested to cbas.
Steps:
1. Setup cbas. bucket, datasets/shadows, connect.
2. Add a node and rebalance. Don't wait for rebalance completion.
3. During rebalance, do mutations and execute queries on cbas.
Author: Ritesh Agarwal/Mihir Kamdar
Date Created: 18/07/2017
'''
query = "select count(*) from {0};".format(self.cbas_dataset_name)
self.setup_for_test()
self.add_node(node=self.rebalanceServers[1],
rebalance=True,
wait_for_rebalance_completion=self.wait_for_rebalance)
self.log.info("Rebalance state:%s" %
self.rest._rebalance_progress_status())
self.perform_doc_ops_in_all_cb_buckets(self.num_items, "create",
self.num_items,
self.num_items * 2)
self.log.info("Rebalance state:%s" %
self.rest._rebalance_progress_status())
self.cbas_util._run_concurrent_queries(
query, None, 2000, batch_size=self.concurrent_batch_size)
self.log.info("Rebalance state:%s" %
self.rest._rebalance_progress_status())
if not self.cbas_util.validate_cbas_dataset_items_count(
self.cbas_dataset_name, self.num_items * 2, 0):
self.fail(
"No. of items in CBAS dataset do not match that in the CB bucket"
)
def test_rebalance_out(self):
'''
Description: This will test the rebalance out feature i.e. one node going out of cluster.
Then Rebalance.
Steps:
1. Add a node, Rebalance.
2. Setup cbas. bucket, datasets/shadows, connect.
3. Remove a node and rebalance. Don't wait for rebalance completion.
4. During rebalance, do mutations and execute queries on cbas.
Author: Ritesh Agarwal/Mihir Kamdar
Date Created: 18/07/2017
'''
self.add_node(node=self.rebalanceServers[1])
query = "select count(*) from {0};".format(self.cbas_dataset_name)
self.setup_for_test()
otpnodes = []
nodes = self.rest.node_statuses()
for node in nodes:
if node.ip == self.rebalanceServers[1].ip:
otpnodes.append(node)
self.remove_node(otpnodes, wait_for_rebalance=self.wait_for_rebalance)
self.log.info("Rebalance state:%s" %
self.rest._rebalance_progress_status())
self.perform_doc_ops_in_all_cb_buckets(self.num_items, "create",
self.num_items,
self.num_items * 2)
self.cbas_util._run_concurrent_queries(
query, "immediate", 2000, batch_size=self.concurrent_batch_size)
if not self.cbas_util.validate_cbas_dataset_items_count(
self.cbas_dataset_name, self.num_items * 2, 0):
self.fail(
"No. of items in CBAS dataset do not match that in the CB bucket"
)
def test_swap_rebalance(self):
'''
Description: This will test the swap rebalance feature i.e. one node going out and one node coming in cluster.
Then Rebalance. Verify that is has no effect on the data ingested to cbas.
Steps:
1. Setup cbas. bucket, datasets/shadows, connect.
2. Add a node that is to be swapped against the leaving node. Do not rebalance.
3. Remove a node and rebalance.
4. During rebalance, do mutations and execute queries on cbas.
Author: Ritesh Agarwal/Mihir Kamdar
Date Created: 20/07/2017
'''
query = "select count(*) from {0};".format(self.cbas_dataset_name)
self.setup_for_test()
otpnodes = []
nodes = self.rest.node_statuses()
if self.nodeType == "KV":
service = ["kv"]
else:
service = ["cbas"]
otpnodes.append(self.add_node(node=self.servers[1], services=service))
self.add_node(node=self.servers[3], services=service, rebalance=False)
self.remove_node(otpnodes, wait_for_rebalance=self.wait_for_rebalance)
self.perform_doc_ops_in_all_cb_buckets(self.num_items, "create",
self.num_items,
self.num_items * 2)
self.cbas_util._run_concurrent_queries(
query, "immediate", 2000, batch_size=self.concurrent_batch_size)
if not self.cbas_util.validate_cbas_dataset_items_count(
self.cbas_dataset_name, self.num_items * 2, 0):
self.fail(
"No. of items in CBAS dataset do not match that in the CB bucket"
)
def test_failover(self):
'''
Description: This will test the node failover both graceful and hard failover based on
graceful_failover param in testcase conf file.
Steps:
1. Add node to the cluster which will be failed over.
2. Create docs, setup cbas.
3. Mark the node for fail over.
4. Do rebalance asynchronously. During rebalance perform mutations.
5. Run some CBAS queries.
6. Check for correct number of items in CBAS datasets.
Author: Ritesh Agarwal/Mihir Kamdar
Date Created: 20/07/2017
'''
#Add node which will be failed over later.
self.add_node(node=self.rebalanceServers[1])
query = "select count(*) from {0};".format(self.cbas_dataset_name)
graceful_failover = self.input.param("graceful_failover", False)
self.setup_for_test()
failover_task = self._cb_cluster.async_failover(
self.input.servers, [self.rebalanceServers[1]], graceful_failover)
failover_task.get_result()
self.rebalance()
self.perform_doc_ops_in_all_cb_buckets(self.num_items, "create",
self.num_items,
self.num_items * 3 / 2)
self.cbas_util._run_concurrent_queries(
query, "immediate", 2000, batch_size=self.concurrent_batch_size)
if not self.cbas_util.validate_cbas_dataset_items_count(
self.cbas_dataset_name, self.num_items * 3 / 2, 0):
self.fail(
"No. of items in CBAS dataset do not match that in the CB bucket"
)
'''
-i b/resources/4-nodes-template.ini -t cbas.cbas_cluster_operations.CBASClusterOperations.test_rebalance_in_cb_cbas_together,cb_bucket_name=default,cbas_bucket_name=default_bucket,cbas_dataset_name=default_ds,items=10,nodeType=KV,rebalance_cbas_and_kv=True,wait_for_rebalace=False
'''
def test_rebalance_in_cb_cbas_together(self):
self.log.info("Creates cbas buckets and dataset")
dataset_count_query = "select count(*) from {0};".format(
self.cbas_dataset_name)
self.setup_for_test()
self.log.info("Rebalance in KV node")
wait_for_rebalace_complete = self.input.param("wait_for_rebalace",
False)
self.add_node(node=self.rebalanceServers[1],
rebalance=False,
wait_for_rebalance_completion=wait_for_rebalace_complete)
self.log.info("Rebalance in CBAS node")
self.add_node(node=self.rebalanceServers[3],
rebalance=True,
wait_for_rebalance_completion=wait_for_rebalace_complete)
self.log.info(
"Perform document create as rebalance is in progress : Rebalance state:%s"
% self.rest._rebalance_progress_status())
self.perform_doc_ops_in_all_cb_buckets(self.num_items, "create",
self.num_items,
self.num_items * 2)
self.log.info(
"Run queries as rebalance is in progress : Rebalance state:%s" %
self.rest._rebalance_progress_status())
handles = self.cbas_util._run_concurrent_queries(
dataset_count_query,
None,
2000,
batch_size=self.concurrent_batch_size)
self.log.info("Log concurrent query status")
self.cbas_util.log_concurrent_query_outcome(self.master, handles)
if not self.cbas_util.validate_cbas_dataset_items_count(
self.cbas_dataset_name, self.num_items * 2, 0):
self.fail(
"No. of items in CBAS dataset do not match that in the CB bucket"
)
'''
-i b/resources/4-nodes-template.ini -t cbas.cbas_cluster_operations.CBASClusterOperations.test_rebalance_out_cb_cbas_together,cb_bucket_name=default,cbas_bucket_name=default_bucket,cbas_dataset_name=default_ds,items=10,nodeType=KV,rebalance_cbas_and_kv=True,wait_for_rebalace=False
'''
def test_rebalance_out_cb_cbas_together(self):
self.log.info(
"Rebalance in KV node and wait for rebalance to complete")
self.add_node(node=self.rebalanceServers[1])
self.log.info(
"Rebalance in CBAS node and wait for rebalance to complete")
self.add_node(node=self.rebalanceServers[3])
self.log.info("Creates cbas buckets and dataset")
dataset_count_query = "select count(*) from {0};".format(
self.cbas_dataset_name)
self.setup_for_test()
self.log.info("Fetch and remove nodes to rebalance out")
wait_for_rebalace_complete = self.input.param("wait_for_rebalace",
False)
otpnodes = []
nodes = self.rest.node_statuses()
for node in nodes:
if node.ip == self.rebalanceServers[
1].ip or node.ip == self.rebalanceServers[3].ip:
otpnodes.append(node)
for every_node in otpnodes:
self.remove_node(otpnodes,
wait_for_rebalance=wait_for_rebalace_complete)
self.sleep(30,
message="Sleep for 30 seconds for remove node to complete")
self.log.info(
"Perform document create as rebalance is in progress : Rebalance state:%s"
% self.rest._rebalance_progress_status())
self.perform_doc_ops_in_all_cb_buckets(self.num_items, "create",
self.num_items,
self.num_items * 2)
self.log.info(
"Run queries as rebalance is in progress : Rebalance state:%s" %
self.rest._rebalance_progress_status())
handles = self.cbas_util._run_concurrent_queries(
dataset_count_query,
"immediate",
2000,
batch_size=self.concurrent_batch_size)
self.log.info("Log concurrent query status")
self.cbas_util.log_concurrent_query_outcome(self.master, handles)
if not self.cbas_util.validate_cbas_dataset_items_count(
self.cbas_dataset_name, self.num_items * 2, 0):
self.fail(
"No. of items in CBAS dataset do not match that in the CB bucket"
)
'''
-i b/resources/4-nodes-template.ini -t cbas.cbas_cluster_operations.CBASClusterOperations.test_swap_rebalance_cb_cbas_together,cb_bucket_name=default,cbas_bucket_name=default_bucket,cbas_dataset_name=default_ds,items=10,rebalance_cbas_and_kv=True,wait_for_rebalance=True
'''
def test_swap_rebalance_cb_cbas_together(self):
self.log.info("Creates cbas buckets and dataset")
wait_for_rebalance = self.input.param("wait_for_rebalance", True)
dataset_count_query = "select count(*) from {0};".format(
self.cbas_dataset_name)
self.setup_for_test()
self.log.info("Add KV node and don't rebalance")
self.add_node(node=self.rebalanceServers[1], rebalance=False)
self.log.info("Add cbas node and don't rebalance")
self.add_node(node=self.rebalanceServers[3], rebalance=False)
otpnodes = []
nodes = self.rest.node_statuses()
for node in nodes:
if node.ip == self.rebalanceServers[
0].ip or node.ip == self.rebalanceServers[2].ip:
otpnodes.append(node)
self.log.info("Remove master node")
self.remove_node(otpnode=otpnodes,
wait_for_rebalance=wait_for_rebalance)
self.log.info("Create instances pointing to new master nodes")
c_utils = cbas_utils(self.rebalanceServers[1],
self.rebalanceServers[3])
c_utils.createConn(self.cb_bucket_name)
self.log.info("Create reference to SDK client")
client = SDKClient(scheme="couchbase",
hosts=[self.rebalanceServers[1].ip],
bucket=self.cb_bucket_name,
password=self.rebalanceServers[1].rest_password)
self.log.info("Add more document to default bucket")
documents = ['{"name":"value"}'] * (self.num_items // 10)
document_id_prefix = "custom-id-"
client.insert_custom_json_documents(document_id_prefix, documents)
self.log.info(
"Run queries as rebalance is in progress : Rebalance state:%s" %
self.rest._rebalance_progress_status())
handles = c_utils._run_concurrent_queries(
dataset_count_query,
"immediate",
2000,
batch_size=self.concurrent_batch_size)
self.log.info("Log concurrent query status")
self.cbas_util.log_concurrent_query_outcome(self.master, handles)
if not c_utils.validate_cbas_dataset_items_count(
self.cbas_dataset_name, self.num_items +
(self.num_items // 10), 0):
self.fail(
"No. of items in CBAS dataset do not match that in the CB bucket"
)
def test_rebalance_in_multiple_cbas_on_a_busy_system(self):
node_services = []
node_services.append(self.input.param('service', "cbas"))
self.log.info("Setup CBAS")
self.setup_for_test(skip_data_loading=True)
self.log.info("Run KV ops in async while rebalance is in progress")
json_generator = JsonGenerator()
generators = json_generator.generate_docs_simple(
docs_per_day=self.num_items, start=0)
tasks = self.bucket_util._async_load_all_buckets(
self.cluster.master, generators, "create", 0)
self.log.info("Run concurrent queries to simulate busy system")
statement = "select sleep(count(*),50000) from {0} where mutated=0;".format(
self.cbas_dataset_name)
handles = self.cbas_util._run_concurrent_queries(
statement, self.mode, self.num_concurrent_queries)
self.log.info("Rebalance in CBAS nodes")
self.cluster_util.add_node(node=self.rebalanceServers[1],
services=node_services,
rebalance=False,
wait_for_rebalance_completion=False)
self.cluster_util.add_node(node=self.rebalanceServers[3],
services=node_services,
rebalance=True,
wait_for_rebalance_completion=True)
self.log.info("Get KV ops result")
for task in tasks:
task.get_result()
self.log.info("Log concurrent query status")
self.cbas_util.log_concurrent_query_outcome(self.cluster.master,
handles)
if not self.cbas_util.validate_cbas_dataset_items_count(
self.cbas_dataset_name, self.num_items, 0):
self.fail(
"No. of items in CBAS dataset do not match that in the CB bucket"
)
def _start_load_gen(self, docs, bucket, num_executors):
cluster = CouchbaseCluster.create(self.servers[0].ip)
cluster.authenticate("Administrator", "password")
bucket = cluster.openBucket(bucket)
k = "rebalance"
v = {"value": "asd"}
docloaders = []
total_num_executors = num_executors
num_docs = docs / total_num_executors
load_gen_task_name = "Loadgen"
for i in xrange(total_num_executors):
task_name = "{0}_{1}".format(load_gen_task_name, i)
self.load_gen_tasks.append(
DocloaderTask(bucket, num_docs, i * num_docs, k, v, task_name))
for task in self.load_gen_tasks:
self.task_manager.add_new_task(task)
def _finish_load_gen(self):
for task in self.load_gen_tasks:
self.log.info(self.task_manager.get_task_result(task))
def test_rebalance_in_multiple_cbas_on_a_busy_system_jython(self):
services = []
services.append(self.input.param('service', "cbas"))
services.append(self.input.param('service', 'cbas'))
self.log.info("Setup CBAS")
self.setup_for_test(skip_data_loading=True)
self.log.info("Run KV ops in background")
num_executors = 9 // self.buckets.__len__()
for bucket in self.buckets:
self._start_load_gen(self.num_items, bucket.name, num_executors)
self.log.info("Run concurrent queries to simulate busy system")
statement = "select sleep(count(*),50000) from {0} where mutated=0;".format(
self.cbas_dataset_name)
handles = self.cbas_util._run_concurrent_queries(
statement, self.mode, self.num_concurrent_queries)
self.log.info("Rebalance in CBAS nodes")
nodes_in = [self.rebalanceServers[1], self.rebalanceServers[3]]
rebalance_task = rebalanceTask(self.servers[:2],
to_add=nodes_in,
to_remove=[],
services=services)
self.task_manager.add_new_task(rebalance_task)
rebalance_result = self.task_manager.get_task_result(rebalance_task)
self.log.info(rebalance_result)
self.log.info("Get KV ops result")
self._finish_load_gen()
self.log.info("Log concurrent query status")
self.cbas_util.log_concurrent_query_outcome(self.master, handles)
if not self.cbas_util.validate_cbas_dataset_items_count(
self.cbas_dataset_name, self.num_items, 0):
self.fail(
"No. of items in CBAS dataset do not match that in the CB bucket"
)
def test_rebalance_out_multiple_cbas_on_a_busy_system(self):
node_services = []
node_services.append(self.input.param('service', "cbas"))
self.log.info("Rebalance in CBAS nodes")
self.add_node(node=self.rebalanceServers[1], services=node_services)
self.add_node(node=self.rebalanceServers[3], services=node_services)
self.log.info("Setup CBAS")
self.setup_for_test(skip_data_loading=True)
self.log.info("Run KV ops in async while rebalance is in progress")
json_generator = JsonGenerator()
generators = json_generator.generate_docs_simple(
docs_per_day=self.num_items, start=0)
tasks = self._async_load_all_buckets(self.master, generators, "create",
0)
self.log.info("Run concurrent queries to simulate busy system")
statement = "select sleep(count(*),50000) from {0} where mutated=0;".format(
self.cbas_dataset_name)
handles = self.cbas_util._run_concurrent_queries(
statement, self.mode, self.num_concurrent_queries)
self.log.info("Fetch and remove nodes to rebalance out")
self.rebalance_cc = self.input.param("rebalance_cc", False)
out_nodes = []
nodes = self.rest.node_statuses()
if self.rebalance_cc:
for node in nodes:
if node.ip == self.cbas_node.ip or node.ip == self.servers[
1].ip:
out_nodes.append(node)
self.cbas_util.closeConn()
self.log.info(
"Reinitialize CBAS utils with ip %s, since CC node is rebalanced out"
% self.servers[3].ip)
self.cbas_util = cbas_utils(self.master, self.servers[3])
self.cbas_util.createConn("default")
else:
for node in nodes:
if node.ip == self.servers[3].ip or node.ip == self.servers[
1].ip:
out_nodes.append(node)
self.log.info("Rebalance out CBAS nodes %s %s" %
(out_nodes[0].ip, out_nodes[1].ip))
self.remove_all_nodes_then_rebalance([out_nodes[0], out_nodes[1]])
self.log.info("Get KV ops result")
for task in tasks:
task.get_result()
self.log.info("Log concurrent query status")
self.cbas_util.log_concurrent_query_outcome(self.master, handles)
if not self.cbas_util.validate_cbas_dataset_items_count(
self.cbas_dataset_name, self.num_items, 0):
self.fail(
"No. of items in CBAS dataset do not match that in the CB bucket"
)
'''
cbas.cbas_cluster_operations.CBASClusterOperations.test_rebalance_swap_multiple_cbas_on_a_busy_system,cb_bucket_name=default,cbas_bucket_name=default_bucket,cbas_dataset_name=default_ds,items=10,rebalance_cbas_and_kv=True,service=cbas,rebalance_cc=False
cbas.cbas_cluster_operations.CBASClusterOperations.test_rebalance_swap_multiple_cbas_on_a_busy_system,cb_bucket_name=default,cbas_bucket_name=default_bucket,cbas_dataset_name=default_ds,items=10,rebalance_cbas_and_kv=True,service=cbas,rebalance_cc=True
'''
def test_rebalance_swap_multiple_cbas_on_a_busy_system(self):
'''
1. We have 4 node cluster with 1 KV and 3 CBAS. Assume the IPS end with 101(KV), 102(CBAS), 103(CBAS), 104(CBAS)
2, Post initial setup - 101 running KV and 102 running CBAS as CC node
3. As part of test test add an extra NC node that we will swap rebalance later - Adding 103 and rebalance
4. If swap rebalance NC - then select the node added in #3 for remove and 104 to add during swap
5. If swap rebalance CC - then select the CC node added for remove and 104 to add during swap
'''
self.log.info('Read service input param')
node_services = []
node_services.append(self.input.param('service', "cbas"))
self.log.info(
"Rebalance in CBAS nodes, this node will be removed during swap")
self.add_node(node=self.rebalanceServers[1], services=node_services)
self.log.info("Setup CBAS")
self.setup_for_test(skip_data_loading=True)
self.log.info("Run KV ops in async while rebalance is in progress")
json_generator = JsonGenerator()
generators = json_generator.generate_docs_simple(
docs_per_day=self.num_items, start=0)
tasks = self._async_load_all_buckets(self.master, generators, "create",
0)
self.log.info("Run concurrent queries to simulate busy system")
statement = "select sleep(count(*),50000) from {0} where mutated=0;".format(
self.cbas_dataset_name)
handles = self.cbas_util._run_concurrent_queries(
statement, self.mode, self.num_concurrent_queries)
self.log.info("Fetch node to remove during rebalance")
self.rebalance_cc = self.input.param("rebalance_cc", False)
out_nodes = []
nodes = self.rest.node_statuses()
reinitialize_cbas_util = False
for node in nodes:
if self.rebalance_cc and (node.ip == self.cbas_node.ip):
out_nodes.append(node)
reinitialize_cbas_util = True
elif not self.rebalance_cc and node.ip == self.rebalanceServers[
1].ip:
out_nodes.append(node)
self.log.info("Swap rebalance CBAS nodes")
self.add_node(node=self.rebalanceServers[3],
services=node_services,
rebalance=False)
self.remove_node([out_nodes[0]], wait_for_rebalance=True)
self.log.info("Get KV ops result")
for task in tasks:
task.get_result()
if reinitialize_cbas_util is True:
self.cbas_util = cbas_utils(self.master, self.rebalanceServers[3])
self.cbas_util.createConn("default")
self.log.info("Log concurrent query status")
self.cbas_util.log_concurrent_query_outcome(self.master, handles)
if not self.cbas_util.validate_cbas_dataset_items_count(
self.cbas_dataset_name, self.num_items, 0):
self.fail(
"No. of items in CBAS dataset do not match that in the CB bucket"
)
'''
test_fail_over_node_followed_by_rebalance_out_or_add_back,cb_bucket_name=default,graceful_failover=True,cbas_bucket_name=default_cbas,cbas_dataset_name=default_ds,items=10000,nodeType=KV,rebalance_out=True,concurrent_batch_size=500
test_fail_over_node_followed_by_rebalance_out_or_add_back,cb_bucket_name=default,graceful_failover=True,cbas_bucket_name=default_cbas,cbas_dataset_name=default_ds,items=10000,nodeType=KV,rebalance_out=False,recovery_strategy=full,concurrent_batch_size=500
test_fail_over_node_followed_by_rebalance_out_or_add_back,cb_bucket_name=default,graceful_failover=True,cbas_bucket_name=default_cbas,cbas_dataset_name=default_ds,items=10000,nodeType=KV,rebalance_out=False,recovery_strategy=delta,concurrent_batch_size=500
test_fail_over_node_followed_by_rebalance_out_or_add_back,cb_bucket_name=default,graceful_failover=False,cbas_bucket_name=default_cbas,cbas_dataset_name=default_ds,items=10000,nodeType=KV,rebalance_out=True,concurrent_batch_size=500
test_fail_over_node_followed_by_rebalance_out_or_add_back,cb_bucket_name=default,graceful_failover=False,cbas_bucket_name=default_cbas,cbas_dataset_name=default_ds,items=10000,nodeType=KV,rebalance_out=False,recovery_strategy=full,concurrent_batch_size=500
test_fail_over_node_followed_by_rebalance_out_or_add_back,cb_bucket_name=default,graceful_failover=False,cbas_bucket_name=default_cbas,cbas_dataset_name=default_ds,items=10000,nodeType=KV,rebalance_out=False,recovery_strategy=delta,concurrent_batch_size=500
test_fail_over_node_followed_by_rebalance_out_or_add_back,cb_bucket_name=default,graceful_failover=False,cbas_bucket_name=default_cbas,cbas_dataset_name=default_ds,items=10000,nodeType=CBAS,rebalance_out=True,concurrent_batch_size=500
test_fail_over_node_followed_by_rebalance_out_or_add_back,cb_bucket_name=default,graceful_failover=False,cbas_bucket_name=default_cbas,cbas_dataset_name=default_ds,items=10000,nodeType=CBAS,rebalance_out=False,recovery_strategy=full,concurrent_batch_size=500
'''
def test_fail_over_node_followed_by_rebalance_out_or_add_back(self):
"""
1. Start with an initial setup, having 1 KV and 1 CBAS
2. Add a node that will be failed over - KV/CBAS
3. Create CBAS buckets and dataset
4. Fail over the KV node based in graceful_failover parameter specified
5. Rebalance out/add back based on input param specified in conf file
6. Perform doc operations
7. run concurrent queries
8. Verify document count on dataset post failover
"""
self.log.info("Add an extra node to fail-over")
self.add_node(node=self.rebalanceServers[1])
self.log.info("Read the failure out type to be performed")
graceful_failover = self.input.param("graceful_failover", True)
self.log.info("Set up test - Create cbas buckets and data-sets")
self.setup_for_test()
self.log.info("Perform Async doc operations on KV")
json_generator = JsonGenerator()
generators = json_generator.generate_docs_simple(
docs_per_day=self.num_items * 3 / 2, start=self.num_items)
kv_task = self._async_load_all_buckets(self.master, generators,
"create", 0)
self.log.info("Run concurrent queries on CBAS")
query = "select count(*) from {0};".format(self.cbas_dataset_name)
handles = self.cbas_util._run_concurrent_queries(
query,
"async",
self.num_concurrent_queries,
batch_size=self.concurrent_batch_size)
self.log.info("fail-over the node")
fail_task = self._cb_cluster.async_failover(self.input.servers,
[self.rebalanceServers[1]],
graceful_failover)
fail_task.get_result()
self.log.info(
"Read input param to decide on add back or rebalance out")
self.rebalance_out = self.input.param("rebalance_out", False)
if self.rebalance_out:
self.log.info("Rebalance out the fail-over node")
self.rebalance()
else:
self.recovery_strategy = self.input.param("recovery_strategy",
"full")
self.log.info("Performing %s recovery" % self.recovery_strategy)
success = False
end_time = datetime.datetime.now() + datetime.timedelta(
minutes=int(1))
while datetime.datetime.now() < end_time or not success:
try:
self.sleep(10, message="Wait for fail over complete")
self.rest.set_recovery_type(
'ns_1@' + self.rebalanceServers[1].ip,
self.recovery_strategy)
success = True
except Exception:
self.log.info(
"Fail over in progress. Re-try after 10 seconds.")
pass
if not success:
self.fail("Recovery %s failed." % self.recovery_strategy)
self.rest.add_back_node('ns_1@' + self.rebalanceServers[1].ip)
self.rebalance()
self.log.info("Get KV ops result")
for task in kv_task:
task.get_result()
self.log.info("Log concurrent query status")
self.cbas_util.log_concurrent_query_outcome(self.master, handles)
self.log.info("Validate dataset count on CBAS")
count_n1ql = self.rest.query_tool(
'select count(*) from `%s`' %
self.cb_bucket_name)['results'][0]['$1']
if not self.cbas_util.validate_cbas_dataset_items_count(
self.cbas_dataset_name,
count_n1ql,
0,
timeout=400,
analytics_timeout=400):
self.fail(
"No. of items in CBAS dataset do not match that in the CB bucket"
)
'''
test_to_fail_initial_rebalance_and_verify_subsequent_rebalance_succeeds,cb_bucket_name=default,cbas_bucket_name=default_bucket,cbas_dataset_name=default_ds,items=10,nodeType=CBAS,num_queries=10,restart_couchbase_on_incoming_or_outgoing_node=True,rebalance_type=in
test_to_fail_initial_rebalance_and_verify_subsequent_rebalance_succeeds,cb_bucket_name=default,cbas_bucket_name=default_bucket,cbas_dataset_name=default_ds,items=10,nodeType=CBAS,num_queries=10,restart_couchbase_on_incoming_or_outgoing_node=True,rebalance_type=out
test_to_fail_initial_rebalance_and_verify_subsequent_rebalance_succeeds,cb_bucket_name=default,cbas_bucket_name=default_bucket,cbas_dataset_name=default_ds,items=10,nodeType=CBAS,num_queries=10,restart_couchbase_on_incoming_or_outgoing_node=True,rebalance_type=swap
'''
def test_to_fail_initial_rebalance_and_verify_subsequent_rebalance_succeeds(
self):
self.log.info("Pick the incoming and outgoing nodes during rebalance")
self.rebalance_type = self.input.param("rebalance_type", "in")
nodes_to_add = [self.rebalanceServers[1]]
nodes_to_remove = []
reinitialize_cbas_util = False
if self.rebalance_type == 'out':
nodes_to_remove.append(self.rebalanceServers[1])
self.add_node(self.rebalanceServers[1])
nodes_to_add = []
elif self.rebalance_type == 'swap':
self.add_node(nodes_to_add[0], rebalance=False)
nodes_to_remove.append(self.cbas_node)
reinitialize_cbas_util = True
self.log.info(
"Incoming nodes - %s, outgoing nodes - %s. For rebalance type %s "
% (nodes_to_add, nodes_to_remove, self.rebalance_type))
self.log.info("Creates cbas buckets and dataset")
dataset_count_query = "select count(*) from {0};".format(
self.cbas_dataset_name)
self.setup_for_test()
self.log.info("Perform async doc operations on KV")
json_generator = JsonGenerator()
generators = json_generator.generate_docs_simple(
docs_per_day=self.num_items * 3 / 2, start=self.num_items)
kv_task = self._async_load_all_buckets(self.master,
generators,
"create",
0,
batch_size=5000)
self.log.info("Run concurrent queries on CBAS")
handles = self.cbas_util._run_concurrent_queries(
dataset_count_query, "async", self.num_concurrent_queries)
self.log.info("Fetch the server to restart couchbase on")
restart_couchbase_on_incoming_or_outgoing_node = self.input.param(
"restart_couchbase_on_incoming_or_outgoing_node", True)
if not restart_couchbase_on_incoming_or_outgoing_node:
node = self.cbas_node
else:
node = self.rebalanceServers[1]
shell = RemoteMachineShellConnection(node)
self.log.info("Rebalance nodes")
self.cluster.async_rebalance(self.servers, nodes_to_add,
nodes_to_remove)
self.log.info("Restart Couchbase on node %s" % node.ip)
shell.restart_couchbase()
self.sleep(30, message="Waiting for service to be back again...")
self.log.info("Verify subsequent rebalance is successful")
nodes_to_add = [
] # Node is already added to cluster in previous rebalance, adding it again will throw exception
self.assertTrue(
self.cluster.rebalance(self.servers, nodes_to_add,
nodes_to_remove))
self.log.info("Get KV ops result")
for task in kv_task:
task.get_result()
self.log.info("Log concurrent query status")
self.cbas_util.log_concurrent_query_outcome(self.master, handles)
if reinitialize_cbas_util is True:
self.cbas_util = cbas_utils(self.master, self.rebalanceServers[1])
self.cbas_util.createConn("default")
self.log.info("Validate dataset count on CBAS")
if not self.cbas_util.validate_cbas_dataset_items_count(
self.cbas_dataset_name, self.num_items * 3 / 2, 0):
self.fail(
"No. of items in CBAS dataset do not match that in the CB bucket"
)
'''
test_rebalance_on_nodes_running_multiple_services,cb_bucket_name=default,cbas_bucket_name=default_bucket,cbas_dataset_name=default_ds,items=10,nodeType=KV,num_queries=10,rebalance_type=in
test_rebalance_on_nodes_running_multiple_services,cb_bucket_name=default,cbas_bucket_name=default_bucket,cbas_dataset_name=default_ds,items=10,nodeType=KV,num_queries=10,rebalance_type=out
test_rebalance_on_nodes_running_multiple_services,cb_bucket_name=default,cbas_bucket_name=default_bucket,cbas_dataset_name=default_ds,items=10,num_queries=10,rebalance_type=swap,rebalance_cbas_and_kv=True
'''
def test_rebalance_on_nodes_running_multiple_services(self):
self.log.info("Pick the incoming and outgoing nodes during rebalance")
active_services = ['cbas,fts,kv']
self.rebalance_type = self.input.param("rebalance_type", "in")
nodes_to_add = [self.rebalanceServers[1]]
nodes_to_remove = []
if self.rebalance_type == 'out':
# This node will be rebalanced out
nodes_to_remove.append(self.rebalanceServers[1])
# Will be running services as specified in the list - active_services
self.add_node(nodes_to_add[0], services=active_services)
# No nodes to remove so making the add notes empty
nodes_to_add = []
elif self.rebalance_type == 'swap':
# Below node will be swapped with the incoming node specified in nodes_to_add
self.add_node(nodes_to_add[0], services=active_services)
nodes_to_add = []
nodes_to_add.append(self.rebalanceServers[3])
# Below node will be removed and swapped with node that was added earlier
nodes_to_remove.append(self.rebalanceServers[1])
self.log.info(
"Incoming nodes - %s, outgoing nodes - %s. For rebalance type %s "
% (nodes_to_add, nodes_to_remove, self.rebalance_type))
self.log.info("Creates cbas buckets and dataset")
dataset_count_query = "select count(*) from {0};".format(
self.cbas_dataset_name)
self.setup_for_test()
self.log.info("Perform async doc operations on KV")
json_generator = JsonGenerator()
generators = json_generator.generate_docs_simple(
docs_per_day=self.num_items * 3 / 2, start=self.num_items)
kv_task = self._async_load_all_buckets(self.master,
generators,
"create",
0,
batch_size=5000)
self.log.info("Run concurrent queries on CBAS")
handles = self.cbas_util._run_concurrent_queries(
dataset_count_query, "async", self.num_concurrent_queries)
self.log.info("Rebalance nodes")
# Do not add node to nodes_to_add if already added as add_node earlier
self.cluster.rebalance(self.servers,
nodes_to_add,
nodes_to_remove,
services=active_services)
self.log.info("Get KV ops result")
for task in kv_task:
task.get_result()
self.log.info("Log concurrent query status")
self.cbas_util.log_concurrent_query_outcome(self.master, handles)
self.log.info("Validate dataset count on CBAS")
if not self.cbas_util.validate_cbas_dataset_items_count(
self.cbas_dataset_name, self.num_items * 3 / 2, 0):
self.fail(
"No. of items in CBAS dataset do not match that in the CB bucket"
)
def tearDown(self):
super(CBASClusterOperations, self).tearDown()
class ApiClient(object):
"""Generic API client for Swagger client library builds.
Swagger generic API client. This client handles the client-
server communication, and is invariant across implementations. Specifics of
the methods and models for each application are generated from the Swagger
templates.
NOTE: This class is auto generated by the swagger code generator program.
Ref: https://github.com/swagger-api/swagger-codegen
Do not edit the class manually.
:param configuration: .Configuration object for this client
:param header_name: a header to pass when making calls to the API.
:param header_value: a header value to pass when making calls to
the API.
:param cookie: a cookie to include in the header when making calls
to the API
"""
PRIMITIVE_TYPES = (float, bool, bytes, six.text_type) + six.integer_types
NATIVE_TYPES_MAPPING = {
'int': int,
'long': int if six.PY3 else long, # noqa: F821
'float': float,
'str': str,
'bool': bool,
'date': datetime.date,
'datetime': datetime.datetime,
'object': object,
}
def __init__(self,
configuration=None,
header_name=None,
header_value=None,
cookie=None):
if configuration is None:
configuration = Configuration()
self.configuration = configuration
self.pool = TaskManager()
self.rest_client = rest.RESTClientObject(configuration)
self.default_headers = {}
if header_name is not None:
self.default_headers[header_name] = header_value
self.cookie = cookie
# Set default User-Agent.
self.user_agent = 'Swagger-Codegen/1.0.0/python'
def __del__(self):
self.pool.shutdown()
@property
def user_agent(self):
"""User agent for this API client"""
return self.default_headers['User-Agent']
@user_agent.setter
def user_agent(self, value):
self.default_headers['User-Agent'] = value
def set_default_header(self, header_name, header_value):
self.default_headers[header_name] = header_value
def __call_api(self,
resource_path,
method,
path_params=None,
query_params=None,
header_params=None,
body=None,
post_params=None,
files=None,
response_type=None,
auth_settings=None,
_return_http_data_only=None,
collection_formats=None,
_preload_content=True,
_request_timeout=None):
config = self.configuration
if not auth_settings:
auth_settings = config.auth_settings()
# header parameters
header_params = header_params or {}
header_params.update(self.default_headers)
if self.cookie:
header_params['Cookie'] = self.cookie
if header_params:
header_params = self.sanitize_for_serialization(header_params)
header_params = dict(
self.parameters_to_tuples(header_params, collection_formats))
# path parameters
if path_params:
path_params = self.sanitize_for_serialization(path_params)
path_params = self.parameters_to_tuples(path_params,
collection_formats)
for k, v in path_params:
# specified safe chars, encode everything
resource_path = resource_path.replace(
'{%s}' % k,
quote(str(v), safe=config.safe_chars_for_path_param))
# query parameters
if query_params:
query_params = self.sanitize_for_serialization(query_params)
query_params = self.parameters_to_tuples(query_params,
collection_formats)
# post parameters
if post_params or files:
post_params = self.prepare_post_parameters(post_params, files)
post_params = self.sanitize_for_serialization(post_params)
post_params = self.parameters_to_tuples(post_params,
collection_formats)
# auth setting
self.update_params_for_auth(header_params, query_params, auth_settings)
# body
if body:
body = self.sanitize_for_serialization(body)
# request url
url = self.configuration.host + resource_path
# perform request and return response
response_data = self.request(
method,
url,
query_params=query_params,
headers=header_params,
post_params=post_params,
body=body,
_preload_content=_preload_content,
_request_timeout=_request_timeout,
no_api_exception=_return_http_data_only is None)
self.last_response = response_data
return_data = response_data
if _preload_content:
# deserialize response data
if response_type:
return_data = self.deserialize(response_data, response_type)
else:
return_data = None
if _return_http_data_only:
return (return_data)
else:
return return_data, response_data.status, response_data.getheaders(
), response_data
def sanitize_for_serialization(self, obj):
"""Builds a JSON POST object.
If obj is None, return None.
If obj is str, int, long, float, bool, return directly.
If obj is datetime.datetime, datetime.date
convert to string in iso8601 format.
If obj is list, sanitize each element in the list.
If obj is dict, return the dict.
If obj is swagger model, return the properties dict.
:param obj: The data to serialize.
:return: The serialized form of data.
"""
if obj is None:
return None
elif isinstance(obj, self.PRIMITIVE_TYPES):
return obj
elif isinstance(obj, list):
return [
self.sanitize_for_serialization(sub_obj) for sub_obj in obj
]
elif isinstance(obj, tuple):
return tuple(
self.sanitize_for_serialization(sub_obj) for sub_obj in obj)
elif isinstance(obj, (datetime.datetime, datetime.date)):
return obj.isoformat()
if isinstance(obj, dict):
obj_dict = obj
else:
# Convert model obj to dict except
# attributes `swagger_types`, `attribute_map`
# and attributes which value is not None.
# Convert attribute name to json key in
# model definition for request.
obj_dict = {
obj.attribute_map[attr]: getattr(obj, attr)
for attr, _ in six.iteritems(obj.swagger_types)
if getattr(obj, attr) is not None
}
return {
key: self.sanitize_for_serialization(val)
for key, val in six.iteritems(obj_dict)
}
def deserialize(self, response, response_type):
"""Deserializes response into an object.
:param response: RESTResponse object to be deserialized.
:param response_type: class literal for
deserialized object, or string of class name.
:return: deserialized object.
"""
# handle file downloading
# save response body into a tmp file and return the instance
if response_type == "file":
return self.__deserialize_file(response)
# fetch data from response object
try:
data = json.loads(response.data)
except ValueError:
data = response.data
return self.__deserialize(data, response_type)
def __deserialize(self, data, klass):
"""Deserializes dict, list, str into an object.
:param data: dict, list or str.
:param klass: class literal, or string of class name.
:return: object.
"""
if data is None:
return None
if type(klass) == str:
if klass.startswith('list['):
sub_kls = re.match(r'list\[(.*)\]', klass).group(1)
return [
self.__deserialize(sub_data, sub_kls) for sub_data in data
]
if klass.startswith('dict('):
sub_kls = re.match(r'dict\(([^,]*), (.*)\)', klass).group(2)
return {
k: self.__deserialize(v, sub_kls)
for k, v in six.iteritems(data)
}
# convert str to class
if klass in self.NATIVE_TYPES_MAPPING:
klass = self.NATIVE_TYPES_MAPPING[klass]
else:
klass = getattr(backup_service_client.models, klass)
if klass in self.PRIMITIVE_TYPES:
return self.__deserialize_primitive(data, klass)
elif klass == object:
return self.__deserialize_object(data)
elif klass == datetime.date:
return self.__deserialize_date(data)
elif klass == datetime.datetime:
return self.__deserialize_datatime(data)
else:
return self.__deserialize_model(data, klass)
def call_api(self,
resource_path,
method,
path_params=None,
query_params=None,
header_params=None,
body=None,
post_params=None,
files=None,
response_type=None,
auth_settings=None,
async_req=None,
_return_http_data_only=None,
collection_formats=None,
_preload_content=True,
_request_timeout=None):
"""Makes the HTTP request (synchronous) and returns deserialized data.
To make an async request, set the async_req parameter.
:param resource_path: Path to method endpoint.
:param method: Method to call.
:param path_params: Path parameters in the url.
:param query_params: Query parameters in the url.
:param header_params: Header parameters to be
placed in the request header.
:param body: Request body.
:param post_params dict: Request post form parameters,
for `application/x-www-form-urlencoded`, `multipart/form-data`.
:param auth_settings list: Auth Settings names for the request.
:param response: Response data type.
:param files dict: key -> filename, value -> filepath,
for `multipart/form-data`.
:param async_req bool: execute request asynchronously
:param _return_http_data_only: response data without head status code
and headers
:param collection_formats: dict of collection formats for path, query,
header, and post parameters.
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return:
If async_req parameter is True,
the request will be called asynchronously.
The method will return the request thread.
If parameter async_req is False or missing,
then the method will return the response directly.
"""
args = (resource_path, method, path_params, query_params,
header_params, body, post_params, files, response_type,
auth_settings, _return_http_data_only, collection_formats,
_preload_content, _request_timeout)
if not async_req:
return self.__call_api(*args)
else:
function_call_task = FunctionCallTask(self.__call_api, args)
self.pool.add_new_task(function_call_task)
return AsyncResult(self.pool, function_call_task)
def request(self,
method,
url,
query_params=None,
headers=None,
post_params=None,
body=None,
_preload_content=True,
_request_timeout=None,
no_api_exception=False):
"""Makes the HTTP request using RESTClient."""
if method == "GET":
return self.rest_client.GET(url,
query_params=query_params,
_preload_content=_preload_content,
_request_timeout=_request_timeout,
headers=headers,
no_api_exception=no_api_exception)
elif method == "HEAD":
return self.rest_client.HEAD(url,
query_params=query_params,
_preload_content=_preload_content,
_request_timeout=_request_timeout,
headers=header,
no_api_exception=no_api_exception)
elif method == "OPTIONS":
return self.rest_client.OPTIONS(url,
query_params=query_params,
headers=headers,
post_params=post_params,
_preload_content=_preload_content,
_request_timeout=_request_timeout,
body=body,
no_api_exception=no_api_exception)
elif method == "POST":
return self.rest_client.POST(url,
query_params=query_params,
headers=headers,
post_params=post_params,
_preload_content=_preload_content,
_request_timeout=_request_timeout,
body=body,
no_api_exception=no_api_exception)
elif method == "PUT":
return self.rest_client.PUT(url,
query_params=query_params,
headers=headers,
post_params=post_params,
_preload_content=_preload_content,
_request_timeout=_request_timeout,
body=body,
no_api_exception=no_api_exception)
elif method == "PATCH":
return self.rest_client.PATCH(url,
query_params=query_params,
headers=headers,
post_params=post_params,
_preload_content=_preload_content,
_request_timeout=_request_timeout,
body=body,
no_api_exception=no_api_exception)
elif method == "DELETE":
return self.rest_client.DELETE(url,
query_params=query_params,
headers=headers,
_preload_content=_preload_content,
_request_timeout=_request_timeout,
body=body,
no_api_exception=no_api_exception)
else:
raise ValueError("http method must be `GET`, `HEAD`, `OPTIONS`,"
" `POST`, `PATCH`, `PUT` or `DELETE`.")
def parameters_to_tuples(self, params, collection_formats):
"""Get parameters as list of tuples, formatting collections.
:param params: Parameters as dict or list of two-tuples
:param dict collection_formats: Parameter collection formats
:return: Parameters as list of tuples, collections formatted
"""
new_params = []
if collection_formats is None:
collection_formats = {}
for k, v in six.iteritems(params) if isinstance(
params, dict) else params: # noqa: E501
if k in collection_formats:
collection_format = collection_formats[k]
if collection_format == 'multi':
new_params.extend((k, value) for value in v)
else:
if collection_format == 'ssv':
delimiter = ' '
elif collection_format == 'tsv':
delimiter = '\t'
elif collection_format == 'pipes':
delimiter = '|'
else: # csv is the default
delimiter = ','
new_params.append(
(k, delimiter.join(str(value) for value in v)))
else:
new_params.append((k, v))
return new_params
def prepare_post_parameters(self, post_params=None, files=None):
"""Builds form parameters.
:param post_params: Normal form parameters.
:param files: File parameters.
:return: Form parameters with files.
"""
params = []
if post_params:
params = post_params
if files:
for k, v in six.iteritems(files):
if not v:
continue
file_names = v if type(v) is list else [v]
for n in file_names:
with open(n, 'rb') as f:
filename = os.path.basename(f.name)
filedata = f.read()
mimetype = (mimetypes.guess_type(filename)[0]
or 'application/octet-stream')
params.append(
tuple([k, tuple([filename, filedata, mimetype])]))
return params
def select_header_accept(self, accepts):
"""Returns `Accept` based on an array of accepts provided.
:param accepts: List of headers.
:return: Accept (e.g. application/json).
"""
if not accepts:
return
accepts = [x.lower() for x in accepts]
if 'application/json' in accepts:
return 'application/json'
else:
return ', '.join(accepts)
def select_header_content_type(self, content_types):
"""Returns `Content-Type` based on an array of content_types provided.
:param content_types: List of content-types.
:return: Content-Type (e.g. application/json).
"""
if not content_types:
return 'application/json'
content_types = [x.lower() for x in content_types]
if 'application/json' in content_types or '*/*' in content_types:
return 'application/json'
else:
return content_types[0]
def update_params_for_auth(self, headers, querys, auth_settings):
"""Updates header and query params based on authentication setting.
:param headers: Header parameters dict to be updated.
:param querys: Query parameters tuple list to be updated.
:param auth_settings: Authentication setting identifiers list.
"""
if not auth_settings:
return
for auth in auth_settings:
auth_setting = self.configuration.auth_settings().get(auth)
if auth_setting:
if not auth_setting['value']:
continue
elif auth_setting['in'] == 'header':
headers[auth_setting['key']] = auth_setting['value']
elif auth_setting['in'] == 'query':
querys.append((auth_setting['key'], auth_setting['value']))
else:
raise ValueError(
'Authentication token must be in `query` or `header`')
def __deserialize_file(self, response):
"""Deserializes body to file
Saves response body into a file in a temporary folder,
using the filename from the `Content-Disposition` header if provided.
:param response: RESTResponse.
:return: file path.
"""
fd, path = tempfile.mkstemp(dir=self.configuration.temp_folder_path)
os.close(fd)
os.remove(path)
content_disposition = response.getheader("Content-Disposition")
if content_disposition:
filename = re.search(r'filename=[\'"]?([^\'"\s]+)[\'"]?',
content_disposition).group(1)
path = os.path.join(os.path.dirname(path), filename)
with open(path, "wb") as f:
f.write(response.data)
return path
def __deserialize_primitive(self, data, klass):
"""Deserializes string to primitive type.
:param data: str.
:param klass: class literal.
:return: int, long, float, str, bool.
"""
try:
return klass(data)
except UnicodeEncodeError:
return six.text_type(data)
except TypeError:
return data
def __deserialize_object(self, value):
"""Return a original value.
:return: object.
"""
return value
def __deserialize_date(self, string):
"""Deserializes string to date.
:param string: str.
:return: date.
"""
try:
from dateutil.parser import parse
return parse(string).date()
except ImportError:
return string
except ValueError:
raise rest.ApiException(
status=0,
reason="Failed to parse `{0}` as date object".format(string))
def __deserialize_datatime(self, string):
"""Deserializes string to datetime.
The string should be in iso8601 datetime format.
:param string: str.
:return: datetime.
"""
try:
from dateutil.parser import parse
return parse(string)
except ImportError:
return string
except ValueError:
raise rest.ApiException(
status=0,
reason=(
"Failed to parse `{0}` as datetime object".format(string)))
def __hasattr(self, object, name):
return name in object.__class__.__dict__
def __deserialize_model(self, data, klass):
"""Deserializes list or dict to model.
:param data: dict, list.
:param klass: class literal.
:return: model object.
"""
if not klass.swagger_types and not self.__hasattr(
klass, 'get_real_child_model'):
return data
kwargs = {}
if klass.swagger_types is not None:
for attr, attr_type in six.iteritems(klass.swagger_types):
if (data is not None and klass.attribute_map[attr] in data
and isinstance(data, (list, dict))):
value = data[klass.attribute_map[attr]]
kwargs[attr] = self.__deserialize(value, attr_type)
instance = klass(**kwargs)
if (isinstance(instance, dict) and klass.swagger_types is not None
and isinstance(data, dict)):
for key, value in data.items():
if key not in klass.swagger_types:
instance[key] = value
if self.__hasattr(instance, 'get_real_child_model'):
klass_name = instance.get_real_child_model(data)
if klass_name:
instance = self.__deserialize(data, klass_name)
return instance