File: agent_cgroups-check_cgroups_agent.py

package info (click to toggle)
waagent 2.15.0.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 9,820 kB
  • sloc: python: 60,164; xml: 4,126; sh: 1,354; makefile: 22
file content (143 lines) | stat: -rwxr-xr-x 6,183 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
#!/usr/bin/env pypy3

# 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.
#
import os
import re

from assertpy import fail

from tests_e2e.tests.lib.agent_log import AgentLog
from tests_e2e.tests.lib.cgroup_helpers import BASE_CGROUP, get_agent_cgroup_mount_path, \
    AGENT_SERVICE_NAME, verify_if_distro_supports_cgroup, print_cgroups, \
    verify_agent_cgroup_assigned_correctly, get_mounted_controller_list, CGROUP_TRACKED_PATTERN
from tests_e2e.tests.lib.logging import log
from tests_e2e.tests.lib.remote_test import run_remote_test
from tests_e2e.tests.lib.retry import retry_if_false


def verify_if_cgroup_controllers_are_mounted():
    """
    Checks if controllers CPU, Memory that agent use are mounted in the system
    """
    log.info("===== Verifying cgroup controllers that agent use are mounted in the system")

    all_controllers_present = os.path.exists(BASE_CGROUP)
    missing_controllers = []
    mounted_controllers = []

    for controller in get_mounted_controller_list():
        controller_path = os.path.join(BASE_CGROUP, controller)
        if not os.path.exists(controller_path):
            all_controllers_present = False
            missing_controllers.append(controller_path)
        else:
            mounted_controllers.append(controller_path)

    if not all_controllers_present:
        fail('Not all of the controllers {0} mounted in expected cgroups. Mounted controllers are: {1}.\n '
             'Missing controllers are: {2} \n System mounted cgroups are:\n{3}'.format(get_mounted_controller_list(), mounted_controllers, missing_controllers, print_cgroups()))

    log.info('Verified all cgroup controllers are present.\n {0}'.format(mounted_controllers))


def verify_agent_cgroup_created_on_file_system():
    """
    Checks agent service is running in azure.slice/{agent_service) cgroup and mounted in same system cgroup controllers mounted path
    """
    log.info("===== Verifying the agent cgroup paths exist on file system")
    agent_cgroup_mount_path = get_agent_cgroup_mount_path()
    log.info("expected agent cgroup mount path: %s", agent_cgroup_mount_path)

    missing_agent_cgroup_controllers_path = []
    verified_agent_cgroup_controllers_path = []

    def is_agent_cgroup_controllers_path_exist():
        all_controllers_path_exist = True
        missing_agent_cgroup_controllers_path.clear()
        verified_agent_cgroup_controllers_path.clear()
        for agenet_cgroup in agent_cgroup_mount_path:
            all_controllers_path_exist = True
            for controller in get_mounted_controller_list():
                agent_controller_path = os.path.join(BASE_CGROUP, controller, agenet_cgroup[1:])

                if not os.path.exists(agent_controller_path):
                    all_controllers_path_exist = False
                    missing_agent_cgroup_controllers_path.append(agent_controller_path)
                else:
                    verified_agent_cgroup_controllers_path.append(agent_controller_path)

            # check the base cgroup path in v2
            if not get_mounted_controller_list():
                agent_controller_path = os.path.join(BASE_CGROUP, agenet_cgroup[1:])
                if not os.path.exists(agent_controller_path):
                    all_controllers_path_exist = False
                    missing_agent_cgroup_controllers_path.append(agent_controller_path)
                else:
                    all_controllers_path_exist = True
                    verified_agent_cgroup_controllers_path.append(agent_controller_path)

            if all_controllers_path_exist:
                break

        return all_controllers_path_exist

    # Test check can happen before agent setup cgroup configuration. So, retrying the check for few times
    if not retry_if_false(is_agent_cgroup_controllers_path_exist):
        fail("Agent's cgroup paths couldn't be found on file system. Missing agent cgroups path :{0}.\n Verified agent cgroups path:{1}".format(missing_agent_cgroup_controllers_path, verified_agent_cgroup_controllers_path))

    log.info('Verified all agent cgroup paths are present.\n {0}'.format(verified_agent_cgroup_controllers_path))


def verify_agent_cgroups_tracked():
    """
    Checks if agent is tracking agent cgroups path for polling resource usage. This is verified by checking the agent log for the message "Started tracking cgroup"
    """
    log.info("===== Verifying agent started tracking cgroups from the log")

    tracked_cgroups = []

    def is_agent_tracking_cgroup():
        tracked_cgroups.clear()
        for record in AgentLog().read():
            match = re.search(CGROUP_TRACKED_PATTERN, record.message)
            if match is not None:
                tracked_cgroups.append(match.group('path'))

        for controller in get_mounted_controller_list():
            if not any(AGENT_SERVICE_NAME in cgroup_path and controller in cgroup_path for cgroup_path in tracked_cgroups):
                return False
        return True
    # Test check can happen before agent starts tracking cgroups. So, retrying the check for few times
    found = retry_if_false(is_agent_tracking_cgroup)
    if not found:
        fail('Agent {0} is not being tracked. Tracked cgroups:{1}'.format(get_mounted_controller_list(), tracked_cgroups))

    log.info("Agent is tracking cgroups correctly.\n%s", tracked_cgroups)


def main():
    verify_if_distro_supports_cgroup()

    verify_if_cgroup_controllers_are_mounted()
    verify_agent_cgroup_created_on_file_system()

    verify_agent_cgroup_assigned_correctly()
    verify_agent_cgroups_tracked()


run_remote_test(main)