Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

vdk-control-cli: Rename namespaces #238

Merged
merged 11 commits into from
Sep 16, 2021
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion projects/vdk-control-cli/.gitlab-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ vdk-control-cli-release:
- cd projects/vdk-control-cli
script:
- echo "$(cat version.txt | grep -o '[0-9]\.[0-9]').$CI_PIPELINE_ID" > version.txt
- build_info_file="src/taurus/vdk/control/vdk_control_build_info.py"
- build_info_file="src/vdk/internal/control/vdk_control_build_info.py"
- echo "" > $build_info_file # clear build info file first
- echo "RELEASE_VERSION='$(cat version.txt)'" >> $build_info_file
- echo "GIT_COMMIT_SHA='$CI_COMMIT_SHA'" >> $build_info_file
Expand Down
2 changes: 1 addition & 1 deletion projects/vdk-control-cli/MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
include src/taurus/vdk/control/job/sample_job/*
include src/vdk/internal/control/job/sample_job/*
include version.txt

# this only work for source distribution (setup.py sdist) and not for binary distribution (bdist)
Expand Down
4 changes: 2 additions & 2 deletions projects/vdk-control-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,15 +52,15 @@ If a plugin is installed, vdk automatically finds and integrates it.
A plugin is python module that enhances or changes the behaviour of the vdk cli. <br>
A plugin contains one or multiple hook functions.

See all supported hook function specifications that can be implemented in [specs.py](src/taurus/vdk/api/plugin/specs.py)
See all supported hook function specifications that can be implemented in [specs.py](src/vdk/api/control/plugin/specs.py)

In order to create a new plugin there are only 2 steps:<br>

* Create your implementation of the plugin's hook(s):
```python
# define hookimpl as follows (library requirement: pluggy)
hookimpl = pluggy.HookimplMarker("vdk_control_cli.plugin")
# though it's better to use `taurus.vdk.plugin.markers.hookimpl` from vdk-control-cli python package
# though it's better to use `vdk.internal.control.plugin.markers.hookimpl` from vdk-control-cli python package

# name of function must match name of hookspec function
@hookimpl
Expand Down
2 changes: 1 addition & 1 deletion projects/vdk-control-cli/setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ exclude =

[options.entry_points]
console_scripts =
vdkcli = taurus.vdk.control.main:run
vdkcli = vdk.internal.control.main:run

[test]
# py.test options when running `python setup.py test`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Hook Implementation need to be marked with @hookimpl decorator and have the same name.
"""
from taurus.vdk.api.plugin.markers import hookspec
from vdk.api.control.plugin.markers import hookspec


class CliHookSpecs:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@
from requests import post
from requests.auth import HTTPBasicAuth
from requests_oauthlib import OAuth2Session
from taurus.vdk.control.auth.auth_request_values import AuthRequestValues
from taurus.vdk.control.auth.login_types import LoginTypes
from taurus.vdk.control.configuration.vdk_config import VDKConfigFolder
from taurus.vdk.control.exception.vdk_exception import VDKException
from vdk.internal.control.auth.auth_request_values import AuthRequestValues
from vdk.internal.control.auth.login_types import LoginTypes
from vdk.internal.control.configuration.vdk_config import VDKConfigFolder
from vdk.internal.control.exception.vdk_exception import VDKException

log = logging.getLogger(__name__)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@
from requests import post
from requests.auth import HTTPBasicAuth
from requests_oauthlib import OAuth2Session
from taurus.vdk.control.auth.auth import Authentication
from taurus.vdk.control.auth.auth_pkce import AuthPkce
from taurus.vdk.control.auth.auth_request_values import AuthRequestValues
from taurus.vdk.control.auth.login_types import LoginTypes
from taurus.vdk.control.exception.vdk_exception import VDKException
from vdk.internal.control.auth.auth import Authentication
from vdk.internal.control.auth.auth_pkce import AuthPkce
from vdk.internal.control.auth.auth_request_values import AuthRequestValues
from vdk.internal.control.auth.login_types import LoginTypes
from vdk.internal.control.exception.vdk_exception import VDKException

log = logging.getLogger(__name__)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
# Copyright 2021 VMware, Inc.
# SPDX-License-Identifier: Apache-2.0
import click
from taurus.vdk.control.configuration.defaults_config import reset_default_rest_api_url
from taurus.vdk.control.configuration.defaults_config import reset_default_team_name
from taurus.vdk.control.configuration.defaults_config import write_default_rest_api_url
from taurus.vdk.control.configuration.defaults_config import write_default_team_name
from vdk.internal.control.configuration.defaults_config import (
reset_default_rest_api_url,
)
from vdk.internal.control.configuration.defaults_config import reset_default_team_name
from vdk.internal.control.configuration.defaults_config import (
write_default_rest_api_url,
)
from vdk.internal.control.configuration.defaults_config import write_default_team_name

# Default command implies parity for set-default and reset-default sections bellow.
# Each option that supports set-default is expected to implement reset-default.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,18 @@
from typing import Tuple

import click
from taurus.vdk.control.command_groups.job.download_key import JobDownloadKey
from taurus.vdk.control.configuration.defaults_config import load_default_team_name
from taurus.vdk.control.configuration.vdk_config import VDKConfig
from taurus.vdk.control.exception.vdk_exception import VDKException
from taurus.vdk.control.job.job_config import JobConfig
from taurus.vdk.control.rest_lib.factory import ApiClientFactory
from taurus.vdk.control.rest_lib.rest_client_errors import ApiClientErrorDecorator
from taurus.vdk.control.utils import cli_utils
from taurus_datajob_api import ApiException
from taurus_datajob_api import DataJob
from taurus_datajob_api import DataJobConfig
from taurus_datajob_api import DataJobSchedule
from vdk.internal.control.command_groups.job.download_key import JobDownloadKey
from vdk.internal.control.configuration.defaults_config import load_default_team_name
from vdk.internal.control.configuration.vdk_config import VDKConfig
from vdk.internal.control.exception.vdk_exception import VDKException
from vdk.internal.control.job.job_config import JobConfig
from vdk.internal.control.rest_lib.factory import ApiClientFactory
from vdk.internal.control.rest_lib.rest_client_errors import ApiClientErrorDecorator
from vdk.internal.control.utils import cli_utils

log = logging.getLogger(__name__)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
import logging

import click
from taurus.vdk.control.configuration.defaults_config import load_default_team_name
from taurus.vdk.control.rest_lib.factory import ApiClientFactory
from taurus.vdk.control.rest_lib.rest_client_errors import ApiClientErrorDecorator
from taurus.vdk.control.utils import cli_utils
from vdk.internal.control.configuration.defaults_config import load_default_team_name
from vdk.internal.control.rest_lib.factory import ApiClientFactory
from vdk.internal.control.rest_lib.rest_client_errors import ApiClientErrorDecorator
from vdk.internal.control.utils import cli_utils

log = logging.getLogger(__name__)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
from enum import unique

import click
from taurus.vdk.control.command_groups.job.deploy_cli_impl import JobDeploy
from taurus.vdk.control.configuration.defaults_config import load_default_team_name
from taurus.vdk.control.utils import cli_utils
from taurus.vdk.control.utils.cli_utils import get_or_prompt
from vdk.internal.control.command_groups.job.deploy_cli_impl import JobDeploy
from vdk.internal.control.configuration.defaults_config import load_default_team_name
from vdk.internal.control.utils import cli_utils
from vdk.internal.control.utils.cli_utils import get_or_prompt


@unique
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,21 @@
import click
import click_spinner
from tabulate import tabulate
from taurus.vdk.control.configuration.defaults_config import load_default_team_name
from taurus.vdk.control.exception.vdk_exception import VDKException
from taurus.vdk.control.job.job_archive import JobArchive
from taurus.vdk.control.job.job_config import JobConfig
from taurus.vdk.control.rest_lib.factory import ApiClientFactory
from taurus.vdk.control.rest_lib.rest_client_errors import ApiClientErrorDecorator
from taurus.vdk.control.utils.cli_utils import get_or_prompt
from taurus.vdk.control.utils.cli_utils import OutputFormat
from taurus_datajob_api import ApiException
from taurus_datajob_api import DataJob
from taurus_datajob_api import DataJobConfig
from taurus_datajob_api import DataJobContacts
from taurus_datajob_api import DataJobDeployment
from taurus_datajob_api import DataJobSchedule
from taurus_datajob_api import Enable
from vdk.internal.control.configuration.defaults_config import load_default_team_name
from vdk.internal.control.exception.vdk_exception import VDKException
from vdk.internal.control.job.job_archive import JobArchive
from vdk.internal.control.job.job_config import JobConfig
from vdk.internal.control.rest_lib.factory import ApiClientFactory
from vdk.internal.control.rest_lib.rest_client_errors import ApiClientErrorDecorator
from vdk.internal.control.utils.cli_utils import get_or_prompt
from vdk.internal.control.utils.cli_utils import OutputFormat

log = logging.getLogger(__name__)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@

import click
import click_spinner
from taurus.vdk.control.configuration.defaults_config import load_default_team_name
from taurus.vdk.control.exception.vdk_exception import VDKException
from taurus.vdk.control.job.job_archive import JobArchive
from taurus.vdk.control.rest_lib.factory import ApiClientFactory
from taurus.vdk.control.rest_lib.rest_client_errors import ApiClientErrorDecorator
from taurus.vdk.control.utils import cli_utils
from vdk.internal.control.configuration.defaults_config import load_default_team_name
from vdk.internal.control.exception.vdk_exception import VDKException
from vdk.internal.control.job.job_archive import JobArchive
from vdk.internal.control.rest_lib.factory import ApiClientFactory
from vdk.internal.control.rest_lib.rest_client_errors import ApiClientErrorDecorator
from vdk.internal.control.utils import cli_utils

log = logging.getLogger(__name__)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
import os

import click
from taurus.vdk.control.configuration.defaults_config import load_default_team_name
from taurus.vdk.control.rest_lib.factory import ApiClientFactory
from taurus.vdk.control.rest_lib.rest_client_errors import ApiClientErrorDecorator
from taurus.vdk.control.utils import cli_utils
from vdk.internal.control.configuration.defaults_config import load_default_team_name
from vdk.internal.control.rest_lib.factory import ApiClientFactory
from vdk.internal.control.rest_lib.rest_client_errors import ApiClientErrorDecorator
from vdk.internal.control.utils import cli_utils

log = logging.getLogger(__name__)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@

import click
from tabulate import tabulate
from taurus.vdk.control.configuration.defaults_config import load_default_team_name
from taurus.vdk.control.rest_lib.factory import ApiClientFactory
from taurus.vdk.control.rest_lib.rest_client_errors import ApiClientErrorDecorator
from taurus.vdk.control.utils import cli_utils
from taurus.vdk.control.utils.cli_utils import get_or_prompt
from taurus.vdk.control.utils.cli_utils import OutputFormat
from taurus_datajob_api import DataJobExecution
from taurus_datajob_api import DataJobExecutionRequest
from vdk.internal.control.configuration.defaults_config import load_default_team_name
from vdk.internal.control.rest_lib.factory import ApiClientFactory
from vdk.internal.control.rest_lib.rest_client_errors import ApiClientErrorDecorator
from vdk.internal.control.utils import cli_utils
from vdk.internal.control.utils.cli_utils import get_or_prompt
from vdk.internal.control.utils.cli_utils import OutputFormat

log = logging.getLogger(__name__)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@

import click
from tabulate import tabulate
from taurus.vdk.control.configuration.defaults_config import load_default_team_name
from taurus.vdk.control.rest_lib.factory import ApiClientFactory
from taurus.vdk.control.rest_lib.rest_client_errors import ApiClientErrorDecorator
from taurus.vdk.control.utils import cli_utils
from taurus.vdk.control.utils.cli_utils import GqlQueryBuilder
from taurus.vdk.control.utils.cli_utils import OutputFormat
from taurus_datajob_api import DataJobQueryResponse
from vdk.internal.control.configuration.defaults_config import load_default_team_name
from vdk.internal.control.rest_lib.factory import ApiClientFactory
from vdk.internal.control.rest_lib.rest_client_errors import ApiClientErrorDecorator
from vdk.internal.control.utils import cli_utils
from vdk.internal.control.utils.cli_utils import GqlQueryBuilder
from vdk.internal.control.utils.cli_utils import OutputFormat

log = logging.getLogger(__name__)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@

import click
from tabulate import tabulate
from taurus.vdk.control.configuration.defaults_config import load_default_team_name
from taurus.vdk.control.exception.vdk_exception import VDKException
from taurus.vdk.control.rest_lib.factory import ApiClientFactory
from taurus.vdk.control.rest_lib.rest_client_errors import ApiClientErrorDecorator
from taurus.vdk.control.utils import cli_utils
from taurus.vdk.control.utils.cli_utils import OutputFormat
from vdk.internal.control.configuration.defaults_config import load_default_team_name
from vdk.internal.control.exception.vdk_exception import VDKException
from vdk.internal.control.rest_lib.factory import ApiClientFactory
from vdk.internal.control.rest_lib.rest_client_errors import ApiClientErrorDecorator
from vdk.internal.control.utils import cli_utils
from vdk.internal.control.utils.cli_utils import OutputFormat

log = logging.getLogger(__name__)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@
from typing import List

import click
from taurus.vdk.control.configuration.defaults_config import load_default_team_name
from taurus.vdk.control.exception.vdk_exception import VDKException
from taurus.vdk.control.rest_lib.factory import ApiClientFactory
from taurus.vdk.control.rest_lib.rest_client_errors import ApiClientErrorDecorator
from taurus.vdk.control.utils import cli_utils
from taurus.vdk.control.utils.cli_utils import OutputFormat
from taurus_datajob_api import ApiException
from taurus_datajob_api import DataJob
from taurus_datajob_api import DataJobDeploymentStatus
from taurus_datajob_api import DataJobExecution
from vdk.internal.control.configuration.defaults_config import load_default_team_name
from vdk.internal.control.exception.vdk_exception import VDKException
from vdk.internal.control.rest_lib.factory import ApiClientFactory
from vdk.internal.control.rest_lib.rest_client_errors import ApiClientErrorDecorator
from vdk.internal.control.utils import cli_utils
from vdk.internal.control.utils.cli_utils import OutputFormat

log = logging.getLogger(__name__)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Copyright 2021 VMware, Inc.
# SPDX-License-Identifier: Apache-2.0
import click
from taurus.vdk.control.auth.auth import Authentication
from taurus.vdk.control.auth.login_types import LoginTypes
from taurus.vdk.control.auth.redirect_auth import RedirectAuthentication
from taurus.vdk.control.exception.vdk_exception import VDKException
from taurus.vdk.control.utils import cli_utils
from taurus.vdk.control.utils.cli_utils import extended_option
from vdk.internal.control.auth.auth import Authentication
from vdk.internal.control.auth.login_types import LoginTypes
from vdk.internal.control.auth.redirect_auth import RedirectAuthentication
from vdk.internal.control.exception.vdk_exception import VDKException
from vdk.internal.control.utils import cli_utils
from vdk.internal.control.utils.cli_utils import extended_option


@click.command(
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Copyright 2021 VMware, Inc.
# SPDX-License-Identifier: Apache-2.0
import click
from taurus.vdk.control.configuration.vdk_config import VDKConfigFolder
from vdk.internal.control.configuration.vdk_config import VDKConfigFolder


@click.command(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

def build_details():
try:
from taurus.vdk.control import vdk_control_build_info
from vdk.internal.control import vdk_control_build_info

build = [
f"{key}={value}"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# SPDX-License-Identifier: Apache-2.0
import logging

from taurus.vdk.plugin.control_plugin_manager import Plugins
from vdk.internal.control.plugin.control_plugin_manager import Plugins

log = logging.getLogger(__name__)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Copyright 2021 VMware, Inc.
# SPDX-License-Identifier: Apache-2.0
from taurus.vdk.control.configuration.vdk_config import VDKConfigFolder
from vdk.internal.control.configuration.vdk_config import VDKConfigFolder

TEAM_OPTION = "team-name"
REST_API_URL_OPTION = "rest-api-url"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
from configparser import ConfigParser
from pathlib import Path

from taurus.vdk.control.exception.vdk_exception import VDKException
from vdk.internal.control.exception.vdk_exception import VDKException

log = logging.getLogger(__name__)

Expand All @@ -27,7 +27,7 @@ def op_id(self) -> str:

One simplistic example of how it can be used - we can see from logs of
vdk the op id (fa89cca9c6f146cd)
`2021-02-14 10:15:21,97710.0 [DEBUG] taurus.vdk vdk_config:88
`2021-02-14 10:15:21,97710.0 [DEBUG] vdk.internal vdk_config:88
read_credentials[OpId:fa89cca9c6f146cd]- Reading vdk credential ...`

And then we can search in logs of control service
Expand Down Expand Up @@ -120,9 +120,9 @@ def http_verify_ssl(self) -> bool:
def get_sample_job_directory(self) -> str:
sample_job_dir = os.getenv("VDK_CONTROL_SAMPLE_JOB_DIRECTORY", None)
if not sample_job_dir:
import taurus.vdk.control.job.sample_job
import vdk.internal.control.job.sample_job

template_module_path = taurus.vdk.control.job.sample_job.__path__._path[0]
template_module_path = vdk.internal.control.job.sample_job.__path__._path[0]
sample_job_dir = os.path.abspath(template_module_path)
return sample_job_dir

Expand All @@ -134,7 +134,7 @@ class VDKConfigFolder:
"""

# TODO: this looks robust: https://github.com/ActiveState/appdirs
CONFIG_FOLDER_NAME = ".taurus.vdk"
CONFIG_FOLDER_NAME = ".vdk.internal"
CREDENTIALS_FILE = "vdk-cred.json"
CONFIGURATION_FILE = "vdk-configuration.ini"

Expand Down
Loading