Merge ~canonical-kernel-team/+git/autotest-client-tests:phlin/kselftest-ftrace into ~canonical-kernel-team/+git/autotest-client-tests:master

[Po-Hsu Lin]

ftrace test sometimes will hang and make ubuntu_kernel_selftests ended
up in an incomplete state.

Split it out to improve the test granularity and flexibility and thus
make it easier to debug.

The ftrace test in ubuntu_kernel_selftests is not removed in this
commit, it will be removed after everything is in place and we have
test results coming out from this newly added ubuntu_kselftests_ftrace
test.

Test split to ubuntu_kselftest_ftrace, ran a quick test on X (although it's blacklisted on X), B, F, J, K. The test can be build and run without any issue.

[Andrei Gherzan (agherzan)]

+1

review: Approve

[Francis Ginther (fginther)]

review: Approve

[Po-Hsu Lin (cypressyew)]

Applied and pushed, thanks!

diff --git a/ubuntu_kselftests_ftrace/blacklist.trusty b/ubuntu_kselftests_ftrace/blacklist.trusty
new file mode 100644
index 0000000..41196ed
--- /dev/null
+++ b/ubuntu_kselftests_ftrace/blacklist.trusty
@@ -0,0 +1 @@
+Blacklisted as we don't have ftrace test in Trusty
diff --git a/ubuntu_kselftests_ftrace/blacklist.xenial b/ubuntu_kselftests_ftrace/blacklist.xenial
new file mode 100644
index 0000000..022473f
--- /dev/null
+++ b/ubuntu_kselftests_ftrace/blacklist.xenial
@@ -0,0 +1,2 @@
+Blacklisted as in ubuntu_kernel_selftests we don't run ftrace test on Xenial
+see ubuntu_kernel_selftests/control.ubuntu.xenial
diff --git a/ubuntu_kselftests_ftrace/control b/ubuntu_kselftests_ftrace/control
new file mode 100644
index 0000000..e64acbd
--- /dev/null
+++ b/ubuntu_kselftests_ftrace/control
@@ -0,0 +1,68 @@
+AUTHOR = "Ubuntu"
+NAME = 'ubuntu_kernel_selftests'
+CRITERIA = """
+Uses built-in kernel repository self tests for ftrace.
+"""
+SUITE = "None"
+TIME = "SHORT"
+TEST_CLASS = 'kernel'
+TEST_CATEGORY = 'Functional'
+TEST_TYPE = "client"
+DOC = ""
+
+
+categories = ['ftrace']
+arch = platform.machine()
+arch_scale = 1
+# Scale timeouts by 2 for riscv64, some tests timeout due to lack of
+# timeout, despite progressing fine
+if arch in ['riscv64']:
+   arch_scale = 2
+
+result = job.run_test_detail(NAME, test_name='setup', tag='setup', timeout=arch_scale*60*45)
+if result == 'GOOD':
+    for category in categories:
+        build = '{}-build'.format(category)
+        result = job.run_test_detail(NAME, test_name=build, tag=build, timeout=arch_scale*60*60)
+        if result == 'ERROR':
+            print("ERROR: test suite '{}' failed to build, skipping all the sub tests".format(category))
+            continue
+        mk_helper = os.path.join(job.testdir, NAME, 'helper.mk')
+        dir_root = os.path.join(job.bindir, 'tmp', NAME, 'src', 'linux/tools/testing/selftests/')
+        dir_src = os.path.join(dir_root, category)
+        mk_src = os.path.join(dir_src, 'Makefile')
+        os.chdir(dir_src)
+        cmd = 'grep SUB_DIRS {}'.format(mk_src)
+        timeout_threshold = arch_scale*60*30
+        if utils.system_output(cmd, verbose=False, ignore_status=True):
+            cmd = 'make -f {} -f {} getsubdirs'.format(mk_helper, mk_src)
+            subdirs = utils.system_output(cmd).split()
+            for subdir in subdirs:
+                dir_src = os.path.join(dir_root, category, subdir)
+                os.chdir(dir_src)
+                mk_src = os.path.join(dir_src, 'Makefile')
+                if os.path.isfile(mk_src):
+                   cmd = 'make -f {} -f {} gettests'.format(mk_src, mk_helper)
+                   tests = utils.system_output(cmd).split()
+                   for item in tests:
+                       test = "{}/{}:{}".format(category, subdir, item)
+                       job.run_test_detail(NAME, test_name=test, tag=test, timeout=timeout_threshold)
+        elif os.path.isfile(mk_src):
+            cmd = 'make -f {} -f {} gettests'.format(mk_src, mk_helper)
+            tests = utils.system_output(cmd).split()
+            for item in tests:
+                timeout_threshold = arch_scale*60*45
+                if item == 'ftracetest':
+                    if arch == 'riscv64':
+                        # autotest timeout on riscv64 is incorrect (lp:1940080), disable it
+                        # It takes about 22 mins on 5.15 and about 35 mins on 5.13
+                        timeout_threshold = 0
+                    else:
+                        # ftracetest will take about ~60 minutes to run on some instances (lp:2008063)
+                        timeout_threshold = 60 * 75
+                test = "{}:{}".format(category, item)
+                job.run_test_detail(NAME, test_name=test, tag=test, timeout=timeout_threshold)
+    else:
+        print("ERROR: test failed to build, skipping all the sub tests")
+
+# vi:set ts=4 sw=4 expandtab syntax=python:
diff --git a/ubuntu_kselftests_ftrace/helper.mk b/ubuntu_kselftests_ftrace/helper.mk
new file mode 100755
index 0000000..ab3bb36
--- /dev/null
+++ b/ubuntu_kselftests_ftrace/helper.mk
@@ -0,0 +1,5 @@
+gettests:
+	@echo '$(notdir $(TEST_GEN_PROGS)) $(notdir $(TEST_CUSTOM_PROGS)) $(notdir $(TEST_PROGS))'
+
+getsubdirs:
+	@echo '$(SUB_DIRS)'
diff --git a/ubuntu_kselftests_ftrace/ubuntu_kernel_selftests.py b/ubuntu_kselftests_ftrace/ubuntu_kernel_selftests.py
new file mode 100644
index 0000000..742fbde
--- /dev/null
+++ b/ubuntu_kselftests_ftrace/ubuntu_kernel_selftests.py
@@ -0,0 +1,114 @@
+#
+#
+import os
+import platform
+import re
+from autotest.client                        import test, utils
+from autotest.client.shared                 import error
+
+class ubuntu_kernel_selftests(test.test):
+    version = 1
+
+    def install_required_pkgs(self):
+        '''Function to install necessary packages.'''
+        pkgs = [
+            'debhelper',
+            'dpkg-dev',
+            'git',
+        ]
+        gcc = 'gcc' if self.arch in ['ppc64le', 'aarch64', 's390x', 'riscv64'] else 'gcc-multilib'
+        pkgs.append(gcc)
+
+        cmd = 'yes "" | DEBIAN_FRONTEND=noninteractive apt-get install --yes --force-yes ' + ' '.join(pkgs)
+        utils.system_output(cmd, retain_output=True)
+
+    def initialize(self):
+        self.arch = platform.processor()
+        self.flavour = re.split('-\d*-', platform.uname()[2])[-1]
+        try:
+            self.series = platform.dist()[2]
+        except AttributeError:
+            import distro
+            self.series = distro.codename()
+        self.kv = platform.release().split(".")[:2]
+        self.kv = int(self.kv[0]) * 100 + int(self.kv[1])
+
+    def download(self):
+        '''Function to download kernel source.'''
+        cmd = "dpkg -S /lib/modules/" + platform.release() + "/kernel | cut -d: -f 1 | cut -d, -f 1"
+        pkg = os.popen(cmd).readlines()[0].strip()
+        utils.system("apt-get source --download-only " + pkg)
+
+    def extract(self):
+        '''Function to extract kernel source.'''
+        os.system("rm -rf linux/")
+        utils.system("dpkg-source -x linux*dsc linux")
+
+    def setup(self):
+        '''Function to setup the test environment.'''
+        self.install_required_pkgs()
+        self.job.require_gcc()
+        os.chdir(self.srcdir)
+
+        # Use a local repo for manual testing. If it does not exist, then clone from the master
+        # repository.
+        #
+        if not os.path.exists('linux'):
+            self.download()
+            self.extract()
+
+            # clean source tree so changes from debian.foo/reconstruct
+            # (e.g. deleting files) are applied
+            os.chdir('linux')
+            cmd = 'fakeroot debian/rules clean'
+            utils.system(cmd)
+            os.chdir(self.srcdir)
+
+            #
+            # Disable new ftrace tests that don't work reliably across
+            # architectures because of various symbols being checked
+            #
+            filenames = [
+                'ftrace/func_stack_tracer.tc',
+                'ftrace/func-filter-glob.tc',
+                'trigger/inter-event/trigger-inter-event-combined-hist.tc',
+                'trigger/inter-event/trigger-synthetic-event-createremove.tc',
+                'trigger/trigger-hist.tc',
+                'trigger/trigger-trace-marker-hist.tc',
+                'kprobe/probepoint.tc',
+                'kprobe/kprobe_module.tc',
+            ]
+
+            for fn in filenames:
+                fn = 'linux/tools/testing/selftests/ftrace/test.d/' + fn
+                if os.path.exists(fn):
+                    os.remove(fn)
+
+
+    def run_once(self, test_name):
+        if test_name == 'setup':
+            return
+        if test_name.endswith('-build'):
+            os.chdir(self.srcdir)
+            cmd = "make -C linux/tools/testing/selftests TARGETS={}".format(test_name.replace('-build', ''))
+            utils.system_output(cmd, retain_output=True)
+            return
+
+        category = test_name.split(':')[0]
+        sub_test = test_name.split(':')[1]
+        dir_root = os.path.join(self.srcdir, 'linux', 'tools', 'testing', 'selftests')
+        os.chdir(dir_root)
+        cmd = "make run_tests -C {} TEST_PROGS={} TEST_GEN_PROGS='' TEST_CUSTOM_PROGS=''".format(category, sub_test)
+        result = utils.system_output(cmd, retain_output=True)
+
+        # Old pattern for Xenial
+        pattern = re.compile('selftests: *(?P<case>[\w\-\.]+) \[FAIL\]\n')
+        if re.search(pattern, result):
+            raise error.TestError(test_name + ' failed.')
+        # If the test was not end by previous check, check again with new pattern
+        pattern = re.compile('not ok [\d\.]* selftests: {}: {} # (?!.*SKIP)'.format(category, sub_test))
+        if re.search(pattern, result):
+            raise error.TestError(test_name + ' failed.')
+
+
+# vi:set ts=4 sw=4 expandtab syntax=python: