checkPlatform

Check the current platform (operating system) and, optionally, its minimum version.

Parameters

checkPlatform: str

Operating system to check. Additionally, an optional version check can be added with a test operator

aliases: checkOS, checkPlatform

desc: str (Optional)

The description for the check

substitute: bool (Optional)

Whether to substitute environment variables in check values

default: True

aliases: substitute, env_substitute

Example 1 (yaml)

The checkPlatform check in YAML format.

check:
  OperatingSystem:
    desc: Check the minimum operating system versions
    subchecks: any

    checkMacOS:
      desc: MacOS 10.9 or later (released 2013)
      checkOS: "macOS >= 10.9"
    checkLinuxOS:
      desc: Linux 4.0 or later (released 2015)
      checkOS: "Linux >= 3.0"
    checkWindows:
      desc: Windows 10 or later (released 2015)
      checkOS: "Windows >= 10"

Example 2 (toml)

The checkPlatform check in TOML format.

[checks.OperatingSystem]
desc = "Check the minimum operating system versions"
subchecks = "any"

    [checks.OperatingSystem.checkMacOS]
    desc = "MacOS 10.9 or later (released 2013)"
    checkOS = "macOS >= 10.9"

    [checks.OperatingSystem.checkLinuxOS]
    desc = "Linux 4.0 or later (released 2015)"
    checkOS = "Linux >= 3.0"

    [checks.OperatingSystem.checkWindows]
    desc = "Windows 10 or later (released 2015)"
    checkOS = "Windows >= 10"

Example 3 (toml)

The checkPlatform check in abbreviated TOML format.

[checks.OperatingSystem]
desc = "Check the minimum operating system versions"
subchecks = "any"

checkMacOS = {desc = "MacOS 10.9 or later (released 2013)", checkOS = "macOS >= 10.9"}
checkLinuxOS = {desc = "Linux 4.0 or later (released 2015)", checkOS = "Linux >= 3.0"}
checkWindows = {desc = "Windows 10 or later (released 2015)", checkOS = "Windows >= 10"}