Remove neoFS from comments and __doc__

Signed-off-by: Aleksei Chetaev <alex.chetaev@gmail.com>
support/v0.36
Aleksei Chetaev 2023-02-16 15:50:09 +01:00 committed by Julia Kovshova
parent adb06aa158
commit ad8fd930c8
5 changed files with 10 additions and 10 deletions

View File

@ -30,7 +30,7 @@ get_reporter().configure({ "handlers": [{"plugin_name": "allure"}] })
```
### Hosting Configuration
Hosting component is a class that represents infrastructure (machines/containers/services) where neoFS is hosted. Interaction with specific infrastructure instance (host) is encapsulated in classes that implement interface `frostfs_testlib.hosting.Host`. To pass information about hosts to the `Hosting` class in runtime we use method `configure`:
Hosting component is a class that represents infrastructure (machines/containers/services) where frostFS is hosted. Interaction with specific infrastructure instance (host) is encapsulated in classes that implement interface `frostfs_testlib.hosting.Host`. To pass information about hosts to the `Hosting` class in runtime we use method `configure`:
```python
from frostfs_testlib.hosting import Hosting
@ -84,8 +84,8 @@ Detailed information about registering entrypoints can be found at [setuptools d
## Library structure
The library provides the following primary components:
* `blockchain` - Contains helpers that allow to interact with neo blockchain, smart contracts, gas transfers, etc.
* `cli` - wrappers on top of neoFS command-line tools. These wrappers execute on a shell and provide type-safe interface for interacting with the tools.
* `hosting` - management of infrastructure (docker, virtual machines, services where neoFS is hosted). The library provides host implementation for docker environment (when neoFS services are running as docker containers). Support for other hosts is provided via plugins.
* `cli` - wrappers on top of frostFS command-line tools. These wrappers execute on a shell and provide type-safe interface for interacting with the tools.
* `hosting` - management of infrastructure (docker, virtual machines, services where frostFS is hosted). The library provides host implementation for docker environment (when neoFS services are running as docker containers). Support for other hosts is provided via plugins.
* `reporter` - abstraction on top of test reporting tool like Allure. Components of the library will report their steps and attach artifacts to the configured reporter instance.
* `shell` - shells that can be used to execute commands. Currently library provides local shell (on machine that runs the code) or SSH shell that connects to a remote machine via SSH.
* `utils` - Support functions.

View File

@ -33,7 +33,7 @@ class CLIConfig:
@dataclass
class ServiceConfig:
"""Describes neoFS service on some host.
"""Describes frostFS service on some host.
Attributes:
name: Name of the service that uniquely identifies it across all hosts.
@ -48,7 +48,7 @@ class ServiceConfig:
@dataclass
class HostConfig:
"""Describes machine that hosts neoFS services.
"""Describes machine that hosts frostFS services.
Attributes:
plugin_name: Name of plugin that should be used to manage the host.

View File

@ -20,11 +20,11 @@ logger = logging.getLogger("frostfs.testlib.hosting")
@dataclass
class HostAttributes(ParsedAttributes):
"""Represents attributes of host where Docker with neoFS runs.
"""Represents attributes of host where Docker with frostFS runs.
Attributes:
sudo_shell: Specifies whether shell commands should be auto-prefixed with sudo.
docker_endpoint: Protocol, address and port of docker where neoFS runs. Recommended format
docker_endpoint: Protocol, address and port of docker where frostFS runs. Recommended format
is tcp socket (https://docs.docker.com/engine/reference/commandline/dockerd/#daemon-socket-option),
for example: tcp://{address}:2375 (where 2375 is default docker port).
ssh_login: Login for SSH connection to the machine where docker runs.

View File

@ -7,7 +7,7 @@ from frostfs_testlib.plugins import load_plugin
class Hosting:
"""Hosting manages infrastructure where neoFS runs (machines and neoFS services)."""
"""Hosting manages infrastructure where frostFS runs (machines and frostFS services)."""
_hosts: list[Host]
_host_by_address: dict[str, Host]

View File

@ -11,9 +11,9 @@ class DiskInfo(dict):
class Host(ABC):
"""Interface of a host machine where neoFS services are running.
"""Interface of a host machine where frostFS services are running.
Allows to manage the machine and neoFS services that are hosted on it.
Allows to manage the machine and frostFS services that are hosted on it.
"""
def __init__(self, config: HostConfig) -> None: