summaryrefslogtreecommitdiffstats
path: root/jenkins_jobs/cli/subcommand/get_plugins_info.py
blob: 8c76722f354a81e548eb4707eec0e00b3c37f7ff (plain)
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
#!/usr/bin/env python
# Copyright (C) 2017 Thanh Ha
#
# 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.

import logging

import yaml

from jenkins_jobs.builder import JenkinsManager
import jenkins_jobs.cli.subcommand.base as base


logger = logging.getLogger(__name__)


class GetPluginsInfoSubCommand(base.BaseSubCommand):
    def parse_args(self, subparser):
        plugins_info = subparser.add_parser(
            "get-plugins-info", help="get plugins info yaml by querying Jenkins server."
        )

        plugins_info.add_argument(
            "-o",
            "--output-file",
            default="plugins_info.yaml",
            dest="plugins_info_file",
            help="file to save output to.",
        )

    def execute(self, options, jjb_config):
        builder = JenkinsManager(jjb_config)
        plugin_data = builder.jenkins.get_plugins_info()
        plugins_info = []
        for plugin in plugin_data:
            info = {
                "longName": str(plugin["longName"]),
                "shortName": str(plugin["shortName"]),
                "version": str(plugin["version"]),
            }
            plugins_info.append(info)

        if options.plugins_info_file:
            with open(options.plugins_info_file, "w") as outfile:
                outfile.write(yaml.dump(plugins_info))
            logger.info("Generated {} file".format(options.plugins_info_file))
        else:
            print(yaml.dump(plugins_info))