/etc/os-release based OS detection #1299

tas50 · 2018-11-24T19:59:42Z

/etc/os-release is the modern way of identifying Linux platforms and versions. It's far more reliable than the brittle regex mess that we have built up over the last decade. It also allows us to easily detect unknown / obscure distros since they have platform IDs in the os-release file.

Changes to call out:

Platform detection will now default to /etc/os-release if that file is present
The majority of the legacy logic is retained within a legacy method
Unless we override the value we just use the platform value from os-release. Going forward for new platforms we'll just use this value. The overrides are just to retain legacy compatibility
Unless it's missing we just use the version found in the os-release file. If it's not found we grab the kernel version with uname as we did before (gentoo/arch/etc)
Some platforms where we know users stay more up to date have been switched over to the os-release logic entirely: arch, alpine, and cumulus, mint, raspbian, and clearlinux. This also speeds up the remaining legacy platforms.
Testing has been simplified and expanded since we're mostly testing the platform remapping method, and the platform to platform_family methods. There's no need to run the plugin for each possible platform when the logic is entirely identical sans the value in the os-release file now.
The new logic should be faster as we don't have to check for the existence of a large number of files. We just read out a single file and then lookup a few things in a hash table.
Adds manjaro to the arch platform_family and kali to the debian platform_family.

Things that change:

Nexus switch versions are now properly identified with the shorter version string such as 7.0(3)I2(2b) instead of 7.0(3)I2(0.475E.6) which includes the build number.

We need to correctly read in the data in /etc/os-release and do the right thing. We already did this for SLES 15. Signed-off-by: Tim Smith <tsmith@chef.io>

This is the modern way of identifying Linux platforms and versions. It's far more reliable than the brittle regex mess that we have built up over the last decade. It also allows us to easily detect unknown / obscure distros. Signed-off-by: Tim Smith <tsmith@chef.io>

Get ready to refactor these Signed-off-by: Tim Smith <tsmith@chef.io>

Signed-off-by: Tim Smith <tsmith@chef.io>

This avoids the need to test the full plugin run on each of these platforms and it keeps us from accidentally breaking something here later on. Signed-off-by: Tim Smith <tsmith@chef.io>

We test this better now Signed-off-by: Tim Smith <tsmith@chef.io>

These are modern operating systems that will always use the new os-release logic: Fedora, Arch, Linux Mint, raspbian, amazon 2, clearos Signed-off-by: Tim Smith <tsmith@chef.io>

Signed-off-by: Tim Smith <tsmith@chef.io>

Break out more logic into simpler methods that can be tested Signed-off-by: Tim Smith <tsmith@chef.io>

Avoid having to search path when it's always in the same path Signed-off-by: Tim Smith <tsmith@chef.io>

I've confirmed this works on a cumulus system. Not sure where the previous logic came from. Signed-off-by: Tim Smith <tsmith@chef.io>

This is wrong, but it's what we've been doing for a while Signed-off-by: Tim Smith <tsmith@chef.io>

This is faster and also easier to read Signed-off-by: Tim Smith <tsmith@chef.io>

These systems always have an os-release file. No need for the legacy method. Signed-off-by: Tim Smith <tsmith@chef.io>

Nothing supported here lacks os-release files Signed-off-by: Tim Smith <tsmith@chef.io>

Bumps things for the last 10 years Signed-off-by: Tim Smith <tsmith@chef.io>

CentOS doesn't do the right thing with the os-release file. They treat it differently than redhat and every other distro I've seen. We need to work around that. Signed-off-by: Tim Smith <tsmith@chef.io>

Signed-off-by: Tim Smith <tsmith@chef.io>

We'll never get to this code since it requires a os-release file Signed-off-by: Tim Smith <tsmith@chef.io>

It's os-release file is not in a standard location Signed-off-by: Tim Smith <tsmith@chef.io>

lamont-granquist · 2018-11-27T07:37:18Z

spec/unit/plugins/linux/platform_spec.rb

-      expect(@plugin[:platform]).to eq("amazon")
-      expect(@plugin[:platform_family]).to eq("amazon")
+  describe "#read_os_release_info" do
+    let(:file_contents) { "COW=MOO\nDOG=\"BARK\"" }


but what does the fox say?

lock · 2019-01-26T22:39:19Z

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

Correctly detect openSUSE leap 15+

6b14655

We need to correctly read in the data in /etc/os-release and do the right thing. We already did this for SLES 15. Signed-off-by: Tim Smith <tsmith@chef.io>

tas50 requested a review from a team November 24, 2018 19:59

tas50 force-pushed the os_release_detection branch from 50339fb to 648a0f8 Compare November 24, 2018 20:16

tas50 force-pushed the os_release_detection branch from 648a0f8 to 0d842f7 Compare November 24, 2018 21:42

