Add parents' commit hashes to repoVersionStringOut in tribits_generate_single_repo_version_string() #597

achauphan · 2024-01-04T20:22:09Z

Related issues

TRILFRAME-614: Tool to analyze dashboard failures

Description

The current repo version output in TriBITS does not include the current commit's parents (if there are any). The parent commits are desirable in cases such as a merge commit, where examining a merge commit's parents are useful for determining which parents had changes performed to them across other merge commits.

This issue is in relation to [add issue number here], which plans to utilize a merge commit's parent sha1.

The current TriBITS repo version output is:

ProjectName repos versions:
--------------------------------------------------------------------------------
*** Base Git Repo: ProjectName
910f407 [Mon Oct 9 14:11:01 2023 -0600] <[email protected]>
topic branch tip commit message
 --------------------------------------------------------------------------------

The desired output would be something like:

ProjectName repos versions:
--------------------------------------------------------------------------------
*** Base Git Repo: ProjectName
2b9117b [Thu Dec 21 20:12:25 2023 -0700] <[email protected]>
Merge commit '910f40782a2e5dcbe0ce0fd3c176fbb8e276815a' into develop
    *** Parent: 1
    68b1db3da7a [Mon Oct 9 13:21:55 2023 -0400] <[email protected]>
    target branch tip commit message
    *** Parent: 2
    910f40782a2 [Mon Oct 9 14:11:01 2023 -0600] <[email protected]>
    topic branch tip commit message
...
 --------------------------------------------------------------------------------

Proposed Solution

Modify repoVersionStringOut in tribits_generate_single_repo_version_string() to include the parent commits.

The parents of a commit can be found with the following git commands with the same date and author formatting:
git log -1 "--pretty=format:%h [%ad] <%ae>" HEAD^1
git log -1 "--pretty=format:%h [%ad] <%ae>" HEAD^2

Requirements

add new tests that can handle cases where parents are present and not present

The text was updated successfully, but these errors were encountered:

Added test TribitsHelloWorld_config_git_version that uses mockprogram.py as git to generate and check git version info. ToDo: We should also check the generated TribitsHelloWorldRepoVersion.txt file

For some reason, mockprogram.py prints an newline that raw git does not. But this should work for raw git too.

bartlettroscoe · 2024-01-05T00:21:22Z

@achauphan, we need to see if we can get the autotester to always generate a merge commit with git merge --no-ff <topic> even when a merge commit is not needed (because the tip of <topic> is downstream from the tip of <target>, i.e. develop). Otherwise, we need to add more complex logic to TriBITS and/or the Python script that pulls down data from CDash.

Renamed the test TribitsHelloWorld_config_git_version to TribitsHelloWorld_config_git_version_single_repo_one_parent to correctly state the scope of the test and allow for future similar tests with slightly a difference scopes (such as single_repo_two_parents, multi_repo_one_parent, etc).

