This is an archive of the discontinued LLVM Phabricator instance.

Differential D25869

[Driver] Add unit tests for Distro detection
ClosedPublic

Authored by mgorny on Oct 21 2016, 6:57 AM.

Details

Reviewers
bruno
• rafael
bkramer
Commits
rG593970f1a74e: [Driver] Add unit tests for Distro detection
rC288062: [Driver] Add unit tests for Distro detection
rL288062: [Driver] Add unit tests for Distro detection
Summary

Add a set of unit tests for the distro detection code. The tests use an
in-memory virtual filesystems resembling release files for various
distributions supported. All release files are provided (not only the
ones directly used) in order to guarantee that one of the rules will not
mistakenly recognize the distribution incorrectly due to the additional
files (e.g. Ubuntu as Debian).

Diff Detail

Repository
rL LLVM

Event Timeline

mgorny updated this revision to Diff 75418.Oct 21 2016, 6:57 AM
mgorny retitled this revision from to [Driver] Add unit tests for DetectDistro().
mgorny updated this object.
mgorny added reviewers: bruno, bkramer, • rafael.
mgorny added a subscriber: cfe-commits.
Herald added a subscriber: beanz. · View Herald TranscriptOct 21 2016, 6:57 AM
bkramer edited edge metadata.Oct 25 2016, 2:27 AM

Very nice.

