summaryrefslogtreecommitdiffstats
path: root/jenkins_jobs/modules/project_folder.py
blob: b88db5668e0e95f587b6b95413af764fe39fe5e2 (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
59
60
# -*- coding: utf-8 -*-
# Copyright (C) 2015 Cisco Systems, Inc.
#
# 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.


"""
The folder Project module handles creating Jenkins folder projects.
You may specify ``folder`` in the ``project-type`` attribute of
the :ref:`Job` definition.

Requires the Jenkins :jenkins-wiki:`CloudBees Folders Plugin
<CloudBees+Folders+Plugin>`.

Job example:

    .. literalinclude::
      /../../tests/yamlparser/fixtures/project_folder_template001.yaml

Job template example:

    .. literalinclude::
      /../../tests/yamlparser/fixtures/project_folder_template002.yaml

"""

import xml.etree.ElementTree as XML
import jenkins_jobs.modules.base
from jenkins_jobs.modules.helpers import convert_mapping_to_xml


class Folder(jenkins_jobs.modules.base.Base):
    sequence = 0

    def root_xml(self, data):
        xml_parent = XML.Element(
            "com.cloudbees.hudson.plugins.folder.Folder", plugin="cloudbees-folder"
        )
        attributes = {
            "class": "com.cloudbees.hudson.plugins.folder." "icons.StockFolderIcon"
        }
        XML.SubElement(xml_parent, "icon", attrib=attributes)
        XML.SubElement(xml_parent, "views")
        attributes = {"class": "hudson.views.DefaultViewsTabBar"}
        XML.SubElement(xml_parent, "viewsTabBar", attrib=attributes)

        mappings = [("", "primaryView", "All"), ("", "healthMetrics", "")]
        convert_mapping_to_xml(xml_parent, data, mappings, True)

        return xml_parent