Implement a WinRM runner

CHANGELOG.rst

@@ -7,6 +7,16 @@ in development
 Added
 ~~~~~
 
+* Add new runners: ``winrm-cmd``, ``winrm-ps-cmd`` and ``winrm-ps-script``.
+  The ``winrm-cmd`` runner executes Command Prompt commands remotely on Windows hosts using the
+  WinRM protocol. The ``winrm-ps-cmd`` and ``winrm-ps-script`` runners execute PowerShell commands
+  and scripts on remote Windows hosts using the WinRM protocol.
+
+  To accompany these new runners, there are two new actions ``core.winrm_cmd`` that executes remote
+  Command Prompt commands along with ``core.winrm_ps_cmd`` that executes remote PowerShell commands.
+  (new feature) #1636
+
+  Contributed by Nick Maludy (Encore Technologies).
 * Add new ``?tags``, query param filter to the ``/v1/actions`` API endpoint. This query parameter
   allows users to filter out actions based on the tag name . By default, when no filter values are
   provided, all actions are returned. (new feature) #4219
@@ -17,6 +27,11 @@ Changed
 * Update ``st2client/setup.py`` file to dynamically load requirements from
   ``st2client/requirements.txt`` file. The code works with pip >= 6.0.0, although using pip 9.0.0
   or higher is strongly recommended. (improvement) #4209
+* Migrated runners to using the ``in-requirements.txt`` pattern for "components" in the build
+  system, so the ``Makefile`` correctly generates and installs runner dependencies during
+  testing and packaging. (improvement) (bugfix) #4169
+
+  Contributed by Nick Maludy (Encore Technologies).
 
 2.8.0 - July 10, 2018
 ---------------------

Makefile

@@ -316,10 +316,10 @@ requirements: virtualenv .sdist-requirements
 	$(VIRTUALENV_DIR)/bin/pip install --upgrade "virtualenv==15.1.0" # Required for packs.install in dev envs.
 
 	# Generate all requirements to support current CI pipeline.