tas50 added 23 commits November 24, 2018 23:25

Shuffle around the specs a bit

9241129

Get ready to refactor these Signed-off-by: Tim Smith <tsmith@chef.io>

Add cumulus linux os-release remapping

fb8cbcb

Signed-off-by: Tim Smith <tsmith@chef.io>

Remove duplicate arista_eos platform

fddebcc

Signed-off-by: Tim Smith <tsmith@chef.io>

Test the platform and platform_family mapping

3abac7a

This avoids the need to test the full plugin run on each of these platforms and it keeps us from accidentally breaking something here later on. Signed-off-by: Tim Smith <tsmith@chef.io>

Remove the older platform_family tests

4a5d7cc

We test this better now Signed-off-by: Tim Smith <tsmith@chef.io>

Remove legacy testing of systems that always have an os-release file

4951bad

These are modern operating systems that will always use the new os-release logic: Fedora, Arch, Linux Mint, raspbian, amazon 2, clearos Signed-off-by: Tim Smith <tsmith@chef.io>

Chefstyle

1ce923c

Signed-off-by: Tim Smith <tsmith@chef.io>

Add a simple method for platform version detection

4bd9041

Break out more logic into simpler methods that can be tested Signed-off-by: Tim Smith <tsmith@chef.io>

Use the absolute path to uname

e7fa47a

Avoid having to search path when it's always in the same path Signed-off-by: Tim Smith <tsmith@chef.io>

Use /etc/os-release detection for cumulus

1153542

I've confirmed this works on a cumulus system. Not sure where the previous logic came from. Signed-off-by: Tim Smith <tsmith@chef.io>

Remap nexus -> nexus_centos to match our previous name

616c2f7

This is wrong, but it's what we've been doing for a while Signed-off-by: Tim Smith <tsmith@chef.io>

Switch the platform remapping to a hash table

caceb5b

This is faster and also easier to read Signed-off-by: Tim Smith <tsmith@chef.io>

Move Arch and Alpine detection to os-release

11e7351

These systems always have an os-release file. No need for the legacy method. Signed-off-by: Tim Smith <tsmith@chef.io>

Rely on os-release for Mint and Raspbian

147a3c4

Nothing supported here lacks os-release files Signed-off-by: Tim Smith <tsmith@chef.io>

Update versions in the specs

8b02ee1

Bumps things for the last 10 years Signed-off-by: Tim Smith <tsmith@chef.io>

Make sure centos continues to correctly parse out versions

643599c

CentOS doesn't do the right thing with the os-release file. They treat it differently than redhat and every other distro I've seen. We need to work around that. Signed-off-by: Tim Smith <tsmith@chef.io>

Move clearlinux logic to os-release

4dc35bb

Signed-off-by: Tim Smith <tsmith@chef.io>

Fix platform remapping on nexus_centos

5d4e074

Signed-off-by: Tim Smith <tsmith@chef.io>

Move gentoo entirely to os-release based detection

b6b2d17

Signed-off-by: Tim Smith <tsmith@chef.io>

Use shellout properly for kernel version detection

1ce3724

Signed-off-by: Tim Smith <tsmith@chef.io>

Remove legacy testing for platforms that have os-release files

551e7d6

Signed-off-by: Tim Smith <tsmith@chef.io>

Remove nexus_centos os-release detection from the legacy method

e1fe9b9

We'll never get to this code since it requires a os-release file Signed-off-by: Tim Smith <tsmith@chef.io>

Move clearlinux back to the legacy method

35c73df

It's os-release file is not in a standard location Signed-off-by: Tim Smith <tsmith@chef.io>

lamont-granquist reviewed Nov 27, 2018

View reviewed changes

lamont-granquist approved these changes Nov 27, 2018

View reviewed changes

tas50 changed the title ~~WIP: /etc/os-release based OS detection~~ /etc/os-release based OS detection Nov 27, 2018

tas50 mentioned this pull request Nov 27, 2018

Correctly detect openSUSE leap 15+ #1297

Merged

tas50 merged commit c41b15e into master Nov 27, 2018

chef-ci deleted the os_release_detection branch November 27, 2018 21:53

lock bot locked as resolved and limited conversation to collaborators Jan 26, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

/etc/os-release based OS detection #1299

/etc/os-release based OS detection #1299

tas50 commented Nov 24, 2018 •

edited

Loading

lamont-granquist Nov 27, 2018

lock bot commented Jan 26, 2019

/etc/os-release based OS detection #1299

/etc/os-release based OS detection #1299

Conversation

tas50 commented Nov 24, 2018 • edited Loading

lamont-granquist Nov 27, 2018

Choose a reason for hiding this comment

lock bot commented Jan 26, 2019

tas50 commented Nov 24, 2018 •

edited

Loading