qmk/qmk_firmware

[Bug] Server CI mistakenly infers presence of failing keymap based on .py file.

Open

#19,099 opened on Nov 16, 2022

View on GitHub
 (1 comment) (0 reactions) (1 assignee)C (43,867 forks)batch import
bughelp wanted

Repository metrics

Stars
 (20,368 stars)
PR merge metrics
 (Avg merge 20d 9h) (27 merged PRs in 30d)

Description

Describe the Bug

Server CI mistakenly infers presence of a failing keymap in keyboards/foo/keymaps/ from existence of a .py file.

This was triggered in #18751 by presence of an existing pretty print script keyboards/hillside/48/keymaps/json2hill48.py. That file, attached, is now removed in that PR, but adding it back should trigger the issue. json2hill48.py.zip

Quoting from sigprof's analysis in the above PR: """ The problem is this part of the CI code: https://github.com/qmk/qmk_ci_executor/blob/88605f9607f8554535c8b8d168f9797ce950b3a0/runner/app/ci_worker.py#L288-L300 together with the presence of keyboards/hillside/48/keymaps/json2hill48.py in this PR.

The CI code mistakenly parses the keyboards/hillside/48/keymaps/json2hill48.py path and infers keymap="keymaps", possible_keyboard="hillside" from it, then that nonexistent keymap gets added for all hillside/* keyboards. """

Keyboard Used

n/a

Link to product page (if applicable)

No response

Operating System

n/a

qmk doctor Output

n/a

Is AutoHotKey / Karabiner installed

  • AutoHotKey (Windows)
  • Karabiner (macOS)

Other keyboard-related software installed

n/a

Additional Context

above

Contributor guide

Research direction
Inspect the CI code at runner/app/ci worker.py lines 288-300. The path parsing logic incorrectly extracts keymap name from .py files. Trace how the path is split and understand the assumption that keymaps are only under subdirectories named after keymaps. Consider adding a filter to ignore non directory files.
Tech stack
python
Domain
backendci cd
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50