-	$(VIRTUALENV_DIR)/bin/python scripts/fixate-requirements.py --skip=virtualenv -s st2*/in-requirements.txt -f fixed-requirements.txt -o requirements.txt
+	$(VIRTUALENV_DIR)/bin/python scripts/fixate-requirements.py --skip=virtualenv -s st2*/in-requirements.txt contrib/runners/*/in-requirements.txt -f fixed-requirements.txt -o requirements.txt
 
 	# Generate finall requirements.txt file for each component
-	@for component in $(COMPONENTS); do\
+	@for component in $(COMPONENTS_WITH_RUNNERS); do\
 		echo "==========================================================="; \
 		echo "Generating requirements.txt for" $$component; \
 		echo "==========================================================="; \

contrib/core/actions/winrm_cmd.yaml

@@ -0,0 +1,12 @@
+
+---
+  name: "winrm_cmd"
+  runner_type: "winrm-cmd"
+  description: "Action to execute arbitrary Windows Command Prompt command remotely via WinRM."
+  enabled: true
+  entry_point: ""
+  parameters:
+    cmd:
+      description: "Arbitrary Windows Command Prompt command to be executed on the remote host."
+      type: "string"
+      required: true

contrib/core/actions/winrm_ps_cmd.yaml

@@ -0,0 +1,12 @@
+
+---
+  name: "winrm_ps_cmd"
+  runner_type: "winrm-ps-cmd"
+  description: "Action to execute arbitrary Windows PowerShell command remotely via WinRM."
+  enabled: true
+  entry_point: ""
+  parameters:
+    cmd:
+      description: "Arbitrary Windows PowerShell command to be executed on the remote host."
+      type: "string"
+      required: true

contrib/examples/actions/winrm_get_uptime.yaml

@@ -0,0 +1,6 @@
+---
+name: "winrm_get_uptime"
+description: "Action that returns Windows host's uptime using WinRM."
+enabled: true
+entry_point: "windows/get_uptime.ps1"
+runner_type: "winrm-ps-script"

contrib/examples/actions/winrm_ipconfig.yaml

@@ -0,0 +1,10 @@
+---
+name: "winrm_get_ipconfig"
+description: "Action that returns Windows host's IP config information."
+enabled: true
+runner_type: "winrm-cmd"
+parameters:
+  cmd:
+    type: string
+    default: "ipconfig /all"
+    immutable: true

contrib/examples/actions/winrm_powershell_env.yaml

@@ -0,0 +1,17 @@
+---
+name: "winrm_powershell_env"
+description: "Action that sets an environment variable then prints it out. This also demonstrates returning JSON data from PowerShell and being able to utilize it as an object via stdout."
+enabled: true
+runner_type: "winrm-ps-cmd"
+parameters:
+  env_var_name:
+    type: string
+    default: "ST2_WINRM_ENV_TEST"
+  cmd:
+    type: string
+    default: "Get-Item Env:{{ env_var_name }} | ConvertTo-Json -Depth 1 -Compress"
+    immutable: true
+  env:
+    type: object
+    default:
+      "{{ env_var_name }}": "This is a test"

contrib/runners/action_chain_runner/requirements.txt

@@ -0,0 +1,2 @@
+# Don't edit this file. It's generated automatically!
+

contrib/runners/announcement_runner/requirements.txt

@@ -0,0 +1,2 @@
+# Don't edit this file. It's generated automatically!
+

contrib/runners/cloudslang_runner/requirements.txt

@@ -0,0 +1,2 @@
+# Don't edit this file. It's generated automatically!
+

contrib/runners/http_runner/requirements.txt

@@ -0,0 +1,2 @@
+# Don't edit this file. It's generated automatically!
+

contrib/runners/inquirer_runner/requirements.txt

@@ -0,0 +1,2 @@
+# Don't edit this file. It's generated automatically!
+

contrib/runners/local_runner/requirements.txt

@@ -0,0 +1,2 @@
+# Don't edit this file. It's generated automatically!
+

contrib/runners/mistral_v2/requirements.txt

@@ -0,0 +1,2 @@
+# Don't edit this file. It's generated automatically!
+

contrib/runners/noop_runner/requirements.txt

@@ -0,0 +1,2 @@
+# Don't edit this file. It's generated automatically!
+

contrib/runners/python_runner/requirements.txt

@@ -0,0 +1,2 @@
+# Don't edit this file. It's generated automatically!
+

contrib/runners/remote_runner/requirements.txt

@@ -0,0 +1,2 @@
+# Don't edit this file. It's generated automatically!
+

contrib/runners/windows_runner/requirements.txt

@@ -0,0 +1,2 @@
+# Don't edit this file. It's generated automatically!
+

contrib/runners/winrm_runner/MANIFEST.in

@@ -0,0 +1,11 @@
+# https://docs.python.org/2/distutils/sourcedist.html#commands
+# Include all files under the source tree by default.
+# Another behaviour can be used in the future though.
+include __init__.py
+include runner.yaml
+include dist_utils.py
+include requirements.txt
+include README.rst
+include CHANGELOG.rst
+include LICENSE
+global-exclude *.pyc

contrib/runners/winrm_runner/dist_utils.py

@@ -0,0 +1,107 @@
+# -*- coding: utf-8 -*-
+# Licensed to the StackStorm, Inc ('StackStorm') under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from __future__ import absolute_import
+import os
+import re
+import sys
+
+from distutils.version import StrictVersion
+
+GET_PIP = 'curl https://bootstrap.pypa.io/get-pip.py | python'
+
+try:
+    import pip
+    from pip import __version__ as pip_version
+except ImportError as e:
+    print('Failed to import pip: %s' % (str(e)))
+    print('')
+    print('Download pip:\n%s' % (GET_PIP))
+    sys.exit(1)
+
+try:
+    # pip < 10.0
+    from pip.req import parse_requirements
+except ImportError:
+    # pip >= 10.0
+
+    try:
+        from pip._internal.req.req_file import parse_requirements
+    except ImportError as e:
+        print('Failed to import parse_requirements from pip: %s' % (str(e)))
+        print('Using pip: %s' % (str(pip_version)))
+        sys.exit(1)
+
+__all__ = [
+    'check_pip_version',
+    'fetch_requirements',
+    'apply_vagrant_workaround',
+    'get_version_string',
+    'parse_version_string'
+]
+
+
+def check_pip_version():
+    """
+    Ensure that a minimum supported version of pip is installed.
+    """
+    if StrictVersion(pip.__version__) < StrictVersion('6.0.0'):
+        print("Upgrade pip, your version `{0}' "
+              "is outdated:\n{1}".format(pip.__version__, GET_PIP))
+        sys.exit(1)
+
+
+def fetch_requirements(requirements_file_path):
+    """
+    Return a list of requirements and links by parsing the provided requirements file.
+    """
+    links = []
+    reqs = []
+    for req in parse_requirements(requirements_file_path, session=False):
+        if req.link:
+            links.append(str(req.link))
+        reqs.append(str(req.req))
+    return (reqs, links)
+
+
+def apply_vagrant_workaround():
+    """
+    Function which detects if the script is being executed inside vagrant and if it is, it deletes
+    "os.link" attribute.
+    Note: Without this workaround, setup.py sdist will fail when running inside a shared directory
+    (nfs / virtualbox shared folders).
+    """
+    if os.environ.get('USER', None) == 'vagrant':
+        del os.link
+
+
+def get_version_string(init_file):
+    """
+    Read __version__ string for an init file.
+    """
+
+    with open(init_file, 'r') as fp:
+        content = fp.read()
+        version_match = re.search(r"^__version__ = ['\"]([^'\"]*)['\"]",
+                                  content, re.M)
+        if version_match:
+            return version_match.group(1)
+
+        raise RuntimeError('Unable to find version string in %s.' % (init_file))
+
+
+# alias for get_version_string
+parse_version_string = get_version_string

contrib/runners/winrm_runner/in-requirements.txt

@@ -0,0 +1 @@
+pywinrm

contrib/runners/winrm_runner/requirements.txt

@@ -0,0 +1,2 @@
+# Don't edit this file. It's generated automatically!
+pywinrm==0.3.0

contrib/runners/winrm_runner/runner.yaml

@@ -0,0 +1 @@
+./winrm_runner/runner.yaml

contrib/runners/winrm_runner/setup.py

@@ -0,0 +1,56 @@
+# -*- coding: utf-8 -*-
+# Licensed to the StackStorm, Inc ('StackStorm') under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from __future__ import absolute_import
+import os.path
+
+from setuptools import setup
+from setuptools import find_packages
+
+from dist_utils import fetch_requirements
+from dist_utils import apply_vagrant_workaround
+
+BASE_DIR = os.path.dirname(os.path.abspath(__file__))
+REQUIREMENTS_FILE = os.path.join(BASE_DIR, 'requirements.txt')
+
+install_reqs, dep_links = fetch_requirements(REQUIREMENTS_FILE)
+
+apply_vagrant_workaround()
+setup(
+    name='stackstorm-runner-winrm',
+    version='2.8.0',
+    description=('WinRM shell command and PowerShell script action runner for'
+                 ' the StackStorm event-driven automation platform'),
+    author='StackStorm',
+    author_email='info@stackstorm.com',
+    license='Apache License (2.0)',
+    url='https://stackstorm.com/',
+    install_requires=install_reqs,
+    dependency_links=dep_links,
+    test_suite='tests',
+    zip_safe=False,
+    include_package_data=True,
+    packages=find_packages(exclude=['setuptools', 'tests']),
+    package_data={'winrm_ps_command_runner': ['runner.yaml']},
+    scripts=[],
+    entry_points={
+        'st2common.runners.runner': [
+            'winrm-cmd = winrm_runner.winrm_command_runner',
+            'winrm-ps-cmd = winrm_runner.winrm_ps_command_runner',
+            'winrm-ps-script = winrm_runner.winrm_ps_script_runner',
+        ],
+    }
+)

contrib/runners/winrm_runner/tests/unit/fixtures/TestScript.ps1

@@ -0,0 +1,23 @@
+[CmdletBinding()]
+Param(
+  [bool]$p_bool,
+  [int]$p_integer,
+  [double]$p_number,
+  [string]$p_str,
+  [array]$p_array,
+  [hashtable]$p_obj,
+  [Parameter(Position=0)]
+  [string]$p_pos0,
+  [Parameter(Position=1)]
+  [string]$p_pos1
+)
+
+
+Write-Output "p_bool = $p_bool"
+Write-Output "p_integer = $p_integer"
+Write-Output "p_number = $p_number"
+Write-Output "p_str = $p_str"
+Write-Output "p_array = $($p_array | ConvertTo-Json -Compress)"
+Write-Output "p_obj = $($p_obj | ConvertTo-Json -Compress)"
+Write-Output "p_pos0 = $p_pos0"
+Write-Output "p_pos1 = $p_pos1"