listing all buildtest config profiles list

bash_completion.sh

@@ -237,7 +237,10 @@ _buildtest ()
     ;;
 
     config|cg)
-      local cmds="-h --help co compilers e edit ex executors p path systems val validate v view"
+
+
+      local cmds="-h --help co compilers e edit ex executors p path profile systems validate v view"
+
 
       COMPREPLY=( $( compgen -W "${cmds}" -- $cur ) )
       # handle completion logic for 'buildtest config <subcommand>' based on subcommands
@@ -269,6 +272,19 @@ _buildtest ()
             return
           esac
         ;;
+        profile)
+          local opts="--help -h list"
+          COMPREPLY=( $( compgen -W "${opts}" -- $cur ) )
+          if [[ "${prev}" == "list" ]]; then
+            local opts="--help  --theme --yaml -h -t -y"
+            COMPREPLY=( $( compgen -W "${opts}" -- $cur ) )
+          fi
+
+          case "${prev}" in --theme|-t)
+              COMPREPLY=( $( compgen -W "$(_avail_color_themes)" -- $cur ) )
+              return
+          esac
+          ;;
       esac
       ;;
     inspect|it)
@@ -389,7 +405,6 @@ _buildtest ()
         ;;
       validate|val)
         local opts="--buildspec --exclude --executor --tag -b -e -t -x "
-
         COMPREPLY=( $( compgen -W "${opts}" -- $cur ) )
         # auto completion for 'buildtest buildspec validate' options
         if [[ "${prev}" == "-b" ]] || [[ "${prev}" == "--buildspec" ]] || [[ "${prev}" == "-x" ]] || [[ "${prev}" == "--exclude" ]]; then

buildtest/cli/__init__.py

@@ -988,6 +988,24 @@ def config_menu(subparsers, parent_parser):
     compilers = subparsers_config.add_parser(
         "compilers", aliases=["co"], help="Search compilers"
     )
