Get Trilinos auto PR testing code to use TriBITS-based package enable logic

[bartlettroscoe]

CC: @william76, @jwillenbring

Next Action Status

With the merge of PR #3258 8/14/2018 this should be complete. As of 9/12/2018 no problems have been reported in last 4+ weeks so all is good!

Description

This story is to get the Trilinos auto PR testing code to use TriBITS-based logic for determining what to enable and test based on files that are changed in the PR branch.

The benefits of making this change are:

• When the set of Primary Tested packages changes, the code will automatically adjust

• Specialized logic can be applied to determine if all packages need to be tested or not. For example, if files are changed under Trilinos/cmake/ctest/drivers then that should not trigger the auto PR tester to test all of Trilinos.

[bartlettroscoe]

@william76 and @jwillenbring,

I just posted PR #3134 where I made a few small tweaks to the TriBITS code to make it easier to use for the Trilinos use case. Once that PR is merged to 'develop', then you can use it as demonstrated in the script:

get-changed-trilinos-packages.sh (click to expend)

#!/bin/bash -e
#
# Usage:
#
#   get-changed-trilinos-packages.sh <trilinos-dir> <git-commit-from> <git-commit-to>
#
# This script takes in the base Trilinos git repository working directory
# <trilinos-dir> and a range of git commits <git-commit-from> <git-commit-to>
# and then prints to STDOUT a comma-separated list of changed Trilinos
# packages.
#
# As a bi-product of running this script it will create the following files in the current working directory:
#
# * TribitsDumpDepsXmlScript.log: Log file from running TribitsDumpDepsXmlScript.cmake
# * TrilinosPackageDependencies.xml: Generated XML package list and dependencies
# * changed-files.txt: List of files changed between git repo versions

TRILINOS_DIR=$1
GIT_COMMIT_FROM=$2
GIT_COMMIT_TO=$3

ORIG_CWD=$PWD

TRIBITS_DIR=$TRILINOS_DIR/cmake/tribits

# A) Generate the TrilinosPackageDependencies.xml file
cmake \
  -D PROJECT_SOURCE_DIR=$TRILINOS_DIR \
  -D Trilinos_TRIBITS_DIR=$TRIBITS_DIR \
  -D Trilinos_DEPS_XML_OUTPUT_FILE=TrilinosPackageDependencies.xml \
  -P $TRIBITS_DIR/ci_support/TribitsDumpDepsXmlScript.cmake \
  &> TribitsDumpDepsXmlScript.log

# B) Get the set of changed files.
cd $TRILINOS_DIR/
git diff --name-only $GIT_COMMIT_TO ^$GIT_COMMIT_FROM > $ORIG_CWD/changed-files.txt
cd $ORIG_CWD/

# C) Get the unfiltered list of Trilinos packages (including 'ALL_PACKAGES')
CHANGED_PACKAGES_FULL_LIST=\
`$TRIBITS_DIR/ci_support/get-tribits-packages-from-files-list.py --files-list-file=changed-files.txt --deps-xml-file=TrilinosPackageDependencies.xml`
#echo $CHANGED_PACKAGES_FULL_LIST

# D) Filter to get only the PT set of packages and print final list to STDOUT
$TRIBITS_DIR/ci_support/filter-packages-list.py \
  --deps-xml-file=TrilinosPackageDependencies.xml \
  --input-packages-list=$CHANGED_PACKAGES_FULL_LIST \
  --keep-types=PT

.

in order to get the filtered set of changed PT packages.

For example, I just ran this as:

./get-changed-trilinos-packages.sh ~/Trilinos.base/Trilinos ee67bdd 9f757fb

and it returned to STDOUT:

ALL_PACKAGES,Amesos2,Anasazi,AztecOO,Belos,Domi,Epetra,Galeri,Ifpack,Ifpack2,Intrepid,Intrepid2,KokkosKernels,Kokkos,KokkosAlgorithms,KokkosContainers,KokkosCore,MiniTensor,MueLu,PanzerAdaptersSTK,PanzerCore,PanzerDiscFE,PanzerDofMgr,PanzerMiniEM,Phalanx,Piro,ROL,Rythmos,Sacado,SEACAS,SEACASIoss,ShyLU_DDFROSch,ShyLU_NodeTacho,STK,STKSimd,STKUtil,Stokhos,Stratimikos,Teko,Tempus,Teuchos,TeuchosComm,TeuchosCore,TeuchosKokkosCompat,TeuchosParameterList,TpetraClassic,TpetraCore,TrilinosCouplings,Xpetra,Zoltan,Zoltan2

As described, that is a large set of 9K changed files and it completed it in under 30 seconds.

[bartlettroscoe]

FYI: As described in #3134 (comment), the PR #3134 now contains the script get-changed-trilinos-packages.sh which completely generates the packageEnables.cmake file. Hopefully that will be easy to plug into the Trilinos auto PR testing infrastructure.

[bartlettroscoe]

@william76, why did you close this? PR #3258 has not been merged yet.

[william76]

@bartlettroscoe whoops! I was on the wrong tab and thought I was closing a merged PR, not an issue. I've reopened this one. Thanks for alerting me of the goof ;)

[bartlettroscoe]

I was on the wrong tab and thought I was closing a merged PR, not an issue. I've reopened this one. Thanks for alerting me of the goof ;)

@william76, the merged PRs #3134 and #3218 don't quite complete this due to the problem described above and in #3265. To fix those issues, we need to merge PR #3258, as described in the "Next Action Status" field above.

[bartlettroscoe]

With the merge of PR #3258 8/14/2018 this should be complete. Next: Watch PRs over next week and ensure that right set of packages are being enabled and then close on 8/21/2018 if all looks good ...

[bartlettroscoe]

FYI: There was defect in the PR driver script merged in PR #3258 yesterday which broke the PR testing process. This was fixed in the PR #3302 which was manually merged this morning. It looks like the PR testing system is working again as shown, for example, here.

We will watch the PR builds over the next week to see that everything is going correctly.

[bartlettroscoe]

FYI: A positive data-point ...

The PR #3309 that only changes files for the ATDM Trilinos builds did not result in any Trilinos packages getting enabled as shown in #3309 (comment) and on CDash here which showed:

loading initial cache file /scratch/trilinos/workspace/trilinos-folder/Trilinos_pullrequest_gcc_4.8.4/packageEnables.cmake
-- NOTE: No packages are being enabled!

Success!

NOTE: the first CI iteration shown in #3309 (comment) failed due to a git fetch failure (see #3276 (comment)) which has nothing to do with this story #3133 or any changes to the scripts as part of this.

[bartlettroscoe]

This has been in production for some time and it seems to be working correctly in every case. I think we might want to tweak the set of files under Trilinos/cmake/ and other subdirs that trigger a global build but that can be handled in follow-on issues and PRs.

This has saved the ATDM Trilinos effort a huge amount of time and effort (by not testing all of Trilinos for every little ATDM Trilinos script change).

I am going to close this as complete.