automation: perform tasks on remote machines Sometimes you don't have access to a machine in order to do something. For example, you may not have access to a Windows machine required to build Windows binaries or run tests on that platform. This commit introduces a pile of code intended to help "automate" common tasks, like building release artifacts. In its current form, the automation code provides functionality for performing tasks on Windows EC2 instances. The hgautomation.aws module provides functionality for integrating with AWS. It manages EC2 resources such as IAM roles, EC2 security groups, AMIs, and instances. The hgautomation.windows module provides a higher-level interface for performing tasks on remote Windows machines. The hgautomation.cli module provides a command-line interface to these higher-level primitives. I attempted to structure Windows remote machine interaction around Windows Remoting / PowerShell. This is kinda/sorta like SSH + shell, but for Windows. In theory, most of the functionality is cloud provider agnostic, as we should be able to use any established WinRM connection to interact with a remote. In reality, we're tightly coupled to AWS at the moment because I didn't want to prematurely add abstractions for a 2nd cloud provider. (1 was hard enough to implement.) In the aws module is code for creating an image with a fully functional Mercurial development environment. It contains VC9, VC2017, msys, and other dependencies. The image is fully capable of building all the existing Mercurial release artifacts and running tests. There are a few things that don't work. For example, running Windows tests with Python 3. But building the Windows release artifacts does work. And that was an impetus for this work. (Although we don't yet support code signing.) Getting this functionality to work was extremely time consuming. It took hours debugging permissions failures and other wonky behavior due to PowerShell Remoting. (The permissions model for PowerShell is crazy and you brush up against all kinds of issues because of the user/privileges of the user running the PowerShell and the permissions of the PowerShell session itself.) The functionality around AWS resource management could use some improving. In theory we support shared tenancy via resource name prefixing. In reality, we don't offer a way to configure this. Speaking of AWS resource management, I thought about using a tool like Terraform to manage resources. But at our scale, writing a few dozen lines of code to manage resources seemed acceptable. Maybe we should reconsider this if things grow out of control. Time will tell. Currently, emphasis is placed on Windows. But I only started there because it was likely to be the most difficult to implement. It should be relatively trivial to automate tasks on remote Linux machines. In fact, I have a ~1 year old script to run tests on a remote EC2 instance. I will likely be porting that to this new "framework" in the near future. # no-check-commit because foo_bar functions Differential Revision: https://phab.mercurial-scm.org/D6142

     1

# winrm.py - Interact with Windows Remote Management (WinRM)

     2

#

     3

# Copyright 2019 Gregory Szorc <gregory.szorc@gmail.com>

     4

#

     5

# This software may be used and distributed according to the terms of the

     6

# GNU General Public License version 2 or any later version.

     7

     8

# no-check-code because Python 3 native.

     9

    10

import logging

    11

import pprint

    12

import time

    13

    14

from pypsrp.client import (

    15

    Client,

    16

)

    17

from pypsrp.powershell import (

    18

    PowerShell,

    19

    PSInvocationState,

    20

    RunspacePool,

    21

)

    22

import requests.exceptions

    23

    24

    25

logger = logging.getLogger(__name__)

    26

    27

    28

def wait_for_winrm(host, username, password, timeout=120, ssl=False):

    29

    """Wait for the Windows Remoting (WinRM) service to become available.

    30

    31

    Returns a ``psrpclient.Client`` instance.

    32

    """

    33

    34

    end_time = time.time() + timeout

    35

    36

    while True:

    37

        try:

    38

            client = Client(host, username=username, password=password,

    39

                            ssl=ssl, connection_timeout=5)

    40

            client.execute_cmd('echo "hello world"')

    41

            return client

    42

        except requests.exceptions.ConnectionError:

    43

            if time.time() >= end_time:

    44

                raise

    45

    46

            time.sleep(1)

    47

    48

    49

def format_object(o):

    50

    if isinstance(o, str):

    51

        return o

    52

    53

    try:

    54

        o = str(o)

    55

    except TypeError:

    56

        o = pprint.pformat(o.extended_properties)

    57

    58

    return o

    59

    60

    61

def run_powershell(client, script):

    62

    with RunspacePool(client.wsman) as pool:

    63

        ps = PowerShell(pool)

    64

        ps.add_script(script)

    65

    66

        ps.begin_invoke()

    67

    68

        while ps.state == PSInvocationState.RUNNING:

    69

            ps.poll_invoke()

    70

            for o in ps.output:

    71

                print(format_object(o))

    72

    73

            ps.output[:] = []

    74

    75

        ps.end_invoke()

    76

    77

        for o in ps.output:

    78

            print(format_object(o))

    79

    80

        if ps.state == PSInvocationState.FAILED:

    81

            raise Exception('PowerShell execution failed: %s' %

    82

                            ' '.join(map(format_object, ps.streams.error)))