Update filter-packages-list.py so it can handle special ALL_PACKAGES (trilinos/Trilinos#3133)

I also updated the documentation a little.  Now this should be ready to handle
the output from get-tribits-packages-from-files-list.py which can contain
ALL_PACKAGES and it should be ready to be used for the refactored Trilinos
auto PR tester (trilinos/Trilinos#3133).

Build/Test Cases Summary
Enabled Packages:
Enabled all Packages
0) MPI_DEBUG => passed: passed=268,notpassed=0 (0.72 min)
1) SERIAL_RELEASE => passed: passed=268,notpassed=0 (0.67 min)
2) MPI_DEBUG_CMAKE-3.6.2 => passed: passed=293,notpassed=0 (0.63 min)
3) SERIAL_RELEASE_CMAKE-3.6.2 => passed: passed=293,notpassed=0 (0.74 min)
4) MPI_DEBUG_CMAKE-3.11.1 => passed: passed=313,notpassed=0 (0.95 min)
5) SERIAL_RELEASE_CMAKE-3.11.1 => passed: passed=313,notpassed=0 (0.91 min)
Other local commits for this build/test group: 7a97ef5, e22a629

Author: bartlettroscoe

test/ci_support/TribitsPackageFilePathUtils_UnitTests.py

@@ -256,6 +256,36 @@ def test_get_PT(self):
       )
 
 
+  def test_get_PT_ALL_PACKAGES_begining(self):
+    self.assertEqual(
+      getCmndOutput(ciSupportDir+"/filter-packages-list.py" \
+        " --deps-xml-file="+testingTrilinosDepsXmlInFile+"" \
+        " --input-packages-list=ALL_PACKAGES,Teuchos,Thyra,Phalanx,Stokhos --keep-types=PT",
+        True),
+      b("ALL_PACKAGES,Teuchos,Thyra")
+      )
+
+
+  def test_get_PT_ALL_PACKAGES_end(self):
+    self.assertEqual(
+      getCmndOutput(ciSupportDir+"/filter-packages-list.py" \
+        " --deps-xml-file="+testingTrilinosDepsXmlInFile+"" \
+        " --input-packages-list=Teuchos,Thyra,Phalanx,Stokhos,ALL_PACKAGES --keep-types=PT",
+        True),
+      b("Teuchos,Thyra,ALL_PACKAGES")
+      )
+
+
+  def test_get_PT_ALL_PACKAGS_middle(self):
+    self.assertEqual(
+      getCmndOutput(ciSupportDir+"/filter-packages-list.py" \
+        " --deps-xml-file="+testingTrilinosDepsXmlInFile+"" \
+        " --input-packages-list=Teuchos,ALL_PACKAGES,Thyra,Phalanx,Stokhos --keep-types=PT",
+        True),
+      b("Teuchos,ALL_PACKAGES,Thyra")
+      )
+
+
   def test_get_PT_ST(self):
     self.assertEqual(
       getCmndOutput(ciSupportDir+"/filter-packages-list.py" \

tribits/ci_support/TribitsDependencies.py

@@ -295,6 +295,9 @@ def filterPackageNameList(self, inputPackagesList, keepTypesList, verbose=False)
     outputPackagesList = []
     for packageName in inputPackagesList:
       #print("packageName = " + packageName)
+      if packageName == "ALL_PACKAGES":
+        outputPackagesList.append(packageName)
+        continue
       packageDep = self.getPackageByName(packageName)
       packageType = packageDep.packageType
       #print("packageType = " + packageType)

tribits/ci_support/filter-packages-list.py

@@ -46,7 +46,15 @@
 # Read in the commandline arguments
 #
 
-usageHelp = r"""filter-packages-list --input-packages-list=P1,P2,... --keep-types=T1,T2,...
+usageHelp = \
+r"""filter-packages-list --deps-xml-file=<PROJECT_DEPS_FILE> \
+  --input-packages-list=<P1>,<P2>,... --keep-types=<T1>,<T2>,...
+
+This script takes in a comma-seprated list of TriBITS package name
+<P1>,<P2>,... and keeps the package names matching the categories listed in
+<T1>,<T2>,... given the TriBITS-generated project dependencies file.
+
+The comma-seprated filtered list of packages is printed to STDOUT.
 """
 
 from optparse import OptionParser
@@ -55,15 +63,15 @@
 
 clp.add_option(
   "--input-packages-list", dest="inputPackagesList", type="string", default="",
-  help="List of packages that needs to be filtered (i.e. \"P1,P2,...\")." )
+  help="Comma-seprated List of packages that needs to be filtered (i.e. \"P1,P2,...\")." )
 
 clp.add_option(
   "--keep-types", dest="keepTypes", type="string", default="",
-  help="List of types to keep (i.e. \"PT,ST,EX\"." )
+  help="List of package types to keep (i.e. \"PT,ST,EX\"." )
 
 clp.add_option(
   "--deps-xml-file", dest="depsXmlFile", type="string",
-  help="File containing the listing of packages, dir names, dependencies, etc.")
+  help="TriBITS generated XML file containing the listing of packages, dir names, dependencies, etc.")
 
 (options, args) = clp.parse_args()