…euse (#597) Moved git commit info functionality of tribits_generate_single_repo_version_string to a seperate helper function named tribites_generate_commit_info_string. The core functionality and output is the same. This is in prep for reuse of that functionality inside of the original tribits_generate_single_repo_version string.

…#597) Removed trailing whitespace to keep git command outputs consistent with other functions performing git commands and for the output to be more processable.

Renamed the test TribitsHelloWorld_config_git_version to TribitsHelloWorld_config_git_version_single_repo_one_parent to correctly state the scope of the test and allow for future similar tests with slightly a difference scopes (such as single_repo_two_parents, multi_repo_one_parent, etc).

…euse (#597) Moved git commit info functionality of tribits_generate_single_repo_version_string to a separate helper function named tribites_generate_commit_info_string. The core functionality and output is the same. This is in prep for reuse of that functionality inside of the original tribits_generate_single_repo_version string.

…#597) Removed trailing whitespace to keep git command outputs consistent with other functions performing git commands and for the output to be more processable.

Make tribits_generate_commit_info_string output commit info based on a passed in commit sha1.

…est (#597) Updated mockprogram inputs and outputs to be more specific about which commit message is being outputted.

If the HEAD sha1 contains more than one parent, include each parent's commit info in the final repoVersionStringOut of tribits_generate_single_repo_version_string.

Forgot to double quote variable and caused configure failures during Github Actions testing.

Added global cmake cache variable `<PROJECT_NAME>_SHOW_GIT_COMMIT_PARENTS:BOOL` that is default to OFF. This will be a project based variable to including parent commit info in the repo version output.

Reordered git log arguments to the expected order as well as condensed cmake command arguments into a single line.

Instead of passing in the deferenced HEAD SHA1 to tribites_generate_commit_info_string, simply just pass in the HEAD pointer keyword for Git to deference itself.

…tput (#597) In the off chance that Git decides to change the output of git log -1 "--pretty=format:%p", use a regex match and replace in cmake to match consecutive spaces and replace them with a single ;.

Simplified foreach loop in tribits_generate_single_repo_version_string and changed the parent indexing to be 1-based instead of 0-based.

Implemented usage of previously added global cmake variable, `PROJECT_NAME_SHOW_GIT_COMMIT_PARENTS` in `tribits_generate_single_repo_version_string`. This is done with an optional argument named INCLUDE_COMMIT_PARENTS whenever calling `tribits_generate_single_repo_version_string`

Cleaned up empty lines in `TribitsHelloWorld_Tests.cmake`

…#597) Implemented usage of previously added global cmake variable, `PROJECT_NAME_SHOW_GIT_COMMIT_PARENTS` in `tribits_generate_single_repo_version_string`. This is done with an optional argument named INCLUDE_COMMIT_PARENTS whenever calling `tribits_generate_single_repo_version_string`

With Clean Code ordering (i.e. the Newspaper Metaphor), in general, the functions should be ordered from top-level to low-level in the calling order. That is, the functions that are called in a given function should be listed below that function.

Cleaned up empty lines in `TribitsHelloWorld_Tests.cmake`

This allows the calling code to be more compact. Since this function is not really called by any external users (perhaps ever), this seems like a good trade-off.

…HANDLING_ONLY=ON (TriBITSPub#597) This spead up these tests on my machine 'crf450' from about 3.4 sec to about 0.45 sec. We don't need to enable the compilers and process the package CMakeLists.txt files to test this version info.

This is a variable that project developers and users should know about.

…up (TriBITSPub#597) Using camelCase for local vars helps to differentiate from UPPER_CACHE vars for function argument keywords and global vars. I figured I would clean this function up while I was working on it. Now this fits in one screen-shot for me.

…utils/ (TriBITSPub#597) I noticed that this module does not depend on the TriBITS framework in any way so it should live under the core/utils/ directory to make that clear and to allow easy reuse in non-TriBITS projects that would like to use it.

…IT_COMMIT_PARENTS (TriBITSPub#597) We eventually need to use this for all of those vars to make that code more compact.

…aintainers guide (TriBITSPub#597)

I noticed this while looking at the documentation while working on TriBITSPub#597.

TriBITSPub#597) This sets the option: -DTribitsExMetaProj_SHOW_GIT_COMMIT_PARENTS=ON in the inner CMake configuration with a multi-repo setup so we can test the extraction and printing of the parent commit info. This tests a call of the function tribits_generate_single_repo_version_string() for extra repos from the function tribits_generate_repo_version_file_string(). This test also validates that the correct Git commands are called since this uses real Git on a Git repos. The downside of this updated test is that it makes it a little more difficult to maintain these tests when we have to update these snapshotted Git repos.

…fo-rab Should be final commits for Git version parent info PR #598 (#597)

Add git version info for parent commits (#597)

…arent-info (TriBITSPub/TriBITS#597) Main purpose is to pull in the TriBITS PR for getting the git repo parent commit info: * TriBITSPub/TriBITS#598

bartlettroscoe · 2024-01-25T02:43:20Z

With the merge of PR:

Add git version info for parent commits (#597) #598

this story should be complete. This is in the process of being snapshotted to Trilinos in:

trilinos/Trilinos/#2695

@achauphan, can we close this issue?

…riBITSPub/TriBITS#597) This is needed to know the versions of the target and topic branches for PR builds submitted to CDash. This is needed to be able to detect random test failures.

bartlettroscoe added component: core type: enhancement labels Jan 4, 2024

bartlettroscoe added a commit that referenced this issue Jan 4, 2024

Strip the whitespace from git command (#597)

98750bb

For some reason, mockprogram.py prints an newline that raw git does not. But this should work for raw git too.

bartlettroscoe added a commit that referenced this issue Jan 4, 2024

Add check of generatead TribitsHelloWorldRepoVersion.txt file (#597)

1db9378

bartlettroscoe mentioned this issue Jan 5, 2024

Add git version info for parent commits (#597) #598

Merged

achauphan mentioned this issue Jan 9, 2024

Framework: force no fast-forward merges for pull request testing trilinos/Trilinos#12646

Merged

achauphan added a commit that referenced this issue Jan 12, 2024

Add commit sha1 input for tribits_generate_commit_info_string (#597)

fd3a2e9

Make tribits_generate_commit_info_string output commit info based on a passed in commit sha1.

achauphan added a commit that referenced this issue Jan 12, 2024

Updated TribitsHelloWorld_config_git_version_single_repo_one_parent t…

be3a494

…est (#597) Updated mockprogram inputs and outputs to be more specific about which commit message is being outputted.

achauphan added a commit that referenced this issue Jan 13, 2024

Added git version info for parent commits (#597)

0dacf47

If the HEAD sha1 contains more than one parent, include each parent's commit info in the final repoVersionStringOut of tribits_generate_single_repo_version_string.

achauphan added a commit that referenced this issue Jan 13, 2024

Added double quotes around variable (#597)

f34a429

Forgot to double quote variable and caused configure failures during Github Actions testing.

achauphan added a commit that referenced this issue Jan 13, 2024

Fix type causing sphinx build to fail (#597)

3af75e3

achauphan added a commit that referenced this issue Jan 16, 2024

Cleaned up git log and cmake command argument formatting (#597)

592ea0d

Reordered git log arguments to the expected order as well as condensed cmake command arguments into a single line.

achauphan added a commit that referenced this issue Jan 16, 2024

Simplified loop and changed to 1-based indexing (#597)

f6b6442

Simplified foreach loop in tribits_generate_single_repo_version_string and changed the parent indexing to be 1-based instead of 0-based.

achauphan mentioned this issue Jan 17, 2024

Add tool for analyzing and reporting random CDash test failures #600

Open

achauphan added a commit that referenced this issue Jan 17, 2024

Cleaned up empty lines (#597)

b07e361

Cleaned up empty lines in `TribitsHelloWorld_Tests.cmake`

bartlettroscoe pushed a commit to bartlettroscoe/TriBITS that referenced this issue Jan 24, 2024

Cleaned up empty lines (TriBITSPub#597)

ba7e8da

Cleaned up empty lines in `TribitsHelloWorld_Tests.cmake`

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue Jan 24, 2024

Add missing () on function block doc (TriBITSPub#597)

628b27e

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue Jan 24, 2024

Document <Project>_TRACE_DEPENDENCY_HANDLING_ONLY (TriBITSPub#597)

3aa1ea8

This is a variable that project developers and users should know about.

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue Jan 24, 2024

Document setting <Project>_SHOW_GIT_COMMIT_PARENTS_DEFAULT in users/m…

ba27309

…aintainers guide (TriBITSPub#597)

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue Jan 24, 2024

Fix some typos in tribits_ctest_driver() (TriBITSPub#597)

731841e

I noticed this while looking at the documentation while working on TriBITSPub#597.

bartlettroscoe added a commit that referenced this issue Jan 25, 2024

Merge pull request #601 from bartlettroscoe/597-config-git-version-in…

da80610

…fo-rab Should be final commits for Git version parent info PR #598 (#597)

bartlettroscoe added a commit that referenced this issue Jan 25, 2024

Merge pull request #598 from TriBITSPub/597-config-git-version-info

9328b34

Add git version info for parent commits (#597)

bartlettroscoe mentioned this issue Jan 25, 2024

Update TriBITS snapshot 2024-01-24 and set Trilinos_SHOW_GIT_COMMIT_PARENTS=ON for PR builds trilinos/Trilinos#12695

Merged

achauphan closed this as completed Jan 25, 2024

bartlettroscoe added this to TriBITS Refactor Jun 18, 2024

bartlettroscoe moved this to Done in TriBITS Refactor Jun 18, 2024

bartlettroscoe added this to TriBITS Jun 18, 2024

bartlettroscoe moved this to Done in TriBITS Jun 18, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add parents' commit hashes to repoVersionStringOut in tribits_generate_single_repo_version_string() #597

Add parents' commit hashes to repoVersionStringOut in tribits_generate_single_repo_version_string() #597

achauphan commented Jan 4, 2024 •

edited by bartlettroscoe

Loading

bartlettroscoe commented Jan 5, 2024 •

edited

Loading

bartlettroscoe commented Jan 25, 2024

Add parents' commit hashes to repoVersionStringOut in tribits_generate_single_repo_version_string() #597

Add parents' commit hashes to repoVersionStringOut in tribits_generate_single_repo_version_string() #597

Comments

achauphan commented Jan 4, 2024 • edited by bartlettroscoe Loading

Related issues

Description

Proposed Solution

Requirements

bartlettroscoe commented Jan 5, 2024 • edited Loading

bartlettroscoe commented Jan 25, 2024

achauphan commented Jan 4, 2024 •

edited by bartlettroscoe

Loading

bartlettroscoe commented Jan 5, 2024 •

edited

Loading