Add test for osProfile.linuxConfiguration.provisionVMAgent #2826
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| # | ||
| # Disables Agent provisioning using osProfile.linuxConfiguration.provisionVMAgent and verifies that the agent is disabled | ||
| # and extension operations are not allowed. | ||
| # | ||
| name: "AgentNotProvisioned" | ||
| tests: | ||
| - "agent_not_provisioned/agent_not_provisioned.py" | ||
| images: "random(endorsed)" | ||
| template: "agent_not_provisioned/template.py" | ||
| owns_vm: true | ||
| install_test_agent: false | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| #!/usr/bin/env python3 | ||
|
|
||
| # Microsoft Azure Linux Agent | ||
| # | ||
| # Copyright 2018 Microsoft Corporation | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
| # | ||
| from assertpy import fail, assert_that | ||
| from typing import Any, Dict, List | ||
|
|
||
| from azure.mgmt.compute.models import VirtualMachineInstanceView | ||
|
|
||
| from tests_e2e.tests.lib.agent_test import AgentTest | ||
| from tests_e2e.tests.lib.identifiers import VmExtensionIds | ||
| from tests_e2e.tests.lib.logging import log | ||
| from tests_e2e.tests.lib.shell import CommandError | ||
| from tests_e2e.tests.lib.ssh_client import SshClient | ||
| from tests_e2e.tests.lib.virtual_machine_client import VirtualMachineClient | ||
| from tests_e2e.tests.lib.virtual_machine_extension_client import VirtualMachineExtensionClient | ||
|
|
||
|
|
||
| class AgentNotProvisioned(AgentTest): | ||
| """ | ||
| When osProfile.linuxConfiguration.provisionVMAgent is set to 'false', this test verifies that | ||
| the agent is disabled and that extension operations are not allowed. | ||
| """ | ||
| def run(self): | ||
| # | ||
| # Check the agent's log for the messages that indicate it is disabled. | ||
| # | ||
| ssh_client: SshClient = self._context.create_ssh_client() | ||
|
|
||
| log.info("Checking the Agent's log to verify that it is disabled.") | ||
| try: | ||
| output = ssh_client.run_command(""" | ||
| grep -E 'WARNING.*Daemon.*Disabling guest agent in accordance with ovf-env.xml' /var/log/waagent.log || \ | ||
| grep -E 'WARNING.*Daemon.*Disabling the guest agent by sleeping forever; to re-enable, remove /var/lib/waagent/disable_agent and restart' /var/log/waagent.log | ||
| """) | ||
| log.info("The Agent is disabled, log message: [%s]", output.rstrip()) | ||
| except CommandError as e: | ||
| fail(f"The agent's log does not contain the expected messages: {e}") | ||
|
|
||
| # | ||
| # Validate that the agent is not reporting status. | ||
| # | ||
| log.info("Verifying that the Agent status is 'Not Ready' (i.e. it is not reporting status).") | ||
| vm: VirtualMachineClient = VirtualMachineClient(self._context.vm) | ||
| instance_view: VirtualMachineInstanceView = vm.get_instance_view() | ||
| log.info("Instance view of VM Agent:\n%s", instance_view.vm_agent.serialize()) | ||
| assert_that(instance_view.vm_agent.statuses).described_as("The VM agent should have exactly 1 status").is_length(1) | ||
| assert_that(instance_view.vm_agent.statuses[0].code).described_as("The VM Agent should not be available").is_equal_to('ProvisioningState/Unavailable') | ||
| assert_that(instance_view.vm_agent.statuses[0].display_status).described_as("The VM Agent should not ready").is_equal_to('Not Ready') | ||
| log.info("The Agent status is 'Not Ready'") | ||
|
|
||
| # | ||
| # Validate that extensions cannot be executed. | ||
| # | ||
| log.info("Verifying that extension processing is disabled.") | ||
| log.info("Executing CustomScript; it should fail.") | ||
| custom_script = VirtualMachineExtensionClient(self._context.vm, VmExtensionIds.CustomScript, resource_name="CustomScript") | ||
| try: | ||
| custom_script.enable(settings={'commandToExecute': "date"}, force_update=True, timeout=20 * 60) | ||
| fail("CustomScript should have failed") | ||
| except Exception as error: | ||
| assert_that("OperationNotAllowed" in str(error)) \ | ||
| .described_as(f"Expected an OperationNotAllowed: {error}") \ | ||
| .is_true() | ||
| log.info("CustomScript failed, as expected: %s", error) | ||
|
|
||
| def get_ignore_error_rules(self) -> List[Dict[str, Any]]: | ||
| return [ | ||
| {'message': 'Disabling guest agent in accordance with ovf-env.xml'}, | ||
| {'message': 'Disabling the guest agent by sleeping forever; to re-enable, remove /var/lib/waagent/disable_agent and restart'} | ||
| ] | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| AgentNotProvisioned.run_from_command_line() | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| #!/usr/bin/env python3 | ||
|
|
||
| # Microsoft Azure Linux Agent | ||
| # | ||
| # Copyright 2018 Microsoft Corporation | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
| # | ||
|
|
||
| from typing import Any | ||
|
|
||
|
|
||
| def update_arm_template(template: Any) -> None: | ||
| """ | ||
| Customizes the ARM template to set osProfile.linuxConfiguration.provisionVMAgent to false. | ||
| """ | ||
| # | ||
| # NOTE: LISA's template uses this function to generate the value for osProfile.linuxConfiguration. The function is | ||
| # under the 'lisa' namespace. | ||
| # | ||
| # "getLinuxConfiguration": { | ||
| # "parameters": [ | ||
| # { | ||
| # "name": "keyPath", | ||
| # "type": "string" | ||
| # }, | ||
| # { | ||
| # "name": "publicKeyData", | ||
| # "type": "string" | ||
| # } | ||
| # ], | ||
| # "output": { | ||
| # "type": "object", | ||
| # "value": { | ||
| # "disablePasswordAuthentication": true, | ||
| # "ssh": { | ||
| # "publicKeys": [ | ||
| # { | ||
| # "path": "[parameters('keyPath')]", | ||
| # "keyData": "[parameters('publicKeyData')]" | ||
| # } | ||
| # ] | ||
| # }, | ||
| # "provisionVMAgent": true | ||
| # } | ||
| # } | ||
| # } | ||
| # | ||
| # The code below sets template['functions'][i]['members']['getLinuxConfiguration']['output']['value']['provisionVMAgent'] to True, | ||
| # where template['functions'][i] is the 'lisa' namespace. | ||
| # | ||
| functions = template.get("functions") | ||
| if functions is None: | ||
| raise Exception('Cannot find "functions" in the LISA template.') | ||
| for namespace in functions: | ||
| name = namespace.get("namespace") | ||
| if name is None: | ||
| raise Exception(f'Cannot find "namespace" in the LISA template: {namespace}') | ||
| if name == "lisa": | ||
| members = namespace.get('members') | ||
| if members is None: | ||
| raise Exception(f'Cannot find the members of the lisa namespace in the LISA template: {namespace}') | ||
| get_linux_configuration = members.get('getLinuxConfiguration') | ||
| if get_linux_configuration is None: | ||
| raise Exception(f'Cannot find the "getLinuxConfiguration" function the lisa namespace in the LISA template: {namespace}') | ||
| output = get_linux_configuration.get('output') | ||
| if output is None: | ||
| raise Exception(f'Cannot find the "output" of the getLinuxConfiguration function in the LISA template: {get_linux_configuration}') | ||
| value = output.get('value') | ||
| if value is None: | ||
| raise Exception(f"Cannot find the output's value of the getLinuxConfiguration function in the LISA template: {get_linux_configuration}") | ||
| value['provisionVMAgent'] = False | ||
| break | ||
| else: | ||
| raise Exception(f'Cannot find the "lisa" namespace in the LISA template: {functions}') | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Adding '.' to the tarball was overwriting the attributes of the home directory on the test machine (we extract the tarball with cwd set to $HOME). This was causing SSH issues on some distros, on which the SSH server checks the mode of $HOME and refuses the connection if it is too open.
Instead of adding '.', now we cd to the source directory and add '*'. The other 2 invocations of tar were OK, but I also changed them for consistency.