unittests/Driver/ToolChainsTest.cpp
15 ↗(On Diff #75418)

Yeah. It's better to hoist the enum + the decl for detectDistro into a public header under include/clang/Driver and include it from here.

mgorny planned changes to this revision.Oct 25 2016, 7:58 AM
mgorny added inline comments.
unittests/Driver/ToolChainsTest.cpp
15 ↗(On Diff #75418)

Ok. Then I'll probably refactor the whole thing into a nicer API anyway ;-).

bruno edited edge metadata.Oct 25 2016, 8:28 AM

This is great!

unittests/Driver/ToolChainsTest.cpp
154 ↗(On Diff #75418)

Can you add the tests for /etc/SuSE-release here as well?

mgorny added inline comments.Oct 25 2016, 8:45 AM
unittests/Driver/ToolChainsTest.cpp
154 ↗(On Diff #75418)

Yes, that is a goal. I didn't add all distros yet because I wanted to see if I'm doing it right first ;-).

mgorny mentioned this in D25949: [Driver] Refactor distro detection & classification as a separate API.Oct 25 2016, 10:00 AM
mgorny added a parent revision: D25949: [Driver] Refactor distro detection & classification as a separate API.
mgorny updated this revision to Diff 78494.Nov 18 2016, 3:31 AM
mgorny retitled this revision from [Driver] Add unit tests for DetectDistro() to [Driver] Add unit tests for Distro detection.
mgorny updated this object.
mgorny edited edge metadata.

Ok, here are the tests updated for the new API. I'll try to look into adding more distributions later today.

mgorny updated this revision to Diff 78506.Nov 18 2016, 6:00 AM

Added tests for SUSE and Arch Linux (and found a bug for the former, D26850).

bruno added a comment.Nov 18 2016, 9:54 AM

LGTM! Please add this before D26850, which should contain a testcase on top of this!

Thanks

bruno accepted this revision.Nov 18 2016, 9:55 AM
bruno edited edge metadata.
This revision is now accepted and ready to land.Nov 18 2016, 9:55 AM
mgorny mentioned this in D26850: [Driver] Fix recognizing newer OpenSUSE versions.Nov 18 2016, 11:22 AM
mgorny added a comment.Nov 18 2016, 11:44 PM
In D25869#599996, @bruno wrote:

LGTM! Please add this before D26850, which should contain a testcase on top of this!

I should probably also copy here that as I've mentioned on D26850, this already contains a test case erroring out due to the OpenSUSE parsing bug. I originally intended to commit the fix before the test case included here but I can move that around if you insist.

mgorny updated this revision to Diff 78625.Nov 19 2016, 4:56 AM
mgorny edited edge metadata.

Added a test for Exherbo.

Closed by commit rL288062: [Driver] Add unit tests for Distro detection (authored by mgorny). · Explain WhyNov 28 2016, 1:21 PM
This revision was automatically updated to reflect the committed changes.
mgorny mentioned this in rL288060: [Driver] Refactor distro detection & classification as a separate API.

Revision Contents

PathSize
cfe/
trunk/
unittests/
Driver/
1 line
305 lines

Diff 79444

cfe/trunk/unittests/Driver/CMakeLists.txt

set(LLVM_LINK_COMPONENTS set(LLVM_LINK_COMPONENTS
Support Support
) )
add_clang_unittest(ClangDriverTests add_clang_unittest(ClangDriverTests
DistroTest.cpp
ToolChainTest.cpp ToolChainTest.cpp
MultilibTest.cpp MultilibTest.cpp
) )
target_link_libraries(ClangDriverTests target_link_libraries(ClangDriverTests
clangDriver clangDriver
clangBasic clangBasic
) )

cfe/trunk/unittests/Driver/DistroTest.cpp

//===- unittests/Driver/DistroTest.cpp --- ToolChains tests ---------------===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//
// Unit tests for Distro detection.
//
//===----------------------------------------------------------------------===//
#include "clang/Driver/Distro.h"
#include "clang/Basic/VirtualFileSystem.h"
#include "llvm/Support/raw_ostream.h"
#include "gtest/gtest.h"
using namespace clang;
using namespace clang::driver;
namespace {
// The tests include all release-related files for each distribution
// in the VFS, in order to make sure that earlier tests do not
// accidentally result in incorrect distribution guess.
TEST(DistroTest, DetectUbuntu) {
vfs::InMemoryFileSystem UbuntuTrustyFileSystem;
// Ubuntu uses Debian Sid version.
UbuntuTrustyFileSystem.addFile("/etc/debian_version", 0,
llvm::MemoryBuffer::getMemBuffer("jessie/sid\n"));
UbuntuTrustyFileSystem.addFile("/etc/lsb-release", 0,
llvm::MemoryBuffer::getMemBuffer("DISTRIB_ID=Ubuntu\n"
"DISTRIB_RELEASE=14.04\n"
"DISTRIB_CODENAME=trusty\n"
"DISTRIB_DESCRIPTION=\"Ubuntu 14.04 LTS\"\n"));
UbuntuTrustyFileSystem.addFile("/etc/os-release", 0,
llvm::MemoryBuffer::getMemBuffer("NAME=\"Ubuntu\"\n"
"VERSION=\"14.04, Trusty Tahr\"\n"
"ID=ubuntu\n"
"ID_LIKE=debian\n"
"PRETTY_NAME=\"Ubuntu 14.04 LTS\"\n"
"VERSION_ID=\"14.04\"\n"
"HOME_URL=\"http://www.ubuntu.com/\"\n"
"SUPPORT_URL=\"http://help.ubuntu.com/\"\n"
"BUG_REPORT_URL=\"http://bugs.launchpad.net/ubuntu/\"\n"));
Distro UbuntuTrusty{UbuntuTrustyFileSystem};
ASSERT_EQ(Distro(Distro::UbuntuTrusty), UbuntuTrusty);
ASSERT_TRUE(UbuntuTrusty.IsUbuntu());
ASSERT_FALSE(UbuntuTrusty.IsRedhat());
ASSERT_FALSE(UbuntuTrusty.IsOpenSUSE());
ASSERT_FALSE(UbuntuTrusty.IsDebian());
vfs::InMemoryFileSystem UbuntuYakketyFileSystem;
UbuntuYakketyFileSystem.addFile("/etc/debian_version", 0,
llvm::MemoryBuffer::getMemBuffer("stretch/sid\n"));
UbuntuYakketyFileSystem.addFile("/etc/lsb-release", 0,
llvm::MemoryBuffer::getMemBuffer("DISTRIB_ID=Ubuntu\n"
"DISTRIB_RELEASE=16.10\n"
"DISTRIB_CODENAME=yakkety\n"
"DISTRIB_DESCRIPTION=\"Ubuntu 16.10\"\n"));
UbuntuYakketyFileSystem.addFile("/etc/os-release", 0,
llvm::MemoryBuffer::getMemBuffer("NAME=\"Ubuntu\"\n"
"VERSION=\"16.10 (Yakkety Yak)\"\n"
"ID=ubuntu\n"
"ID_LIKE=debian\n"
"PRETTY_NAME=\"Ubuntu 16.10\"\n"
"VERSION_ID=\"16.10\"\n"
"HOME_URL=\"http://www.ubuntu.com/\"\n"
"SUPPORT_URL=\"http://help.ubuntu.com/\"\n"
"BUG_REPORT_URL=\"http://bugs.launchpad.net/ubuntu/\"\n"
"PRIVACY_POLICY_URL=\"http://www.ubuntu.com/legal/terms-and-policies/privacy-policy\"\n"
"VERSION_CODENAME=yakkety\n"
"UBUNTU_CODENAME=yakkety\n"));
Distro UbuntuYakkety{UbuntuYakketyFileSystem};
ASSERT_EQ(Distro(Distro::UbuntuYakkety), UbuntuYakkety);
ASSERT_TRUE(UbuntuYakkety.IsUbuntu());
ASSERT_FALSE(UbuntuYakkety.IsRedhat());
ASSERT_FALSE(UbuntuYakkety.IsOpenSUSE());
ASSERT_FALSE(UbuntuYakkety.IsDebian());
}
TEST(DistroTest, DetectRedhat) {
vfs::InMemoryFileSystem Fedora25FileSystem;
Fedora25FileSystem.addFile("/etc/system-release-cpe", 0,
llvm::MemoryBuffer::getMemBuffer("cpe:/o:fedoraproject:fedora:25\n"));
// Both files are symlinks to fedora-release.
Fedora25FileSystem.addFile("/etc/system-release", 0,
llvm::MemoryBuffer::getMemBuffer("Fedora release 25 (Twenty Five)\n"));
Fedora25FileSystem.addFile("/etc/redhat-release", 0,
llvm::MemoryBuffer::getMemBuffer("Fedora release 25 (Twenty Five)\n"));
Fedora25FileSystem.addFile("/etc/fedora-release", 0,
llvm::MemoryBuffer::getMemBuffer("Fedora release 25 (Twenty Five)\n"));
Fedora25FileSystem.addFile("/etc/os-release", 0,
llvm::MemoryBuffer::getMemBuffer("NAME=Fedora\n"
"VERSION=\"25 (Twenty Five)\"\n"
"ID=fedora\n"
"VERSION_ID=25\n"
"PRETTY_NAME=\"Fedora 25 (Twenty Five)\"\n"
"ANSI_COLOR=\"0;34\"\n"
"CPE_NAME=\"cpe:/o:fedoraproject:fedora:25\"\n"
"HOME_URL=\"https://fedoraproject.org/\"\n"
"BUG_REPORT_URL=\"https://bugzilla.redhat.com/\"\n"
"REDHAT_BUGZILLA_PRODUCT=\"Fedora\"\n"
"REDHAT_BUGZILLA_PRODUCT_VERSION=25\n"
"REDHAT_SUPPORT_PRODUCT=\"Fedora\"\n"
"REDHAT_SUPPORT_PRODUCT_VERSION=25\n"
"PRIVACY_POLICY_URL=https://fedoraproject.org/wiki/Legal:PrivacyPolicy\n"));
Distro Fedora25{Fedora25FileSystem};
ASSERT_EQ(Distro(Distro::Fedora), Fedora25);
ASSERT_FALSE(Fedora25.IsUbuntu());
ASSERT_TRUE(Fedora25.IsRedhat());
ASSERT_FALSE(Fedora25.IsOpenSUSE());
ASSERT_FALSE(Fedora25.IsDebian());
vfs::InMemoryFileSystem CentOS7FileSystem;
CentOS7FileSystem.addFile("/etc/system-release-cpe", 0,
llvm::MemoryBuffer::getMemBuffer("cpe:/o:centos:centos:7\n"));
// Both files are symlinks to centos-release.
CentOS7FileSystem.addFile("/etc/system-release", 0,
llvm::MemoryBuffer::getMemBuffer("CentOS Linux release 7.2.1511 (Core) \n"));
CentOS7FileSystem.addFile("/etc/redhat-release", 0,
llvm::MemoryBuffer::getMemBuffer("CentOS Linux release 7.2.1511 (Core) \n"));
CentOS7FileSystem.addFile("/etc/centos-release", 0,
llvm::MemoryBuffer::getMemBuffer("CentOS Linux release 7.2.1511 (Core) \n"));
CentOS7FileSystem.addFile("/etc/centos-release-upstream", 0,
llvm::MemoryBuffer::getMemBuffer("Derived from Red Hat Enterprise Linux 7.2 (Source)\n"));
CentOS7FileSystem.addFile("/etc/os-release", 0,
llvm::MemoryBuffer::getMemBuffer("NAME=\"CentOS Linux\"\n"
"VERSION=\"7 (Core)\"\n"
"ID=\"centos\"\n"
"ID_LIKE=\"rhel fedora\"\n"
"VERSION_ID=\"7\"\n"
"PRETTY_NAME=\"CentOS Linux 7 (Core)\"\n"
"ANSI_COLOR=\"0;31\"\n"
"CPE_NAME=\"cpe:/o:centos:centos:7\"\n"
"HOME_URL=\"https://www.centos.org/\"\n"
"BUG_REPORT_URL=\"https://bugs.centos.org/\"\n"
"\n"
"CENTOS_MANTISBT_PROJECT=\"CentOS-7\"\n"
"CENTOS_MANTISBT_PROJECT_VERSION=\"7\"\n"
"REDHAT_SUPPORT_PRODUCT=\"centos\"\n"
"REDHAT_SUPPORT_PRODUCT_VERSION=\"7\"\n"));
Distro CentOS7{CentOS7FileSystem};
ASSERT_EQ(Distro(Distro::RHEL7), CentOS7);
ASSERT_FALSE(CentOS7.IsUbuntu());
ASSERT_TRUE(CentOS7.IsRedhat());
ASSERT_FALSE(CentOS7.IsOpenSUSE());
ASSERT_FALSE(CentOS7.IsDebian());
}
TEST(DistroTest, DetectOpenSUSE) {
vfs::InMemoryFileSystem OpenSUSELeap421FileSystem;
OpenSUSELeap421FileSystem.addFile("/etc/SuSE-release", 0,
llvm::MemoryBuffer::getMemBuffer("openSUSE 42.1 (x86_64)\n"
"VERSION = 42.1\n"
"CODENAME = Malachite\n"
"# /etc/SuSE-release is deprecated and will be removed in the future, use /etc/os-release instead\n"));
OpenSUSELeap421FileSystem.addFile("/etc/os-release", 0,
llvm::MemoryBuffer::getMemBuffer("NAME=\"openSUSE Leap\"\n"
"VERSION=\"42.1\"\n"
"VERSION_ID=\"42.1\"\n"
"PRETTY_NAME=\"openSUSE Leap 42.1 (x86_64)\"\n"
"ID=opensuse\n"
"ANSI_COLOR=\"0;32\"\n"
"CPE_NAME=\"cpe:/o:opensuse:opensuse:42.1\"\n"
"BUG_REPORT_URL=\"https://bugs.opensuse.org\"\n"
"HOME_URL=\"https://opensuse.org/\"\n"
"ID_LIKE=\"suse\"\n"));
Distro OpenSUSELeap421{OpenSUSELeap421FileSystem};
ASSERT_EQ(Distro(Distro::OpenSUSE), OpenSUSELeap421);
ASSERT_FALSE(OpenSUSELeap421.IsUbuntu());
ASSERT_FALSE(OpenSUSELeap421.IsRedhat());
ASSERT_TRUE(OpenSUSELeap421.IsOpenSUSE());
ASSERT_FALSE(OpenSUSELeap421.IsDebian());
vfs::InMemoryFileSystem OpenSUSE132FileSystem;
OpenSUSE132FileSystem.addFile("/etc/SuSE-release", 0,
llvm::MemoryBuffer::getMemBuffer("openSUSE 13.2 (x86_64)\n"
"VERSION = 13.2\n"
"CODENAME = Harlequin\n"
"# /etc/SuSE-release is deprecated and will be removed in the future, use /etc/os-release instead\n"));
OpenSUSE132FileSystem.addFile("/etc/os-release", 0,
llvm::MemoryBuffer::getMemBuffer("NAME=openSUSE\n"
"VERSION=\"13.2 (Harlequin)\"\n"
"VERSION_ID=\"13.2\"\n"
"PRETTY_NAME=\"openSUSE 13.2 (Harlequin) (x86_64)\"\n"
"ID=opensuse\n"
"ANSI_COLOR=\"0;32\"\n"
"CPE_NAME=\"cpe:/o:opensuse:opensuse:13.2\"\n"
"BUG_REPORT_URL=\"https://bugs.opensuse.org\"\n"
"HOME_URL=\"https://opensuse.org/\"\n"
"ID_LIKE=\"suse\"\n"));
Distro OpenSUSE132{OpenSUSE132FileSystem};
ASSERT_EQ(Distro(Distro::OpenSUSE), OpenSUSE132);
ASSERT_FALSE(OpenSUSE132.IsUbuntu());
ASSERT_FALSE(OpenSUSE132.IsRedhat());
ASSERT_TRUE(OpenSUSE132.IsOpenSUSE());
ASSERT_FALSE(OpenSUSE132.IsDebian());
vfs::InMemoryFileSystem SLES10FileSystem;
SLES10FileSystem.addFile("/etc/SuSE-release", 0,
llvm::MemoryBuffer::getMemBuffer("SUSE Linux Enterprise Server 10 (x86_64)\n"
"VERSION = 10\n"
"PATCHLEVEL = 4\n"));
SLES10FileSystem.addFile("/etc/lsb_release", 0,
llvm::MemoryBuffer::getMemBuffer("LSB_VERSION=\"core-2.0-noarch:core-3.0-noarch:core-2.0-x86_64:core-3.0-x86_64\"\n"));
// SLES10 is unsupported and therefore evaluates to unknown
Distro SLES10{SLES10FileSystem};
ASSERT_EQ(Distro(Distro::UnknownDistro), SLES10);
ASSERT_FALSE(SLES10.IsUbuntu());
ASSERT_FALSE(SLES10.IsRedhat());
ASSERT_FALSE(SLES10.IsOpenSUSE());
ASSERT_FALSE(SLES10.IsDebian());
}
TEST(DistroTest, DetectDebian) {
vfs::InMemoryFileSystem DebianJessieFileSystem;
DebianJessieFileSystem.addFile("/etc/debian_version", 0,
llvm::MemoryBuffer::getMemBuffer("8.6\n"));
DebianJessieFileSystem.addFile("/etc/os-release", 0,
llvm::MemoryBuffer::getMemBuffer("PRETTY_NAME=\"Debian GNU/Linux 8 (jessie)\"\n"
"NAME=\"Debian GNU/Linux\"\n"
"VERSION_ID=\"8\"\n"
"VERSION=\"8 (jessie)\"\n"
"ID=debian\n"
"HOME_URL=\"http://www.debian.org/\"\n"
"SUPPORT_URL=\"http://www.debian.org/support\"\n"
"BUG_REPORT_URL=\"https://bugs.debian.org/\"\n"));
Distro DebianJessie{DebianJessieFileSystem};
ASSERT_EQ(Distro(Distro::DebianJessie), DebianJessie);
ASSERT_FALSE(DebianJessie.IsUbuntu());
ASSERT_FALSE(DebianJessie.IsRedhat());
ASSERT_FALSE(DebianJessie.IsOpenSUSE());
ASSERT_TRUE(DebianJessie.IsDebian());
vfs::InMemoryFileSystem DebianStretchSidFileSystem;
DebianStretchSidFileSystem.addFile("/etc/debian_version", 0,
llvm::MemoryBuffer::getMemBuffer("stretch/sid\n"));
DebianStretchSidFileSystem.addFile("/etc/os-release", 0,
llvm::MemoryBuffer::getMemBuffer("PRETTY_NAME=\"Debian GNU/Linux stretch/sid\"\n"
"NAME=\"Debian GNU/Linux\"\n"
"ID=debian\n"
"HOME_URL=\"http://www.debian.org/\"\n"
"SUPPORT_URL=\"http://www.debian.org/support\"\n"
"BUG_REPORT_URL=\"https://bugs.debian.org/\"\n"));
Distro DebianStretchSid{DebianStretchSidFileSystem};
ASSERT_EQ(Distro(Distro::DebianStretch), DebianStretchSid);
ASSERT_FALSE(DebianStretchSid.IsUbuntu());
ASSERT_FALSE(DebianStretchSid.IsRedhat());
ASSERT_FALSE(DebianStretchSid.IsOpenSUSE());
ASSERT_TRUE(DebianStretchSid.IsDebian());
}
TEST(DistroTest, DetectExherbo) {
vfs::InMemoryFileSystem ExherboFileSystem;
ExherboFileSystem.addFile("/etc/exherbo-release", 0, // (ASCII art)
llvm::MemoryBuffer::getMemBuffer(""));
ExherboFileSystem.addFile("/etc/os-release", 0,
llvm::MemoryBuffer::getMemBuffer("NAME=\"Exherbo\"\n"
"PRETTY_NAME=\"Exherbo Linux\"\n"
"ID=\"exherbo\"\n"
"ANSI_COLOR=\"0;32\"\n"
"HOME_URL=\"https://www.exherbo.org/\"\n"
"SUPPORT_URL=\"irc://irc.freenode.net/#exherbo\"\n"
"BUG_REPORT_URL=\"https://bugs.exherbo.org/\"\n"));
Distro Exherbo{ExherboFileSystem};
ASSERT_EQ(Distro(Distro::Exherbo), Exherbo);
ASSERT_FALSE(Exherbo.IsUbuntu());
ASSERT_FALSE(Exherbo.IsRedhat());
ASSERT_FALSE(Exherbo.IsOpenSUSE());
ASSERT_FALSE(Exherbo.IsDebian());
}
TEST(DistroTest, DetectArchLinux) {
vfs::InMemoryFileSystem ArchLinuxFileSystem;
ArchLinuxFileSystem.addFile("/etc/arch-release", 0, // (empty)
llvm::MemoryBuffer::getMemBuffer(""));
ArchLinuxFileSystem.addFile("/etc/os-release", 0,
llvm::MemoryBuffer::getMemBuffer("NAME=\"Arch Linux\"\n"
"ID=arch\n"
"PRETTY_NAME=\"Arch Linux\"\n"
"ANSI_COLOR=\"0;36\"\n"
"HOME_URL=\"https://www.archlinux.org/\"\n"
"SUPPORT_URL=\"https://bbs.archlinux.org/\"\n"
"BUG_REPORT_URL=\"https://bugs.archlinux.org/\"\n"));
Distro ArchLinux{ArchLinuxFileSystem};
ASSERT_EQ(Distro(Distro::ArchLinux), ArchLinux);
ASSERT_FALSE(ArchLinux.IsUbuntu());
ASSERT_FALSE(ArchLinux.IsRedhat());
ASSERT_FALSE(ArchLinux.IsOpenSUSE());
ASSERT_FALSE(ArchLinux.IsDebian());
}
} // end anonymous namespace