Merge pull request #196 from Microsoft/dev

Merge 0.1.2 from dev

Author: tedchamb

Dockerfile

@@ -41,10 +41,12 @@ RUN pip install vsts --upgrade --no-cache-dir --extra-index-url https://vstscli.
    /vsts-cli/src/common_modules/vsts-cli-common \
    /vsts-cli/src/common_modules/vsts-cli-build-common \
    /vsts-cli/src/common_modules/vsts-cli-code-common \
+   /vsts-cli/src/common_modules/vsts-cli-package-common \
    /vsts-cli/src/common_modules/vsts-cli-team-common \
    /vsts-cli/src/common_modules/vsts-cli-work-common \
    /vsts-cli/src/command_modules/vsts-cli-build \
    /vsts-cli/src/command_modules/vsts-cli-code \
+   /vsts-cli/src/command_modules/vsts-cli-package \
    /vsts-cli/src/command_modules/vsts-cli-team \
    /vsts-cli/src/command_modules/vsts-cli-work \
    /vsts-cli/src/vsts-cli

README.md

@@ -117,20 +117,14 @@ To disable telemetry use the `vsts configure` command.
 
 ## Feedback
 
-If you encounter any bugs with the tool please report an issue on the [VSTS Developer Community](https://aka.ms/vsts-cli-devcom) using the vsts-cli tag.
+If you have any issues, questions, comments, or feature requests regarding this tool, please file an issue within this github repo using our contribution guidelines. 
 
 To find where to provide feedback from the CLI, run `vsts feedback`.
 
 ## Contribute
 
-This project welcomes contributions and suggestions. Most contributions require you to agree to a
-Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
-the rights to use your contribution. For details, visit https://cla.microsoft.com.
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
 
-When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
-a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions
-provided by the bot. You will only need to do this once across all repos using our CLA.
+For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
 
-This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
-For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
-contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
+This project follows the same contribution guidelines outlined by the Azure CLI. If you would like to become an active contributor, please follow the instructions provided in [Microsoft Azure Projects Contribution Guidelines](http://azure.github.io/guidelines.html).

packaged_releases/windows/scripts/build-packages.py

@@ -52,23 +52,27 @@ def _build_package(path_to_package, dist_dir):
 def build_packages(clone_root, dist_dir):
     packages_to_build = [
         os.path.join(clone_root, 'src/common_modules/vsts-cli-common'),
+        os.path.join(clone_root, 'src/common_modules/vsts-cli-admin-common'),
         os.path.join(clone_root, 'src/common_modules/vsts-cli-build-common'),
         os.path.join(clone_root, 'src/common_modules/vsts-cli-code-common'),
+        os.path.join(clone_root, 'src/common_modules/vsts-cli-package-common'),
         os.path.join(clone_root, 'src/common_modules/vsts-cli-team-common'),
         os.path.join(clone_root, 'src/common_modules/vsts-cli-work-common'),
+        os.path.join(clone_root, 'src/command_modules/vsts-cli-admin'),
         os.path.join(clone_root, 'src/command_modules/vsts-cli-build'),
         os.path.join(clone_root, 'src/command_modules/vsts-cli-code'),
+        os.path.join(clone_root, 'src/command_modules/vsts-cli-package'),
         os.path.join(clone_root, 'src/command_modules/vsts-cli-team'),
         os.path.join(clone_root, 'src/command_modules/vsts-cli-work'),
         os.path.join(clone_root, 'src/vsts-cli'),
     ]
 
     for p in packages_to_build:
-        setupPath = os.path.join(p, 'setup.py')
-        if os.path.isfile(setupPath):
+        setup_path = os.path.join(p, 'setup.py')
+        if os.path.isfile(setup_path):
             _build_package(p, dist_dir)
         else:
-            print('Failed to find file: ' + setupPath)
+            print('Failed to find file: ' + setup_path)
             exit(1)
 
 

packaged_releases/windows/scripts/build_local.cmd

@@ -10,9 +10,9 @@ set "PATH=%PATH%;%ProgramFiles%\Git\bin;%ProgramFiles%\Git\usr\bin"
 
 if "%CLIVERSION%"=="" (
     if "%BUILD_BUILDID%" == "" (
-        set CLIVERSION=0.1.1
+        set CLIVERSION=0.1.2
     ) else (
-        set CLIVERSION=0.1.1.%BUILD_BUILDID%
+        set CLIVERSION=0.1.2.%BUILD_BUILDID%
     )
 )
 set PYTHON_VERSION=3.6.3
@@ -119,18 +119,26 @@ if %errorlevel% neq 0 goto ERROR
 if %errorlevel% neq 0 goto ERROR
 "%BUILDING_DIR%\python.exe" -m pip install -f "%TEMP_SCRATCH_FOLDER%" --no-cache-dir "%REPO_ROOT%\src\common_modules\vsts-cli-common"
 if %errorlevel% neq 0 goto ERROR
+"%BUILDING_DIR%\python.exe" -m pip install -f "%TEMP_SCRATCH_FOLDER%" --no-cache-dir "%REPO_ROOT%\src\common_modules\vsts-cli-admin-common"
+if %errorlevel% neq 0 goto ERROR
 "%BUILDING_DIR%\python.exe" -m pip install -f "%TEMP_SCRATCH_FOLDER%" --no-cache-dir "%REPO_ROOT%\src\common_modules\vsts-cli-build-common"
 if %errorlevel% neq 0 goto ERROR
 "%BUILDING_DIR%\python.exe" -m pip install -f "%TEMP_SCRATCH_FOLDER%" --no-cache-dir "%REPO_ROOT%\src\common_modules\vsts-cli-code-common"
 if %errorlevel% neq 0 goto ERROR
+"%BUILDING_DIR%\python.exe" -m pip install -f "%TEMP_SCRATCH_FOLDER%" --no-cache-dir "%REPO_ROOT%\src\common_modules\vsts-cli-package-common"
+if %errorlevel% neq 0 goto ERROR
 "%BUILDING_DIR%\python.exe" -m pip install -f "%TEMP_SCRATCH_FOLDER%" --no-cache-dir "%REPO_ROOT%\src\common_modules\vsts-cli-team-common"
 if %errorlevel% neq 0 goto ERROR
 "%BUILDING_DIR%\python.exe" -m pip install -f "%TEMP_SCRATCH_FOLDER%" --no-cache-dir "%REPO_ROOT%\src\common_modules\vsts-cli-work-common"
 if %errorlevel% neq 0 goto ERROR
+"%BUILDING_DIR%\python.exe" -m pip install -f "%TEMP_SCRATCH_FOLDER%" --no-cache-dir "%REPO_ROOT%\src\command_modules\vsts-cli-admin"
+if %errorlevel% neq 0 goto ERROR
 "%BUILDING_DIR%\python.exe" -m pip install -f "%TEMP_SCRATCH_FOLDER%" --no-cache-dir "%REPO_ROOT%\src\command_modules\vsts-cli-build"
 if %errorlevel% neq 0 goto ERROR
 "%BUILDING_DIR%\python.exe" -m pip install -f "%TEMP_SCRATCH_FOLDER%" --no-cache-dir "%REPO_ROOT%\src\command_modules\vsts-cli-code"
 if %errorlevel% neq 0 goto ERROR
+"%BUILDING_DIR%\python.exe" -m pip install -f "%TEMP_SCRATCH_FOLDER%" --no-cache-dir "%REPO_ROOT%\src\command_modules\vsts-cli-package"
+if %errorlevel% neq 0 goto ERROR
 "%BUILDING_DIR%\python.exe" -m pip install -f "%TEMP_SCRATCH_FOLDER%" --no-cache-dir "%REPO_ROOT%\src\command_modules\vsts-cli-team"
 if %errorlevel% neq 0 goto ERROR
 "%BUILDING_DIR%\python.exe" -m pip install -f "%TEMP_SCRATCH_FOLDER%" --no-cache-dir "%REPO_ROOT%\src\command_modules\vsts-cli-work"

scripts/docgen/conf.py

@@ -62,7 +62,7 @@
 
 # General information about the project.
 project = 'vsts-cli'
-copyright = '2017, msft'
+copyright = '2018, msft'
 author = 'msft'
 
 # The version info for the project you're documenting, acts as replacement for

scripts/docgen/doc_source_map.json

@@ -2,5 +2,7 @@
     "build": "src/command_modules/vsts-cli-build/vsts/cli/build/_help.py",
     "code": "src/command_modules/vsts-cli-code/vsts/cli/code/_help.py",    
     "team": "src/command_modules/vsts-cli-team/vsts/cli/team/_help.py",
-    "work": "src/command_modules/vsts-cli-work/vsts/cli/work/_help.py"
+    "work": "src/command_modules/vsts-cli-work/vsts/cli/work/_help.py",
+    "admin": "src/command_modules/vsts-cli-admin/vsts/cli/admin/_help.py",
+    "package": "src/command_modules/vsts-cli-package/vsts/cli/package/_help.py"
 }

scripts/docgen/extensions/vsts.py

@@ -8,6 +8,7 @@
 import argparse
 import json
 import os
+from os.path import expanduser
 import sys
 
 from docutils import nodes
@@ -20,59 +21,34 @@
 
 from knack import CLI
 from knack import help as _help
+from knack.help import GroupHelpFile, CommandHelpFile, ArgumentGroupRegistry 
+
+USER_HOME = expanduser('~')
 
 class VstsHelpGenDirective(Directive):
     def make_rst(self):
         INDENT = '   '
         DOUBLEINDENT = INDENT * 2
-        parser_keys = []
-        parser_values = []
-        sub_parser_keys = []
-        sub_parser_values = []
-
         # similar to what the Application object provides for in "az"
         cli_name = "vsts"
-        vstscli = CLI(cli_name=cli_name,
+        vsts_cli = CLI(cli_name=cli_name,
                 config_dir=os.path.join('~', '.{}'.format(cli_name)),
                 config_env_var_prefix=cli_name,
                 commands_loader_cls=VstsCommandsLoader,
                 help_cls=VstsCLIHelp)
 
-        loader = vstscli.commands_loader_cls()
-        loader.__init__(vstscli)
-        loader.load_command_table([])
-        for command in loader.command_table:
-            loader.load_arguments(command)
-
-        vstsclihelp = vstscli.help_cls(cli_ctx=vstscli)
+        help_files = get_help_files(vsts_cli)
 
-        global_parser = vstscli.parser_cls.create_global_parser(cli_ctx=vstscli)
-        parser = vstscli.parser_cls(cli_ctx=vstscli, prog=vstscli.name, parents=[global_parser])
-        parser.load_command_table(loader.command_table)
-
-        _store_parsers(parser, parser_keys, parser_values, sub_parser_keys, sub_parser_values)
-        for cmd, parser in zip(parser_keys, parser_values):
-            if cmd not in sub_parser_keys:
-                sub_parser_keys.append(cmd)
-                sub_parser_values.append(parser)
         doc_source_map = _load_doc_source_map()
 
-        help_files = []
-        for cmd, parser in zip(sub_parser_keys, sub_parser_values):
-            try:
-                help_file = _help.GroupHelpFile(cmd, parser) if _is_group(parser) else _help.CommandHelpFile(cmd, parser)
-                help_file.load(parser)
-                help_files.append(help_file)
-            except Exception as ex:
-                print("Skipped '{}' due to '{}'".format(cmd, ex))
-        help_files = sorted(help_files, key=lambda x: x.command)
-
         for help_file in help_files:
-            is_command = isinstance(help_file, _help.CommandHelpFile)
-            yield '.. cli{}:: {}'.format('command' if is_command else 'group', help_file.command if help_file.command else 'vsts') #it is top level group vsts if command is empty
+            is_command = isinstance(help_file, CommandHelpFile)
+            yield '.. cli{}:: {}'.format('command' if is_command else 'group', help_file.command if help_file.command else 'vsts') #it is top level group az if command is empty
             yield ''
             yield '{}:summary: {}'.format(INDENT, help_file.short_summary)
             yield '{}:description: {}'.format(INDENT, help_file.long_summary)
+            if help_file.deprecate_info:
+                yield '{}:deprecated: {}'.format(INDENT, help_file.deprecate_info._get_message(help_file.deprecate_info))
             if not is_command:
                 top_group_name = help_file.command.split()[0] if help_file.command else 'vsts' 
                 yield '{}:docsource: {}'.format(INDENT, doc_source_map[top_group_name] if top_group_name in doc_source_map else '')
@@ -83,35 +59,46 @@ def make_rst(self):
             yield ''
 
             if is_command and help_file.parameters:
-               group_registry = _help.ArgumentGroupRegistry(
+               group_registry = ArgumentGroupRegistry(
                   [p.group_name for p in help_file.parameters if p.group_name]) 
 
                for arg in sorted(help_file.parameters,
                                 key=lambda p: group_registry.get_group_priority(p.group_name)
                                 + str(not p.required) + p.name):
-                  yield '{}.. cliarg:: {}'.format(INDENT, arg.name)
-                  yield ''
-                  yield '{}:required: {}'.format(DOUBLEINDENT, arg.required)
-                  short_summary = arg.short_summary or ''
-                  possible_values_index = short_summary.find(' Possible values include')
-                  short_summary = short_summary[0:possible_values_index
-                                                if possible_values_index >= 0 else len(short_summary)]
-                  short_summary = short_summary.strip()
-                  yield '{}:summary: {}'.format(DOUBLEINDENT, short_summary)
-                  yield '{}:description: {}'.format(DOUBLEINDENT, arg.long_summary)
-                  if arg.choices:
-                     yield '{}:values: {}'.format(DOUBLEINDENT, ', '.join(sorted([str(x) for x in arg.choices])))
-                  if arg.default and arg.default != argparse.SUPPRESS:
-                     yield '{}:default: {}'.format(DOUBLEINDENT, arg.default)
-                  if arg.value_sources:
-                     yield '{}:source: {}'.format(DOUBLEINDENT, ', '.join(arg.value_sources))
-                  yield ''
+                    yield '{}.. cliarg:: {}'.format(INDENT, arg.name)
+                    yield ''
+                    yield '{}:required: {}'.format(DOUBLEINDENT, arg.required)
+                    if arg.deprecate_info:
+                        yield '{}:deprecated: {}'.format(DOUBLEINDENT, arg.deprecate_info._get_message(arg.deprecate_info))
+                    short_summary = arg.short_summary or ''
+                    possible_values_index = short_summary.find(' Possible values include')
+                    short_summary = short_summary[0:possible_values_index
+                                                    if possible_values_index >= 0 else len(short_summary)]
+                    short_summary = short_summary.strip()
+                    yield '{}:summary: {}'.format(DOUBLEINDENT, short_summary)
+                    yield '{}:description: {}'.format(DOUBLEINDENT, arg.long_summary)
+                    if arg.choices:
+                        yield '{}:values: {}'.format(DOUBLEINDENT, ', '.join(sorted([str(x) for x in arg.choices])))
+                    if arg.default and arg.default != argparse.SUPPRESS:
+                        try:
+                            if arg.default.startswith(USER_HOME):
+                                arg.default = arg.default.replace(USER_HOME, '~').replace('\\', '/')
+                        except Exception:
+                            pass
+                        try:
+                            arg.default = arg.default.replace("\\", "\\\\")
+                        except Exception:
+                            pass
+                        yield '{}:default: {}'.format(DOUBLEINDENT, arg.default)
+                    if arg.value_sources:
+                        yield '{}:source: {}'.format(DOUBLEINDENT, ', '.join(arg.value_sources))
+                    yield ''
             yield ''
             if len(help_file.examples) > 0:
                for e in help_file.examples:
                   yield '{}.. cliexample:: {}'.format(INDENT, e.name)
                   yield ''
-                  yield DOUBLEINDENT + e.text
+                  yield DOUBLEINDENT + e.text.replace("\\", "\\\\")
                   yield ''
 
     def run(self):
@@ -124,6 +111,37 @@ def run(self):
         nested_parse_with_titles(self.state, result, node)
         return node.children
 
+
+def get_help_files(cli_ctx):
+    cli_ctx.invocation = cli_ctx.invocation_cls(cli_ctx=cli_ctx, commands_loader_cls=cli_ctx.commands_loader_cls, parser_cls=cli_ctx.parser_cls, help_cls=cli_ctx.help_cls)
+    cli_ctx.invocation.commands_loader.load_command_table([])
+    cmd_table = cli_ctx.invocation.commands_loader.command_table
+    for command in cmd_table:
+        cli_ctx.invocation.commands_loader.load_arguments(command)
+    cli_ctx.invocation.parser.load_command_table(cli_ctx.invocation.commands_loader)
+
+    parser_keys = []
+    parser_values = []
+    sub_parser_keys = []
+    sub_parser_values = []
+    _store_parsers(cli_ctx.invocation.parser, parser_keys, parser_values, sub_parser_keys, sub_parser_values)
+    for cmd, parser in zip(parser_keys, parser_values):
+        if cmd not in sub_parser_keys:
+            sub_parser_keys.append(cmd)
+            sub_parser_values.append(parser)
+
+    help_ctx = cli_ctx.help_cls(cli_ctx=cli_ctx)
+    help_files = []
+    for cmd, parser in zip(sub_parser_keys, sub_parser_values):
+        try:
+            help_file = GroupHelpFile(help_ctx, cmd, parser) if _is_group(parser) else help_ctx.command_help_cls(help_ctx, cmd, parser)
+            help_file.load(parser)
+            help_files.append(help_file)
+        except Exception as ex:
+            print("Skipped '{}' due to '{}'".format(cmd, ex))
+    help_files = sorted(help_files, key=lambda x: x.command)
+    return help_files
+
 def setup(app):
     app.add_directive('vsts', VstsHelpGenDirective)
 

scripts/generate_command_inventory.py

@@ -20,10 +20,10 @@
 
 cli_name = "vsts"
 vstscli = CLI(cli_name=cli_name,
-        config_dir=os.path.join('~', '.{}'.format(cli_name)),
-        config_env_var_prefix=cli_name,
-        commands_loader_cls=VstsCommandsLoader,
-        help_cls=VstsCLIHelp)
+              config_dir=os.path.join('~', '.{}'.format(cli_name)),
+              config_env_var_prefix=cli_name,
+              commands_loader_cls=VstsCommandsLoader,
+              help_cls=VstsCLIHelp)
 
 loader = vstscli.commands_loader_cls()
 loader.__init__(vstscli)

scripts/windows/init.cmd

@@ -40,6 +40,7 @@ if not "%~2" == "" (
 
 IF NOT EXIST "%VDIR%" (
     echo Creating new virtual environment under %VDIR%
+    "%PYTHONEXE%" -m pip install virtualenv
     "%PYTHONEXE%" -m venv "%VDIR%"
     if ERRORLEVEL 1 (
         if not "%PYTHONDIR%" == "" (

scripts/windows/macros.txt

@@ -41,6 +41,12 @@ fjs=findstr /ips /c:"$*" *.js
 fts=findstr /ips /c:"$*" *.ts
 fproj=findstr /ips /c:"$*" *.*proj
 
+;= ********************************************************************************
+;= * Testing
+;= ********************************************************************************
+ut=run_unit_tests.cmd
+l0=run_unit_tests.cmd
+
 ;= ********************************************************************************
 ;= * Please leave the following line in place, as it is part of the commenting
 ;= * infrastructure in this file.

scripts/windows/run_unit_tests.cmd

@@ -0,0 +1,30 @@
+@REM init section. Set _echo=1 to echo everything
+@IF NOT DEFINED _echo ECHO OFF
+
+IF EXIST "%BUILD_BINARIESDIRECTORY%\python.3.6.2\tools\python.exe" (
+    REM Build step installs Python here.
+    SET PYTHONEXE=%BUILD_BINARIESDIRECTORY%\python.3.6.2\tools\python.exe
+) ELSE (
+    SET PYTHONEXE=python.exe
+)
+
+pushd "%~dp0\..\..\src\common_modules"
+"%PYTHONEXE%" -m unittest discover -s vsts-cli-common -v
+IF ERRORLEVEL 1 GOTO FAIL
+"%PYTHONEXE%" -m unittest discover -s vsts-cli-team-common -v
+IF ERRORLEVEL 1 GOTO FAIL
+popd
+pushd "%~dp0\..\..\src"
+"%PYTHONEXE%" -m unittest discover -s vsts-cli -v
+IF ERRORLEVEL 1 GOTO FAIL
+popd
+
+
+SET PYTHONEXE=
+
+GOTO :EOF
+
+:FAIL
+popd
+ECHO Unit test run failed.
+EXIT /B 1

src/command_modules/vsts-cli-admin/LICENSE.txt

@@ -0,0 +1,21 @@
+Copyright (c) Microsoft Corporation. All rights reserved.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.