"""NIOS plugin for integration tests.""" from __future__ import annotations import os from ....config import ( IntegrationConfig, ) from ....containers import ( CleanupMode, run_support_container, ) from . import ( CloudEnvironment, CloudEnvironmentConfig, CloudProvider, ) class NiosProvider(CloudProvider): """Nios plugin. Sets up NIOS mock server for tests.""" DOCKER_SIMULATOR_NAME = 'nios-simulator' # Default image to run the nios simulator. # # The simulator must be pinned to a specific version # to guarantee CI passes with the version used. # # It's source source itself resides at: # https://github.com/ansible/nios-test-container DOCKER_IMAGE = 'quay.io/ansible/nios-test-container:1.4.0' def __init__(self, args: IntegrationConfig) -> None: super().__init__(args) self.__container_from_env = os.environ.get('ANSIBLE_NIOSSIM_CONTAINER') """ Overrides target container, might be used for development. Use ANSIBLE_NIOSSIM_CONTAINER=whatever_you_want if you want to use other image. Omit/empty otherwise. """ self.image = self.__container_from_env or self.DOCKER_IMAGE self.uses_docker = True def setup(self) -> None: """Setup cloud resource before delegation and reg cleanup callback.""" super().setup() if self._use_static_config(): self._setup_static() else: self._setup_dynamic() def _setup_dynamic(self) -> None: """Spawn a NIOS simulator within docker container.""" nios_port = 443 ports = [ nios_port, ] run_support_container( self.args, self.platform, self.image, self.DOCKER_SIMULATOR_NAME, ports, allow_existing=True, cleanup=CleanupMode.YES, ) self._set_cloud_config('NIOS_HOST', self.DOCKER_SIMULATOR_NAME) def _setup_static(self) -> None: raise NotImplementedError() class NiosEnvironment(CloudEnvironment): """NIOS environment plugin. Updates integration test environment after delegation.""" def get_environment_config(self) -> CloudEnvironmentConfig: """Return environment configuration for use in the test environment after delegation.""" ansible_vars = dict( nios_provider=dict( host=self._get_cloud_config('NIOS_HOST'), username='admin', password='infoblox', ), ) return CloudEnvironmentConfig( ansible_vars=ansible_vars, )