File: salt.py

package info (click to toggle)
python-os-faults 0.2.7-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 696 kB
  • sloc: python: 4,797; sh: 54; makefile: 24
file content (69 lines) | stat: -rw-r--r-- 2,209 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
# Licensed 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 os_faults.drivers.services import process
from os_faults.drivers import shared_schemas


SALT_CALL = 'salt-call --local --retcode-passthrough '
SALT_RESTART = SALT_CALL + 'service.restart {service}'
SALT_TERMINATE = SALT_CALL + 'service.stop {service}'
SALT_START = SALT_CALL + 'service.start {service}'


class SaltService(process.ServiceAsProcess):
    """Salt service

    Service that can be controlled by `salt service.*` commands.

    **Example configuration:**

    .. code-block:: yaml

        services:
          app:
            driver: salt_service
            args:
              salt_service: app
              grep: my_app
              port: ['tcp', 4242, 'egress']

    parameters:

    - **salt_service** - name of a service
    - **grep** - regexp for grep to find process PID
    - **port** - tuple with two or three values - protocol, port number,
      direction (optional)

    """

    NAME = 'salt_service'
    DESCRIPTION = 'Service in salt'
    CONFIG_SCHEMA = {
        'type': 'object',
        'properties': {
            'salt_service': {'type': 'string'},
            'grep': {'type': 'string'},
            'port': shared_schemas.PORT_SCHEMA,
        },
        'required': ['grep', 'salt_service'],
        'additionalProperties': False,
    }

    def __init__(self, *args, **kwargs):
        super(SaltService, self).__init__(*args, **kwargs)
        self.salt_service = self.config['salt_service']

        self.restart_cmd = SALT_RESTART.format(service=self.salt_service)
        self.terminate_cmd = SALT_TERMINATE.format(service=self.salt_service)
        self.start_cmd = SALT_START.format(service=self.salt_service)