rest-for-physics / rest-for-physics/framework

Pipe validation to check initialisation code in metadata classes

Open
#14 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

development
Dominant language
C++
Stars
19
Forks
14
PR merge metrics
No merged PRs in 30d

Description

All metadata classes must define at its initialisation stage the corresponding class name, and the LIBRARY_VERSION. Which is usually as follows:

void TRestMetadataClass::Initialize() {
    SetSectionName(this->ClassName());
    SetLibraryVersion(LIBRARY_VERSION);
}

We need a script running at the pipeline before the build stage to assure this is as that. This will only be tested at metadata classes under source/libraries. It could be inspired by pipeline/validateProcesses.py

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading pipeline/validateProcesses.py and inspecting the metadata classes under source/libraries. Trace how the pipeline runs before the build stage and identify how those classes initialize their class name and LIBRARY_VERSION. Done means the pipeline reports missing or incorrect initialization in the targeted metadata classes.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
build-system, ci-cd
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.