distcloud/distributedcloud/dcdbsync/api/api_config.py

# Copyright 2015 Huawei Technologies Co., Ltd.
# All Rights Reserved.
#
#    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.
#
# Copyright (c) 2019, 2024 Wind River Systems, Inc.
#
# SPDX-License-Identifier: Apache-2.0
#

"""
Routines for configuring DC DBsync Agent, largely copy from Neutron
"""

import os
import sys


from oslo_config import cfg
from oslo_log import log as logging

from dcdbsync.common.i18n import _


# from dcdbsync import policy
from dcdbsync.common import version

LOG = logging.getLogger(__name__)

common_opts = [
    cfg.StrOpt("bind_host", default="0.0.0.0", help=_("The host IP to bind to")),
    cfg.IntOpt("bind_port", default=8119, help=_("The port to bind to")),
    cfg.IntOpt("api_workers", default=2, help=_("number of api workers")),
    cfg.StrOpt(
        "state_path",
        default=os.path.join(os.path.dirname(__file__), "../"),
        help="Top-level directory for maintaining dcdbsync state",
    ),
    cfg.StrOpt(
        "api_extensions_path", default="", help=_("The path for API extensions")
    ),
    cfg.StrOpt(
        "auth_strategy", default="keystone", help=_("The type of authentication to use")
    ),
    cfg.BoolOpt("allow_bulk", default=True, help=_("Allow the usage of the bulk API")),
    cfg.BoolOpt(
        "allow_pagination", default=False, help=_("Allow the usage of the pagination")
    ),
    cfg.BoolOpt(
        "allow_sorting", default=False, help=_("Allow the usage of the sorting")
    ),
    cfg.StrOpt(
        "pagination_max_limit",
        default="-1",
        help=_(
            "The maximum number of items returned in a single "
            "response, value was 'infinite' or negative integer "
            "means no limit"
        ),
    ),
]


def init(args, **kwargs):
    # Register the configuration options
    cfg.CONF.register_opts(common_opts)

    # ks_session.Session.register_conf_options(cfg.CONF)
    # auth.register_conf_options(cfg.CONF)
    logging.register_options(cfg.CONF)

    cfg.CONF(
        args=args,
        project="dcdbsync",
        version="%%(prog)s %s" % version.version_info.release_string(),
        **kwargs
    )


def setup_logging():
    """Sets up the logging options for a log with supplied name."""
    product_name = "dcdbsync"
    logging.setup(cfg.CONF, product_name)
    LOG.info("Logging enabled!")
    LOG.info(
        "%(prog)s version %(version)s",
        {"prog": sys.argv[0], "version": version.version_info.release_string()},
    )
    LOG.debug("command line: %s", " ".join(sys.argv))


def reset_service():
    # Reset worker in case SIGHUP is called.
    # Note that this is called only in case a service is running in
    # daemon mode.
    setup_logging()

    # TODO(joehuang) enforce policy later
    # policy.refresh()


def test_init():
    # Register the configuration options
    cfg.CONF.register_opts(common_opts)
    logging.register_options(cfg.CONF)
    setup_logging()


def list_opts():
    yield None, common_opts