utils.cpp

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

#include "server/utils.h"

#include <iostream>
#include <thread>
#include <string>
#include <boost/filesystem.hpp>

namespace {

static const char *VALID_CONFIG_STR = "# Default values are used when you make no changes to the following parameters.\n"
                                      "\n"
                                      "server_config:\n"
                                      "  address: 0.0.0.0                  # milvus server ip address (IPv4)\n"
                                      "  port: 19530                       # port range: 1025 ~ 65534\n"
                                      "  deploy_mode: single               # deployment type: single, cluster_readonly, cluster_writable\n"
                                      "  time_zone: UTC+8\n"
                                      "\n"
                                      "db_config:\n"
                                      "  primary_path: /tmp/milvus    # path used to store data and meta\n"
                                      "  secondary_path:                   # path used to store data only, split by semicolon\n"
                                      "\n"
                                      "  backend_url: sqlite://:@:/        # URI format: dialect://username:password@host:port/database\n"
                                      "                                    # Keep 'dialect://:@:/', and replace other texts with real values\n"
                                      "                                    # Replace 'dialect' with 'mysql' or 'sqlite'\n"
                                      "\n"
                                      "  insert_buffer_size: 4             # GB, maximum insert buffer size allowed\n"
                                      "                                    # sum of insert_buffer_size and cpu_cache_capacity cannot exceed total memory\n"
                                      "\n"
                                      "  preload_table:                    # preload data at startup, '*' means load all tables, empty value means no preload\n"
                                      "                                    # you can specify preload tables like this: table1,table2,table3\n"
                                      "\n"
                                      "metric_config:\n"
                                      "  enable_monitor: false             # enable monitoring or not\n"
                                      "  collector: prometheus             # prometheus\n"
                                      "  prometheus_config:\n"
                                      "    port: 8080                      # port prometheus uses to fetch metrics\n"
                                      "\n"
                                      "cache_config:\n"
                                      "  cpu_cache_capacity: 16            # GB, CPU memory used for cache\n"
                                      "  cpu_cache_threshold: 0.85         # percentage of data that will be kept when cache cleanup is triggered\n"
                                      "  gpu_cache_capacity: 4             # GB, GPU memory used for cache\n"
                                      "  gpu_cache_threshold: 0.85         # percentage of data that will be kept when cache cleanup is triggered\n"
                                      "  cache_insert_data: false          # whether to load inserted data into cache\n"
                                      "\n"
                                      "engine_config:\n"
                                      "  use_blas_threshold: 20            # if nq <  use_blas_threshold, use SSE, faster with fluctuated response times\n"
                                      "                                    # if nq >= use_blas_threshold, use OpenBlas, slower with stable response times\n"
                                      "\n"
                                      "resource_config:\n"
                                      "  search_resources:                 # define the GPUs used for search computation, valid value: gpux\n"
                                      "    - gpu0\n"
                                      "  index_build_device: gpu0          # GPU used for building index";

static const char *INVALID_CONFIG_STR = "*INVALID*";

void WriteToFile(const char* file_path, const char *content) {
    boost::filesystem::path fpath(file_path);
    boost::filesystem::fstream fstream(fpath, std::ios_base::out);

    //write data to file
    fstream << content;
    fstream.close();
}

} // namespace


void ConfigTest::SetUp() {
    WriteToFile(VALID_CONFIG_PATH, VALID_CONFIG_STR);
    WriteToFile(INVALID_CONFIG_PATH, INVALID_CONFIG_STR);
}

void ConfigTest::TearDown() {
    boost::filesystem::remove(VALID_CONFIG_PATH);
    boost::filesystem::remove(INVALID_CONFIG_PATH);
}