Merge pull request #1785 from buildtesters/buildtest_buildspec_valida…

…te_name validate test by name via 'buildtest buildspec validate --name'
buildtesters · Jun 12, 2024 · 679f5af · 679f5af
2 parents 207d071 + 6961da2
commit 679f5af
Show file tree

Hide file tree

Showing 6 changed files with 31 additions and 4 deletions.
diff --git a/bash_completion.sh b/bash_completion.sh
@@ -477,7 +477,7 @@ _buildtest ()
         esac
         ;;
       validate|val)
-        local opts="--buildspec --exclude --executor --tag -b -e -t -x "
+        local opts="--buildspec --exclude --executor --name --tag -b -e -n -t -x "
         COMPREPLY=( $( compgen -W "${opts}" -- "${cur}" ) )
 
         case "${prev}" in
@@ -490,6 +490,9 @@ _buildtest ()
           -e|--executor)
               COMPREPLY=( $( compgen -W "$(_avail_executors)" -- "${cur}" ) )
               ;;
+          -n|--name)
+              COMPREPLY=( $( compgen -W "$(_buildspec_test_names)" -- "${cur}" ) )
+              ;;
         esac
       ;;
       esac

diff --git a/buildtest/cli/__init__.py b/buildtest/cli/__init__.py
@@ -1151,6 +1151,14 @@ def buildspec_menu(self):
                             "help": "Specify buildspecs by tag name to validate",
                         },
                     ),
+                    (
+                        ["-n", "--name"],
+                        {
+                            "type": str,
+                            "action": "append",
+                            "help": "Specify buildspecs by name to validate",
+                        },
+                    ),
                 ],
             },
         ]

diff --git a/buildtest/cli/buildspec.py b/buildtest/cli/buildspec.py
@@ -1210,7 +1210,12 @@ def handle_exception(buildspec, exception):
 
 
 def buildspec_validate_command(
-    configuration, buildspecs=None, excluded_buildspecs=None, tags=None, executors=None
+    configuration,
+    buildspecs=None,
+    excluded_buildspecs=None,
+    tags=None,
+    executors=None,
+    name=None,
 ):
     """Entry point for ``buildtest buildspec validate``. This method is responsible for discovering buildspec
     with same options used for building buildspecs that includes ``--buildspec``, ``--exclude``, ``--tag``, and
@@ -1223,13 +1228,15 @@ def buildspec_validate_command(
         excluded_buildspecs (list, optional): List of excluded buildspecs which can be a file or directory. This option is specified via ``buildtest buildspec validate --exclude``
         tags (list, optional): List of tag names to search for buildspec to validate. This option is specified via ``buildtest buildspec validate --tag``
         executors (list, optional): List of executor names to search for buildspecs to validate. This option is specified via ``buildtest buildspec validate --executor``
+        name (str, optional): Name of test to validate. This option is specified via ``buildtest buildspec validate --name``
     """
 
     buildspecs_dict = discover_buildspecs(
         buildspecs=buildspecs,
         exclude_buildspecs=excluded_buildspecs,
         tags=tags,
         executors=executors,
+        name=name,
     )
     detected_buildspecs = buildspecs_dict["detected"]
 

diff --git a/buildtest/main.py b/buildtest/main.py
@@ -390,6 +390,7 @@ def handle_buildspec_command(args, configuration, report_file, buildtest_editor)
             excluded_buildspecs=args.exclude,
             tags=args.tag,
             executors=args.executor,
+            name=args.name,
             configuration=configuration,
         )
 

diff --git a/docs/gettingstarted/buildspecs_interface.rst b/docs/gettingstarted/buildspecs_interface.rst
@@ -329,7 +329,7 @@ Validate Buildspecs - ``buildtest buildspec validate``
 --------------------------------------------------------
 
 buildtest can validate buildspecs through the ``buildtest buildspec validate`` command which provides
-analogous options for ``buildtest build`` for selecting buildspecs such as ``-b``, ``-e``, ``-t`` and ``-e``.
+analogous options for ``buildtest build`` for selecting buildspecs such as ``-b``, ``-e``, ``-n``, ``-t`` and ``-x``.
 This command can be used to validate buildspecs with the JSON Schema which can be useful if you are writing a buildspec
 and want to validate the buildspec without running the test.
 
@@ -339,7 +339,7 @@ Shown below are the available command options.
 
     .. command-output:: buildtest buildspec validate --help
 
-The `-b` option can be used to specify path to buildspec file or directory to validate buildspecs. If its a directory,
+The **-b** option can be used to specify path to buildspec file or directory to validate buildspecs. If its a directory,
 buildtest will traverse all directories recursively and find any **.yml** file extensions and attempt to validate each buildspec.
 Shown below is an example output of what it may look like
 
@@ -363,6 +363,13 @@ will validate all buildspecs for **python** and **pass** tags.
 
     .. command-output:: buildtest buildspec validate -t python -t pass
 
+You can mix and match different options for searching buildspecs to validate. For example, we can
+search by buildspec, tags, and name in the following example
+
+.. dropdown:: ``buildtest buildspec validate -t python -n hello_world -b tutorials/vars.yml``
+
+    .. command-output:: buildtest buildspec validate -t python -n hello_world -b tutorials/vars.yml
+
 Show buildspec ``buildtest buildspec show``
 --------------------------------------------
 

diff --git a/tests/cli/test_buildspec.py b/tests/cli/test_buildspec.py
@@ -43,6 +43,7 @@ def test_buildspec_validate():
         ],
         tags=["pass", "python"],
         executors=["generic.local.sh"],
+        name=["hello_world"],
         configuration=configuration,
     )