Project

General

Profile

Actions

action #96675

closed

coordination #96596: [qe-core][CI] CI/CD and Coding style improvements

[qe-core] Add CI check preventing obsolete use of `check_var('VAR')

Added by apappas over 2 years ago. Updated over 2 years ago.

Status:
Resolved
Priority:
Normal
Assignee:
Category:
Enhancement to existing tests
Target version:
Start date:
2021-08-09
Due date:
% Done:

0%

Estimated time:
Difficulty:
medium

Description

Story

As a code reviewer I would like the CI to do menial checks so that I can focus on bigger details and be more effective with my work.

Background

Many uses of the check_var() have been obsoleted by fuctions like is_qemu and is_aarch64 which are more legible and should be the only way those conditions are checked.

Acceptance Criteria

  • AC1: Propose checks as an RFC in the os-autoinst-distri-opensuse repo.
  • AC2: Add a corresponding entry in the contributing document.
  • AC3: Make the mechanism extensible to new variables.

Initial Thoughts

  • Create a hash table in yaml, json, xml, CORBA, toml, $MARKUPLANGUAGE to check with a regex for a syntax that when matching, would propose a suggestion.
  • Use etherpad.nue.suse.com/qe-core-proposed-syntax-checks to add the proposals.
Actions

Also available in: Atom PDF