Find better and unique names for all occurrences of "test"

[tkilias]

A review finding of PR #194 was the word "test" being used too often in many places of the ITDE, its documentation and code.

Here are some examples:

• class BuildTestContainerTest(unittest.TestCase):
• self.test_environment
• test/test_build_test_container.py (3 times "test", 36 percent of all characters in the path)
• def test_build_test_container(self):

The word can refer to different artifacts and semantics, e.g.

• The so-called "test container" in opposite to the "database container" with the test container designed to execute the tests verifying the behavior of the Exasol database inside the database container.
• "test" code in opposite to "production code", with test code designed to verify the validity of the production features, avoid regressions and bugs.
• "test" as the general purpose of SLC ITDE, i.e. environments created for the purpose of evaluating the Exasol Database inside a Docker Container (or maybe also in other scenarios), potentially in combination with other components that could be in other Docker Containers as well.
• TestContainer (non-exasol project for using Docker containers) inherits from Python class TestCase: These names cannot be changed
• Files test_*_test_environment in folder exasol_integration_test_docker_environment/test
  • * can be api or cli
  • Each file will create an informal environment containing a (docker) network with a single or multiple docker containers
• exaslct-test-environment
  • creates up to 2 environments testing.exaslct_docker_test_environment.ExaslctDockerTestEnvironment
  • the second one only if environment variable RUN_SLC_TESTS_WITHIN_CONTAINER is set
  • with ExaslctDockerTestEnvironment being only a set of variables and values describing the environment
  • enables to test modules
  • isolates docker containers
  • defines a unique name for each Docker container image
  • can clean up collection of docker containers by removing all containers with the given name as prefix
  • can spawn a docker container with a database
• (see below for additional semantics and artifacts)

The current ticket therefore requests to

• identify semantic domains
• and to find better and unique names for all occurrences of the word "test", when this is possible.

[tkilias]

• test-container
  • rename to SidecarContainer
  • @ckunki : maybe we can find a name that is somewhat more active than a "sidecar"?
  • e.g. TestRunner, though this repeats the name "test" one more time 🙁
• test-environment (module lib, cli)
  • this starts docker-db, test-container, docker network, ...
  • rename to (Docker)Environment
• exaslct-test-environment (module testing)
  • this implements docker image namespacing and cleanup, and it also enables to start a database in namespace
  • rename to DockerIsolationFixture
  • extract feature "run CLI command with namespacing" into new class
  • extract feature "Database start via CLI" into new class and use previous feature

with docker_isolation_fixture() as iso:
  with start_database(iso)  as db:
     ...

• api-test-environment
  • similar to exaslct-test-environment
• exaslct_docker_test_environment.py
  • rename to spawned_environment, spawned_database, or database_config
• integration-test-docker-environment
  • how to rename a project?

[tkilias]

Rename CLI commands accordingly or make them shorter.

[Nicoretti]

test/test_build_test_container.py (3 times "test", 36 percent of all characters in the path) def test_build_test_container(self):

The naming convention for, test functions and the names of the modules containing tests, stems for pytest and unittest loader/executor conventions. Removing test_ from those would cause more harm than good. With renaming other things in the ITDE I highly agree. May main suggestion to fix the long tedious and repetitive names is to take the context more into account and make the context more explixit e.g. using module names (similar to the Bucketfs-Refactoring).

e.g.

• namespace: exasol
• packge: itde
• modules: cli, docker, api, logging, environment ....

Example status qou:

from exasol_integration_test_docker_environment.lib.api.api_errors import TaskRuntimeError

def usage():
    raise TaskRuntimeError()

Example future api:

from exasol.itde.docker.api.errors import TaskRuntimeError

def usage():
    raise TaskRuntimeError()

# if more context is expected needed by the reader make use of package/module imports
from exasol.itde.docker import api

def usage():
     raise api.errors.TaskRuntimeError()

Migration

For migration a exasol/itde package can be started in parallel (with the new structure). It just could rexport and rename things.

e.g.:

exasol/itde/__init__.py

from exasol_integration_test_docker_environment.lib import api as api
from exasol_integration_test_docker_environment.lib import test_environment as environment
...

New access then would then look like

from exasol.itde import api
from exasol.itde import environment

At some point in the future the old package can be made private so only the new package structure is visible.

[ckunki]

I perfectly agree, especially

• :white_checkmark: naming for test functions [...] modules [...] stems from pytest and unittest [...] Removing test [...] more harm than good.
• :white_check_mark: main suggestion fix the long tedious and repetitive names