+    # buildtest config profile
+    profile = subparsers_config.add_parser(
+        "profile", help="Query profile from buildtest configuration"
+    )
+    subparsers_profile = profile.add_subparsers(
+        description="Query information about buildtest profiles",
+        dest="profile",
+        metavar="",
+    )
+
+    subparsers_profile_list = subparsers_profile.add_parser(
+        "list", help="List all profiles", parents=[parent_parser["theme"]]
+    )
+
+    # buildtest config profile list options
+    subparsers_profile_list.add_argument(
+        "-y", "--yaml", action="store_true", help="List Profile details in YAML Format"
+    )
 
     subparsers_config.add_parser(
         "edit", aliases=["e"], help="Open configuration file in editor"

buildtest/cli/config.py

@@ -20,9 +20,14 @@ def config_cmd(args, configuration, editor, system):
         configuration (buildtest.config.SiteConfiguration): An instance of SiteConfiguration class
         system (buildtest.system.BuildTestSystem): An instance of BuildTestSystem class
     """
+
     if args.config in ["view", "v"]:
         view_configuration(configuration, theme=args.theme, pager=args.pager)
 
+    elif args.config in ["profile"]:
+        if args.profile == "list":
+            list_profiles(configuration, theme=args.theme, print_yaml=args.yaml)
+
     elif args.config in ["executors", "ex"]:
         buildexecutor = BuildExecutor(configuration)
         view_executors(
@@ -154,6 +159,31 @@ def view_configuration(configuration, theme=None, pager=None):
     console.print(syntax)
 
 
+def list_profiles(configuration, theme=None, print_yaml=None):
+    """Display the list of profile for buildtest configuration file.This implements command ``buildtest config profiles list``
+
+    Args:
+        configuration (buildtest.config.SiteConfiguration): An instance of SiteConfiguration class
+        theme (str, optional): Color theme to choose. This is the Pygments style (https://pygments.org/docs/styles/#getting-a-list-of-available-styles) which is specified by ``--theme`` option
+        print_yaml (bool, optional): Display profiles in yaml format. This is specified by ``--yaml`` option
+    """
+
+    if not configuration.target_config.get("profiles"):
+        sys.exit("No profiles found in configuration file")
+
+    if print_yaml:
+        profile_configuration = yaml.dump(
+            configuration.target_config["profiles"], indent=2
+        )
+        syntax = Syntax(profile_configuration, "yaml", theme=theme or "monokai")
+        console.print(syntax)
+        return
+
+    # print profiles as raw text
+    for profile_name in configuration.target_config["profiles"].keys():
+        print(profile_name)
+
+
 def view_executors(
     configuration,
     buildexecutor,

buildtest/cli/show.py

@@ -316,6 +316,10 @@ def print_config_show():
         "buildtest config compilers test",
         "Test each compiler instance by performing module load test",
     )
+    table.add_row(
+        "buildtest config profiles list",
+        "Listing all profiles from configuration file",
+    )
     console.print(table)
 
 

buildtest/settings/config.yml

@@ -1,45 +1,23 @@
 system:
   generic:
-    # specify list of hostnames where buildtest can run for given system record
-    hostnames: [".*"]
-
-    # system description
+    hostnames:
+    - .*
     description: Generic System
-    # specify module system used at your site (environment-modules, lmod)
     moduletool: N/A
-
-    # specify test timeout duration in number of seconds
-    # timeout: 60
-
-    # pool size for parallel processing using multiprocessing.Pool. Pool Size must be 1 or higher. The pool size is calculated as follows: poolsize = min(poolsize, os.cpu_count())
     poolsize: 1
-
-    # determine whether to enable pagination
-    pager: False
-
+    pager: false
     buildspecs:
-      # whether to rebuild cache file automatically when running `buildtest buildspec find`
-      rebuild: False
-      # limit number of records to display when running `buildtest buildspec find`
+      rebuild: false
       count: 15
-      # format fields to display when running `buildtest buildspec find`, By default we will show name,description
-      format: "name,description"
-      # enable terse mode
-      terse: False
-      # specify list of directories to search for buildspecs when building cache
-      #root: [ $BUILDTEST_ROOT/examples, /tmp/buildspecs ]
+      format: name,description
+      terse: false
     report:
       count: 25
-      #enable terse mode for report
-      terse: False
-      format: "name,id,state,runtime,returncode"
-      # show the latest for every test
-      latest: True
-      # show the oldest for every test
-      oldest: False
-
+      terse: false
+      format: name,id,state,runtime,returncode
+      latest: true
+      oldest: false
     executors:
-      # define local executors for running jobs locally
       local:
         bash:
           description: submit jobs on local machine using bash shell
@@ -53,39 +31,20 @@ system:
         zsh:
           description: submit jobs on local machine using zsh shell
           shell: zsh
-    # compiler block
     compilers:
-      # a list of directories to search for modules
-      # modulepath: ['/tmp', '/var/']
-
-      # regular expression to search for compilers based on module pattern. Used with 'buildtest config compilers find' to generate compiler instance
-      # find:
-      #  gcc: "^(gcc)"
-      #  intel: "^(intel)"
-      #  cray: "^(craype)"
-      #  pgi: "^(pgi)"
-      #  cuda: ^(cuda)"
-      #  clang: "^(clang)"
-
-      # declare compiler instance which can be site-specific. You can let 'buildtest config compilers find' generate compiler section
       compiler:
         gcc:
           builtin_gcc:
             cc: gcc
             fc: gfortran
             cxx: g++
-
-    # location of log directory
-    # logdir: /tmp/
-
-    # specify location where buildtest will write tests
-    # testdir: /tmp
-
-    # specify one or more directory where buildtest should load buildspecs
-    # buildspec_roots: []
-
     cdash:
       url: https://my.cdash.org/
       project: buildtest
       site: generic
       buildname: tutorials
+    profiles:
+      pass:
+        tags:
+        - pass
+        testdir: /Users/kingxley/buildtest/var/tests

docs/configuring_buildtest/overview.rst

@@ -725,4 +725,5 @@ is an object and attributes ``tags``, ``maintainers``, ``type`` correspond to th
           - script
 
 We have added additional checks in the JSON schema for valid values for each type, for instance if you specify an invalid value for ``type`` field
-which is used to filter buildspecs by the ``type`` field, then you will get an invalid configuration file.
+which is used to filter buildspecs by the ``type`` field, then you will get an invalid configuration file.
+

tests/cli/test_config.py

@@ -3,6 +3,7 @@
 import pytest
 
 from buildtest.cli.config import (
+    list_profiles,
     validate_config,
     view_configuration,
     view_executors,
@@ -66,6 +67,18 @@ def test_config_path():
     view_path(configuration)
 
 
+@pytest.mark.cli
+def test_config_profile():
+    # buildtest config profiles
+    list_profiles(configuration)
+
+    # buildtest config profiles --theme emacs --yaml
+    list_profiles(configuration, theme="emacs", print_yaml=True)
+
+    # buildtest config profiles --yaml
+    list_profiles(configuration, print_yaml=True)
+
+
 @pytest.mark.cli
 def test_config_executors():
     buildexecutor = BuildExecutor(configuration)