~smoser/cloud-init/lp-1077700

« back to all changes in this revision

Viewing changes to cloudinit/config/cc_yum_add_repo.py

  • Committer: Scott Moser
  • Date: 2012-11-11 03:32:31 UTC
  • mfrom: (687.2.10 yum-repo-conf-write)
  • Revision ID: smoser@ubuntu.com-20121111033231-7qz1g2jlhm9kt1ub
add yum_add_repo configuration module

Add in a configuration module that can write out the yum.repo format for
those that want to hook into different repos for installing.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# vi: ts=4 expandtab
 
2
#
 
3
#    Copyright (C) 2012 Yahoo! Inc.
 
4
#
 
5
#    Author: Joshua Harlow <harlowja@yahoo-inc.com>
 
6
#
 
7
#    This program is free software: you can redistribute it and/or modify
 
8
#    it under the terms of the GNU General Public License version 3, as
 
9
#    published by the Free Software Foundation.
 
10
#
 
11
#    This program is distributed in the hope that it will be useful,
 
12
#    but WITHOUT ANY WARRANTY; without even the implied warranty of
 
13
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
14
#    GNU General Public License for more details.
 
15
#
 
16
#    You should have received a copy of the GNU General Public License
 
17
#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
18
 
 
19
import os
 
20
 
 
21
from cloudinit import util
 
22
 
 
23
import configobj
 
24
 
 
25
 
 
26
def _canonicalize_id(repo_id):
 
27
    repo_id = repo_id.lower().replace("-", "_")
 
28
    repo_id = repo_id.replace(" ", "_")
 
29
    return repo_id
 
30
 
 
31
 
 
32
def _format_repo_value(val):
 
33
    if isinstance(val, (bool)):
 
34
        # Seems like yum prefers 1/0
 
35
        return str(int(val))
 
36
    if isinstance(val, (list, tuple)):
 
37
        # Can handle 'lists' in certain cases
 
38
        # See: http://bit.ly/Qqrf1t
 
39
        return "\n    ".join([_format_repo_value(v) for v in val])
 
40
    if not isinstance(val, (basestring, str)):
 
41
        return str(val)
 
42
    return val
 
43
 
 
44
 
 
45
## TODO(harlowja): move to distro?
 
46
# See man yum.conf
 
47
def _format_repository_config(repo_id, repo_config):
 
48
    to_be = configobj.ConfigObj()
 
49
    to_be[repo_id] = {}
 
50
    # Do basic translation of the items -> values
 
51
    for (k, v) in repo_config.items():
 
52
        # For now assume that people using this know
 
53
        # the format of yum and don't verify keys/values further
 
54
        to_be[repo_id][k] = _format_repo_value(v)
 
55
    lines = to_be.write()
 
56
    lines.insert(0, "# Created by cloud-init on %s" % (util.time_rfc2822()))
 
57
    return "\n".join(lines)
 
58
 
 
59
 
 
60
def handle(name, cfg, _cloud, log, _args):
 
61
    repos = cfg.get('yum_repos')
 
62
    if not repos:
 
63
        log.debug(("Skipping module named %s,"
 
64
                   " no 'yum_repos' configuration found"), name)
 
65
        return
 
66
    repo_base_path = util.get_cfg_option_str(cfg, 'yum_repo_dir',
 
67
                                             '/etc/yum.repos.d/')
 
68
    repo_locations = {}
 
69
    repo_configs = {}
 
70
    for (repo_id, repo_config) in repos.items():
 
71
        canon_repo_id = _canonicalize_id(repo_id)
 
72
        repo_fn_pth = os.path.join(repo_base_path, "%s.repo" % (canon_repo_id))
 
73
        if os.path.exists(repo_fn_pth):
 
74
            log.info("Skipping repo %s, file %s already exists!",
 
75
                     repo_id, repo_fn_pth)
 
76
            continue
 
77
        elif canon_repo_id in repo_locations:
 
78
            log.info("Skipping repo %s, file %s already pending!",
 
79
                     repo_id, repo_fn_pth)
 
80
            continue
 
81
        if not repo_config:
 
82
            repo_config = {}
 
83
        # Do some basic sanity checks/cleaning
 
84
        n_repo_config = {}
 
85
        for (k, v) in repo_config.items():
 
86
            k = k.lower().strip().replace("-", "_")
 
87
            if k:
 
88
                n_repo_config[k] = v
 
89
        repo_config = n_repo_config
 
90
        missing_required = 0
 
91
        for req_field in ['baseurl']:
 
92
            if not req_field in repo_config:
 
93
                log.warn(("Repository %s does not contain a %s"
 
94
                           " configuration 'required' entry"),
 
95
                         repo_id, req_field)
 
96
                missing_required += 1
 
97
        if not missing_required:
 
98
            repo_configs[canon_repo_id] = repo_config
 
99
            repo_locations[canon_repo_id] = repo_fn_pth
 
100
        else:
 
101
            log.warn("Repository %s is missing %s required fields, skipping!",
 
102
                     repo_id, missing_required)
 
103
    for (c_repo_id, path) in repo_locations.items():
 
104
        repo_blob = _format_repository_config(c_repo_id,
 
105
                                              repo_configs.get(c_repo_id))
 
106
        util.write_file(path, repo_blob)