add a manifest for cpufreq scaling test (Bugfix) by stanley31huang · Pull Request #2425 · canonical/checkbox

stanley31huang · 2026-03-25T09:58:45Z

Description

add a manifest for cpufreq scaling test, as this feature is not supported on new i.MX9 SoC

Resolved issues

Documentation

Tests

test result when cpu policy is available

https://certification.canonical.com/hardware/202501-36212/submission/488805/

test result when cpu policy is unavailable

ubuntu@juju-8ab9e7-7:~$ checkbox-cli control 10.102.181.187
Connecting to 10.102.181.187:18871. Timeout: 600s
Agent is using sideloaded providers
=========[ Bootstrap com.canonical.contrib::cpufreq_policy_list (1/1) ]=========
--------------------------------------------------------------------------------
Outcome: job passed
There were no tests to select from!

seankingyang · 2026-03-25T10:39:19Z

LGTM~
Could you add more explain more about what kind of CPU not support the cpu scalling (ie intel_pstate amd-pstate amd-pstate-epp )?

tomli380576 · 2026-03-26T02:03:09Z

also should we update checkbox-provider-ce-oem/units/cpu/jobs.pxu to use this manifest?

fix black issue

stanley31huang · 2026-04-22T05:37:23Z

this PR will change the CPU governor test as following scenario

In the resource job, it will print out all CPU policy with avaiable scaling governor
the corresponding CPU governor tests will be run based on governor listed in available scaling governor.
Remove cpu driver detect test as it's not supported for all platform.

revised the cpu scaling test classes

fix black8

fix format and compatible with py35

update test job and scripts

fix coding style check issue

updated job requires

fix for no available cpu policy

tomli380576

the comments are mostly refactoring suggestions, lmk if i misunderstood anything

tomli380576 · 2026-05-21T05:36:04Z

+    def test_governor(self) -> bool:
+        """
+        Run the CPU Scaling Governor Test.
+
+        This function is a placeholder for running the CPU scaling governor
+        test. It should be implemented in the subclasses for specific
+        governors.
+
+        Returns:
+            bool: True if the test passes, False otherwise.
+        """
+        raise NotImplementedError(
+            "This method should be implemented in subclass."
+        )


I think the more idiomatic way to do this is with an abstract base class:

-class CPUScalingTest +class CPUScalingTest(abc.ABC)

then at the method definition, decorate it:

@abc.abstractmethod def test_governor(self) -> bool: # no need to write anything in the method body pass

this can also prevent the base class from being constructed altogether.

tomli380576 · 2026-05-21T05:47:48Z

+    _registry = {}
+
+    @classmethod
+    def register(cls, key):
+        """Register test classes by governor name."""
+
+        def decorator(test_cls):
+            cls._registry[key] = test_cls
+            return test_cls
+
+        return decorator


optional: i think it's less convoluted to just use a dict in main and put the class names in there:

# inside main TEST_CLASSES = { "powersave": PowersaveCPUScalingTest "schedutil": SchedutilCPUScalingTest # ...other ones } if args.governor not in TEST_CLASSES: raise SystemExit("Unavailable governor: {}".format(args.governor)) # governor available, do the rest of main for governor, test_class in TEST_CLASSES.items(): # do stuff

this can also eliminate the .create() method and allow main() to use normal class constructors

tomli380576 · 2026-05-21T05:56:53Z

 class CPUScalingTest:
    """A class for CPU scaling test operations."""

+    test_description = ""


in the child classes this was changed to description, did you mean to use 2 different names?

If not, a more robust way to enforce the existence of test_description is to use an abstract property

# requires the parent class to be abstract class CPUScalingTest(abc.ABC): @property @abc.abstractmethod def test_description() -> str: pass class UserspaceCPUScalingTest(CPUScalingTest): @property def test_description() -> str: return "some test description" # access it like a normal property t = UserspaceCPUScalingTest() print(t.test_description)

If the child class doesn't implement test_description, python will raise this:

TypeError: Can't instantiate abstract class UserspaceCPUScalingTest with abstract methods test_description

because not implementing the entire ABC's interface makes the child class implicitly abstract, thus cannot be constructed.

tomli380576 · 2026-05-21T06:00:04Z

-            print("cpb: {}".format(self.get_cpb(policy)))
-            print()
-        return True
+            self.policy = policy


is there a reason why we need to keep overwriting self.policy?

tomli380576 · 2026-05-21T06:02:47Z

