# -*- coding: utf-8 -*- # ----------------------------------------------------------------------------- # Copyright (c) 2016, Anaconda, Inc. All rights reserved. # # Licensed under the terms of the BSD 3-Clause License. # The full license is in the file LICENSE.txt, distributed with this software. # ----------------------------------------------------------------------------- from __future__ import absolute_import, print_function import os import platform import pytest from anaconda_project.test.project_utils import project_no_dedicated_env from anaconda_project.test.environ_utils import minimal_environ, strip_environ from anaconda_project.internal.cli.main import _parse_args_and_run_subcommand from anaconda_project.project_file import DEFAULT_PROJECT_FILENAME from anaconda_project.requirements_registry.requirements.redis import RedisRequirement from anaconda_project.requirements_registry.registry import RequirementsRegistry from anaconda_project.internal.test.tmpfile_utils import (tmp_script_commandline, with_directory_contents_completing_project_file) from anaconda_project.internal.simple_status import SimpleStatus from anaconda_project.local_state_file import LocalStateFile from anaconda_project.internal import conda_api def _monkeypatch_pwd(monkeypatch, dirname): from os.path import abspath as real_abspath def mock_abspath(path): if path == ".": return dirname else: return real_abspath(path) monkeypatch.setattr('os.path.abspath', mock_abspath) def _monkeypatch_add_service(monkeypatch, result): def mock_add_service(*args, **kwargs): return result monkeypatch.setattr("anaconda_project.project_ops.add_service", mock_add_service) _echo_commandline = tmp_script_commandline("""from __future__ import print_function import sys print(" ".join(sys.argv)) sys.exit(0) """) def test_add_service(capsys, monkeypatch): def check(dirname): _monkeypatch_pwd(monkeypatch, dirname) status = SimpleStatus(success=True, description='Service added.') status.requirement = RedisRequirement(RequirementsRegistry(), env_var='REDIS_URL', options=dict(type='redis')) _monkeypatch_add_service(monkeypatch, status) code = _parse_args_and_run_subcommand(['anaconda-project', 'add-service', 'redis']) assert code == 0 out, err = capsys.readouterr() assert ('Service added.\n' + 'Added service redis to the project file, its address will be in REDIS_URL.\n') == out assert '' == err with_directory_contents_completing_project_file(dict(), check) def test_add_service_fails(capsys, monkeypatch): def check(dirname): _monkeypatch_pwd(monkeypatch, dirname) _monkeypatch_add_service(monkeypatch, SimpleStatus(success=False, description='Service add FAIL.')) code = _parse_args_and_run_subcommand(['anaconda-project', 'add-service', 'redis']) assert code == 1 out, err = capsys.readouterr() assert '' == out assert 'Service add FAIL.\n' == err with_directory_contents_completing_project_file(dict(), check) def test_remove_service(capsys, monkeypatch): def check(dirname): _monkeypatch_pwd(monkeypatch, dirname) local_state = LocalStateFile.load_for_directory(dirname) local_state.set_service_run_state('ABC', {'shutdown_commands': [_echo_commandline + ['"shutting down ABC"']]}) local_state.set_service_run_state('TEST', {'shutdown_commands': [_echo_commandline + ['"shutting down TEST"']]}) local_state.save() code = _parse_args_and_run_subcommand(['anaconda-project', 'remove-service', 'TEST']) assert code == 0 out, err = capsys.readouterr() assert '' == err expected_out = ("Removed service 'TEST' from the project file.\n") assert expected_out == out with_directory_contents_completing_project_file( {DEFAULT_PROJECT_FILENAME: 'services:\n ABC: redis\n TEST: redis'}, check) def test_remove_service_shutdown_fails(capsys, monkeypatch): def check(dirname): _monkeypatch_pwd(monkeypatch, dirname) local_state = LocalStateFile.load_for_directory(dirname) false_commandline = tmp_script_commandline("""import sys sys.exit(1) """) local_state.set_service_run_state('TEST', {'shutdown_commands': [false_commandline]}) local_state.save() code = _parse_args_and_run_subcommand(['anaconda-project', 'remove-service', 'TEST']) assert code == 1 out, err = capsys.readouterr() expected_err = ("Shutting down TEST, command %r failed with code 1.\n" + "Shutdown commands failed for TEST.\n") % false_commandline assert expected_err == err assert '' == out with_directory_contents_completing_project_file({DEFAULT_PROJECT_FILENAME: 'services:\n TEST: redis'}, check) def test_remove_service_by_type(capsys, monkeypatch): def check(dirname): _monkeypatch_pwd(monkeypatch, dirname) local_state = LocalStateFile.load_for_directory(dirname) local_state.set_service_run_state('TEST', {'shutdown_commands': [_echo_commandline + ['"shutting down TEST"']]}) local_state.save() code = _parse_args_and_run_subcommand(['anaconda-project', 'remove-service', 'redis']) assert code == 0 out, err = capsys.readouterr() assert '' == err expected_out = ("Removed service 'redis' from the project file.\n") assert expected_out == out with_directory_contents_completing_project_file({DEFAULT_PROJECT_FILENAME: 'services:\n TEST: redis'}, check) def test_remove_service_duplicate(capsys, monkeypatch): def check(dirname): _monkeypatch_pwd(monkeypatch, dirname) local_state = LocalStateFile.load_for_directory(dirname) local_state.set_service_run_state('ABC', {'shutdown_commands': [_echo_commandline + ['"shutting down ABC"']]}) local_state.set_service_run_state('TEST', {'shutdown_commands': [_echo_commandline + ['"shutting down TEST"']]}) local_state.save() code = _parse_args_and_run_subcommand(['anaconda-project', 'remove-service', 'redis']) assert code == 1 out, err = capsys.readouterr() assert '' == out expected_err = ("Conflicting results, found 2 matches, use list-services" " to identify which service you want to remove\n") assert expected_err == err with_directory_contents_completing_project_file( {DEFAULT_PROJECT_FILENAME: 'services:\n ABC: redis\n TEST: redis'}, check) @pytest.mark.skipif(platform.system() == 'Windows', reason='Windows has a hard time with read-only directories') @pytest.mark.skipif(conda_api.current_platform() == 'osx-arm64', reason='We cannot install redis server on osx-arm64') def test_remove_service_running_redis(monkeypatch): from anaconda_project.requirements_registry.network_util import can_connect_to_socket as real_can_connect_to_socket from anaconda_project.requirements_registry.providers.test import test_redis_provider can_connect_args_list = test_redis_provider._monkeypatch_can_connect_to_socket_on_nonstandard_port_only( monkeypatch, real_can_connect_to_socket) def start_local_redis(dirname): project = project_no_dedicated_env(dirname) result = test_redis_provider._prepare_printing_errors(project, environ=minimal_environ()) assert result local_state_file = LocalStateFile.load_for_directory(dirname) state = local_state_file.get_service_run_state('REDIS_URL') assert 'port' in state port = state['port'] assert dict(REDIS_URL=("redis://localhost:" + str(port)), PROJECT_DIR=project.directory_path) == strip_environ(result.environ) assert len(can_connect_args_list) >= 2 pidfile = os.path.join(dirname, "services/REDIS_URL/redis.pid") logfile = os.path.join(dirname, "services/REDIS_URL/redis.log") try: print("listing of services") print(repr(os.listdir(os.path.dirname(os.path.dirname(pidfile))))) except Exception as e: print("failed to list services: " + str(e)) try: print("listing of REDIS_URL") print(repr(os.listdir(os.path.dirname(pidfile)))) except Exception as e: print("failed to list REDIS_URL: " + str(e)) assert os.path.exists(pidfile) assert os.path.exists(logfile) assert real_can_connect_to_socket(host='localhost', port=port) # now clean it up code = _parse_args_and_run_subcommand( ['anaconda-project', 'remove-service', 'REDIS_URL', '--directory', dirname]) assert code == 0 assert not os.path.exists(pidfile) assert not os.path.exists(os.path.join(dirname, "services")) assert not real_can_connect_to_socket(host='localhost', port=port) local_state_file.load() assert dict() == local_state_file.get_service_run_state("REDIS_URL") with_directory_contents_completing_project_file({DEFAULT_PROJECT_FILENAME: "services:\n REDIS_URL: redis"}, start_local_redis) def test_remove_service_missing_variable(capsys, monkeypatch): def check(dirname): _monkeypatch_pwd(monkeypatch, dirname) code = _parse_args_and_run_subcommand(['anaconda-project', 'remove-service', 'TEST']) assert code == 1 out, err = capsys.readouterr() assert "Service 'TEST' not found in the project file.\n" == err assert '' == out with_directory_contents_completing_project_file({DEFAULT_PROJECT_FILENAME: ''}, check) def _test_service_command_with_project_file_problems(capsys, monkeypatch, command): def check(dirname): _monkeypatch_pwd(monkeypatch, dirname) code = _parse_args_and_run_subcommand(command) assert code == 1 out, err = capsys.readouterr() assert '' == out assert ('variables section contains wrong value type 42,' + ' should be dict or list of requirements\n' + 'Unable to load the project.\n') in err with_directory_contents_completing_project_file({DEFAULT_PROJECT_FILENAME: "variables:\n 42"}, check) def test_add_service_with_project_file_problems(capsys, monkeypatch): _test_service_command_with_project_file_problems(capsys, monkeypatch, ['anaconda-project', 'add-service', 'redis']) def test_remove_service_with_project_file_problems(capsys, monkeypatch): _test_service_command_with_project_file_problems(capsys, monkeypatch, ['anaconda-project', 'remove-service', 'TEST']) def test_list_service_with_project_file_problems(capsys, monkeypatch): _test_service_command_with_project_file_problems(capsys, monkeypatch, ['anaconda-project', 'list-services']) def test_list_service(capsys, monkeypatch): def check_list(dirname): _monkeypatch_pwd(monkeypatch, dirname) code = _parse_args_and_run_subcommand(['anaconda-project', 'list-services']) assert code == 0 out, err = capsys.readouterr() assert err == '' expected_out = """ Services for project: {dirname} Name Description ==== =========== REDIS_URL A running Redis server, located by a redis: URL set as REDIS_URL. """.format(dirname=dirname).strip() + "\n" assert out == expected_out with_directory_contents_completing_project_file({DEFAULT_PROJECT_FILENAME: "services:\n REDIS_URL: redis\n"}, check_list) def test_list_service_with_empty_project(capsys, monkeypatch): def check_empty(dirname): _monkeypatch_pwd(monkeypatch, dirname) code = _parse_args_and_run_subcommand(['anaconda-project', 'list-services']) assert code == 0 out, err = capsys.readouterr() assert err == '' assert out == "No services found for project: {}\n".format(dirname) with_directory_contents_completing_project_file({DEFAULT_PROJECT_FILENAME: ""}, check_empty)