# Copyright (C) 2009-2010 Canonical Ltd.

# Copyright (C) 2012 Hewlett-Packard Development Company, L.P.

#

# Author: Scott Moser <scott.moser@canonical.com>

# Author: Juerg Haefliger <juerg.haefliger@hp.com>

#

# This file is part of cloud-init. See LICENSE file for license information.

"""Runcmd: run arbitrary commands at rc.local with output to the console"""

from cloudinit.config.schema import (

    get_schema_doc, validate_cloudconfig_schema)

from cloudinit.distros import ALL_DISTROS

from cloudinit.settings import PER_INSTANCE

from cloudinit import util

import os

from textwrap import dedent

# The schema definition for each cloud-config module is a strict contract for

# describing supported configuration parameters for each cloud-config section.

# It allows cloud-config to validate and alert users to invalid or ignored

# configuration options before actually attempting to deploy with said

# configuration.

distros = [ALL_DISTROS]

schema = {

    'id': 'cc_runcmd',

    'name': 'Runcmd',

    'title': 'Run arbitrary commands',

    'description': dedent("""\

        Run arbitrary commands at a rc.local like level with output to the

        console. Each item can be either a list or a string. If the item is a

        list, it will be properly executed as if passed to ``execve()`` (with

        the first arg as the command). If the item is a string, it will be

        written to a file and interpreted

        using ``sh``.

        .. note::

          all commands must be proper yaml, so you have to quote any characters

          yaml would eat (':' can be problematic)

        .. note::

          when writing files, do not use /tmp dir as it races with

          systemd-tmpfiles-clean LP: #1707222. Use /run/somedir instead.

    """),

    'distros': distros,

    'examples': [dedent("""\

        runcmd:

            - [ ls, -l, / ]

            - [ sh, -xc, "echo $(date) ': hello world!'" ]

            - [ sh, -c, echo "=========hello world'=========" ]

            - ls -l /root

            - [ wget, "http://example.org", -O, /tmp/index.html ]

    """)],

    'frequency': PER_INSTANCE,

    'type': 'object',

    'properties': {

        'runcmd': {

            'type': 'array',

            'items': {

                'oneOf': [

                    {'type': 'array', 'items': {'type': 'string'}},

                    {'type': 'string'}]

            },

            'additionalItems': False,  # Reject items of non-string non-list

            'additionalProperties': False,

            'minItems': 1,

            'required': [],

        }

    }

}

__doc__ = get_schema_doc(schema)  # Supplement python help()

def handle(name, cfg, cloud, log, _args):

    if "runcmd" not in cfg:

        log.debug(("Skipping module named %s,"

                   " no 'runcmd' key in configuration"), name)

        return

    validate_cloudconfig_schema(cfg, schema)

    out_fn = os.path.join(cloud.get_ipath('scripts'), "runcmd")

    cmd = cfg["runcmd"]

    try:

        content = util.shellify(cmd)

        util.write_file(out_fn, content, 0o700)

    except Exception:

        util.logexc(log, "Failed to shellify %s into file %s", cmd, out_fn)

# vi: ts=4 expandtab