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 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
|
# Copyright 2024 The Chromium Authors
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
"""The tests for resource detector classes."""
import getpass
import logging
import os
from pathlib import Path
import platform
import sys
from . import detector
from opentelemetry.sdk import resources
def mock_exists(path: os.PathLike, val: bool):
"""Mock Path.exists for specified path."""
exists = Path.exists
def _mock_exists(*args, **kwargs):
if args[0] == path:
return val
return exists(*args, **kwargs)
return _mock_exists
def mock_read_text(path: os.PathLike, val: str):
"""Mock Path.read_text for specified path."""
real_read_text = Path.read_text
def _mock_read_text(*args, **kwargs):
if args[0] == path:
return val
return real_read_text(*args, **kwargs)
return _mock_read_text
def test_process_info_capture() -> None:
"""Test that ProcessDetector captures correct process info."""
env_var = list(os.environ.keys())[0]
d = detector.ProcessDetector(allowed_env=[env_var])
attrs = d.detect().attributes
assert attrs[resources.PROCESS_PID] == os.getpid()
assert attrs[detector.PROCESS_CWD] == os.getcwd()
assert attrs[resources.PROCESS_COMMAND] == sys.argv[0]
assert attrs[resources.PROCESS_COMMAND_ARGS] == tuple(sys.argv[1:])
assert attrs[resources.PROCESS_EXECUTABLE_NAME] == Path(sys.executable).name
assert attrs[resources.PROCESS_EXECUTABLE_PATH] == sys.executable
assert attrs[f"process.env.{env_var}"] == os.environ[env_var]
def test_system_info_captured(monkeypatch) -> None:
"""Test that SystemDetector captures the correct system info."""
monkeypatch.setattr(getpass, "getuser", lambda: "someuser")
monkeypatch.setattr(Path, "exists", mock_exists(detector.DMI_PATH, True))
monkeypatch.setattr(
Path,
"read_text",
mock_read_text(detector.DMI_PATH, detector.GCE_DMI),
)
d = detector.SystemDetector()
attrs = d.detect().attributes
assert attrs[detector.CPU_COUNT] == os.cpu_count()
assert attrs[detector.HOST_TYPE] == "Google Compute Engine"
assert attrs[detector.OS_NAME] == os.name
assert attrs[resources.OS_TYPE] == platform.system()
assert attrs[resources.OS_DESCRIPTION] == platform.platform()
assert attrs[detector.CPU_ARCHITECTURE] == platform.machine()
assert attrs[detector.CPU_NAME] == platform.processor()
def test_memory_info_class(monkeypatch) -> None:
proc_meminfo_contents = """
SwapTotal: 15 kB
VmallocTotal: 25 kB
MemTotal: 35 kB
"""
monkeypatch.setattr(Path, "exists",
mock_exists(detector.PROC_MEMINFO_PATH, True))
monkeypatch.setattr(
Path,
"read_text",
mock_read_text(detector.PROC_MEMINFO_PATH, proc_meminfo_contents),
)
m = detector.MemoryInfo()
assert m.total_swap_memory == 15 * 1024
assert m.total_physical_ram == 35 * 1024
assert m.total_virtual_memory == 25 * 1024
def test_memory_info_class_warns_on_unexpected_unit(monkeypatch,
caplog) -> None:
proc_meminfo_contents = """
SwapTotal: 15 mB
VmallocTotal: 25 gB
MemTotal: 35 tB
"""
monkeypatch.setattr(Path, "exists",
mock_exists(detector.PROC_MEMINFO_PATH, True))
monkeypatch.setattr(
Path,
"read_text",
mock_read_text(detector.PROC_MEMINFO_PATH, proc_meminfo_contents),
)
caplog.set_level(logging.WARNING)
m = detector.MemoryInfo()
assert "Unit for memory consumption in /proc/meminfo" in caplog.text
# We do not attempt to correct unexpected units
assert m.total_swap_memory == 15 * 1024
assert m.total_physical_ram == 35 * 1024
assert m.total_virtual_memory == 25 * 1024
def test_memory_info_class_no_units(monkeypatch) -> None:
proc_meminfo_contents = """
SwapTotal: 15
"""
monkeypatch.setattr(Path, "exists",
mock_exists(detector.PROC_MEMINFO_PATH, True))
monkeypatch.setattr(
Path,
"read_text",
mock_read_text(detector.PROC_MEMINFO_PATH, proc_meminfo_contents),
)
m = detector.MemoryInfo()
assert m.total_swap_memory == 15
def test_memory_info_class_no_provided_value(monkeypatch, caplog) -> None:
proc_meminfo_contents = """
SwapTotal:
"""
monkeypatch.setattr(Path, "exists",
mock_exists(detector.PROC_MEMINFO_PATH, True))
monkeypatch.setattr(
Path,
"read_text",
mock_read_text(detector.PROC_MEMINFO_PATH, proc_meminfo_contents),
)
caplog.set_level(logging.WARNING)
detector.MemoryInfo()
assert "Unexpected /proc/meminfo entry with no label:number" in caplog.text
def test_system_info_to_capture_memory_resources(monkeypatch) -> None:
proc_meminfo_contents = """
SwapTotal: 15 kB
VmallocTotal: 25 kB
MemTotal: 35 kB
"""
monkeypatch.setattr(Path, "exists",
mock_exists(detector.PROC_MEMINFO_PATH, True))
monkeypatch.setattr(
Path,
"read_text",
mock_read_text(detector.PROC_MEMINFO_PATH, proc_meminfo_contents),
)
d = detector.SystemDetector()
attrs = d.detect().attributes
assert attrs[detector.MEMORY_TOTAL] == 35 * 1024
assert attrs[detector.MEMORY_SWAP_TOTAL] == 15 * 1024
def test_system_info_to_capture_host_type_bot(monkeypatch) -> None:
"""Test that SystemDetector captures host type as Google Compute Engine."""
monkeypatch.setattr(Path, "exists", mock_exists(detector.DMI_PATH, True))
monkeypatch.setattr(
Path,
"read_text",
mock_read_text(detector.DMI_PATH, detector.GCE_DMI),
)
d = detector.SystemDetector()
attrs = d.detect().attributes
assert attrs[detector.CPU_COUNT] == os.cpu_count()
assert attrs[detector.HOST_TYPE] == detector.GCE_DMI
assert attrs[detector.OS_NAME] == os.name
assert attrs[resources.OS_TYPE] == platform.system()
assert attrs[resources.OS_DESCRIPTION] == platform.platform()
assert attrs[detector.CPU_ARCHITECTURE] == platform.machine()
assert attrs[detector.CPU_NAME] == platform.processor()
def test_system_info_to_capture_host_type_from_dmi(monkeypatch) -> None:
"""Test that SystemDetector captures dmi product name as host type."""
monkeypatch.setattr(getpass, "getuser", lambda: "someuser")
monkeypatch.setattr(Path, "exists", mock_exists(detector.DMI_PATH, True))
monkeypatch.setattr(Path, "read_text",
mock_read_text(detector.DMI_PATH, "SomeId"))
d = detector.SystemDetector()
attrs = d.detect().attributes
assert attrs[detector.CPU_COUNT] == os.cpu_count()
assert attrs[detector.HOST_TYPE] == "SomeId"
assert attrs[detector.OS_NAME] == os.name
assert attrs[resources.OS_TYPE] == platform.system()
assert attrs[resources.OS_DESCRIPTION] == platform.platform()
assert attrs[detector.CPU_ARCHITECTURE] == platform.machine()
assert attrs[detector.CPU_NAME] == platform.processor()
def test_system_info_to_capture_host_type_unknown(monkeypatch) -> None:
"""Test that SystemDetector captures host type as UNKNOWN."""
monkeypatch.setattr(Path, "exists", mock_exists(detector.DMI_PATH, False))
d = detector.SystemDetector()
attrs = d.detect().attributes
assert attrs[detector.CPU_COUNT] == os.cpu_count()
assert attrs[detector.HOST_TYPE] == "UNKNOWN"
assert attrs[detector.OS_NAME] == os.name
assert attrs[resources.OS_TYPE] == platform.system()
assert attrs[resources.OS_DESCRIPTION] == platform.platform()
assert attrs[detector.CPU_ARCHITECTURE] == platform.machine()
assert attrs[detector.CPU_NAME] == platform.processor()
|