test/integration/share/README.md

   1 # InSpec Profile: `share`
   2
   3 This shows the implementation of the `share` InSpec [profile](https://github.com/inspec/inspec/blob/master/docs/profiles.md).
   4
   5 Its goal is to share the libraries between all profiles.
   6
   7 ## Libraries
   8
   9 ### `system`
  10
  11 The `system` library provides easy access to system dependent information:
  12
  13 - `system.platform`: based on `inspec.platform`, modify to values that are more consistent from a SaltStack perspective
  14   - `system.platform[:family]` provide a family name for Arch and Gentoo
  15   - `system.platform[:name]` append `linux` to both `amazon` and `oracle`; ensure Windows platforms are resolved as simply `windows`
  16   - `system.platform[:release]` tweak Arch, Amazon Linux, Gentoo, openSUSE and Windows:
  17     - `Arch` is always `base-latest`
  18     - `Amazon Linux` release `2018` is resolved as `1`
  19     - `Gentoo` release is trimmed to its major version number and then the init system is appended (i.e. `sysv` or `sysd`)
  20     - `openSUSE` is resolved as `tumbleweed` if the `platform[:release]` is in date format
  21     - `Windows` uses the widely-used release number (e.g. `8.1` or `2019-server`) in place of the actual system release version
  22   - `system.platform[:finger]` is the concatenation of the name and the major release number (except for Ubuntu, which gives `ubuntu-20.04` for example)