+    @classmethod
+    def create(cls, governor, policy=0):
+        """
+        Create a test instance by governor name.
+
+        Args:
+            governor (str): The name of the governor test to create.
+            policy (int): The CPU policy number to be used (default is 0).
+
+        Returns:
+            CPUScalingTest: An instance of the appropriate test class.
+
+        Raises:
+            ValueError: If the governor is not supported.
+        """
+        test_class = cls._registry.get(governor.lower())
+        if test_class is None:
+            raise ValueError(
+                "Governor '{}' not supported. Available: {}".format(
+                    governor, ", ".join(sorted(cls._registry.keys()))
+                )
+            )
+        return test_class(policy=policy)


see the comment on 514

tomli380576 · 2026-05-21T06:08:01Z

-            probe_governor_module(args.governor)
-        if not getattr(test, "test_{}".format(args.governor))():
+            logging.error(
+                "Governor '%s' is not supported by CPU policy%s",


use .format()

tomli380576 · 2026-05-21T06:09:19Z

-    except AttributeError:
-        logging.error("Given governor is not supported")
+    except ValueError as err:
+        logging.error(str(err))


optional: depending on if you want to see the literal ValueError string, you could use repr

stanley31huang added the ce-oem The PR only contains to the ce-oem provider under the contrib area label Mar 25, 2026

tomli380576 reviewed Mar 26, 2026

View reviewed changes

Comment thread contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/cpu/jobs.pxu Outdated

stanley31huang marked this pull request as draft March 31, 2026 05:51

cpu: run governor tests only for available scaling governors

827dc0c

stanley31huang force-pushed the add-manifest-for-cpufreq branch from 7468d5c to 827dc0c Compare April 22, 2026 05:17

stanley31huang marked this pull request as ready for review April 22, 2026 05:22

fix black issue

c69859e

fix black issue

stanley31huang added 3 commits April 22, 2026 20:40

revised the cpu scaling test classes

d01611f

revised the cpu scaling test classes

fix black8

547f38d

fix black8

fix format and compatible with Py35

6b22300

fix format and compatible with py35

stanley31huang force-pushed the add-manifest-for-cpufreq branch from 74b7a8a to 6b22300 Compare April 23, 2026 05:38

stanley31huang added 3 commits April 23, 2026 14:44

update test job and scripts

2965f27

update test job and scripts

fix coding style check issue

e390fb7

fix coding style check issue

updated job requires

d39820b

updated job requires

stanley31huang requested a review from tomli380576 May 19, 2026 07:13

fix for no available cpu policy

77dedec

fix for no available cpu policy

tomli380576 self-assigned this May 21, 2026

tomli380576 requested changes May 21, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add a manifest for cpufreq scaling test (Bugfix)#2425

add a manifest for cpufreq scaling test (Bugfix)#2425
stanley31huang wants to merge 9 commits into
mainfrom
add-manifest-for-cpufreq

stanley31huang commented Mar 25, 2026 •

edited

Loading

Uh oh!

seankingyang commented Mar 25, 2026

Uh oh!

Uh oh!

tomli380576 commented Mar 26, 2026

Uh oh!

stanley31huang commented Apr 22, 2026

Uh oh!

tomli380576 left a comment

Uh oh!

Uh oh!

tomli380576 May 21, 2026

Uh oh!

tomli380576 May 21, 2026 •

edited

Loading

Uh oh!

tomli380576 May 21, 2026

Uh oh!

tomli380576 May 21, 2026

Uh oh!

tomli380576 May 21, 2026

Uh oh!

Uh oh!

tomli380576 May 21, 2026

Uh oh!

tomli380576 May 21, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

stanley31huang commented Mar 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Resolved issues

Documentation

Tests

test result when cpu policy is available

test result when cpu policy is unavailable

Uh oh!

seankingyang commented Mar 25, 2026

Uh oh!

Uh oh!

tomli380576 commented Mar 26, 2026

Uh oh!

stanley31huang commented Apr 22, 2026

Uh oh!

tomli380576 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

tomli380576 May 21, 2026

Choose a reason for hiding this comment

Uh oh!

tomli380576 May 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tomli380576 May 21, 2026

Choose a reason for hiding this comment

Uh oh!

tomli380576 May 21, 2026

Choose a reason for hiding this comment

Uh oh!

tomli380576 May 21, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

tomli380576 May 21, 2026

Choose a reason for hiding this comment

Uh oh!

tomli380576 May 21, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

stanley31huang commented Mar 25, 2026 •

edited

Loading

tomli380576 May 21, 2026 •

edited

Loading