buildbot/test/test_properties.py

   1 # -*- test-case-name: buildbot.test.test_properties -*-
   2
   3 import os
   4
   5 from twisted.trial import unittest
   6
   7 from buildbot.twcompat import maybeWait
   8 from buildbot.sourcestamp import SourceStamp
   9 from buildbot.process import base
  10 from buildbot.steps.shell import ShellCommand, WithProperties
  11 from buildbot.status import builder
  12 from buildbot.slave.commands import rmdirRecursive
  13 from buildbot.test.runutils import RunMixin
  14
  15 class MyBuildStep(ShellCommand):
  16     def _interpolateProperties(self, command):
  17         command = ["tar", "czf",
  18                    "build-%s.tar.gz" % self.getProperty("revision"),
  19                    "source"]
  20         return ShellCommand._interpolateProperties(self, command)
  21
  22
  23 class FakeBuild:
  24     pass
  25 class FakeBuilder:
  26     statusbag = None
  27     name = "fakebuilder"
  28 class FakeSlave:
  29     slavename = "bot12"
  30 class FakeSlaveBuilder:
  31     slave = FakeSlave()
  32     def getSlaveCommandVersion(self, command, oldversion=None):
  33         return "1.10"
  34
  35 class Interpolate(unittest.TestCase):
  36     def setUp(self):
  37         self.builder = FakeBuilder()
  38         self.builder_status = builder.BuilderStatus("fakebuilder")
  39         self.builder_status.basedir = "test_properties"
  40         self.builder_status.nextBuildNumber = 5
  41         rmdirRecursive(self.builder_status.basedir)
  42         os.mkdir(self.builder_status.basedir)
  43         self.build_status = self.builder_status.newBuild()
  44         req = base.BuildRequest("reason", SourceStamp(branch="branch2",
  45                                                       revision=1234))
  46         self.build = base.Build([req])
  47         self.build.setBuilder(self.builder)
  48         self.build.setupStatus(self.build_status)
  49         self.build.setupSlaveBuilder(FakeSlaveBuilder())
  50
  51     def testWithProperties(self):
  52         self.build.setProperty("revision", 47)
  53         self.failUnlessEqual(self.build_status.getProperty("revision"), 47)
  54         c = ShellCommand(workdir=dir, build=self.build,
  55                          command=["tar", "czf",
  56                                   WithProperties("build-%s.tar.gz",
  57                                                  "revision"),
  58                                   "source"])
  59         cmd = c._interpolateProperties(c.command)
  60         self.failUnlessEqual(cmd,
  61                              ["tar", "czf", "build-47.tar.gz", "source"])
  62
  63     def testWithPropertiesDict(self):
  64         self.build.setProperty("other", "foo")
  65         self.build.setProperty("missing", None)
  66         c = ShellCommand(workdir=dir, build=self.build,
  67                          command=["tar", "czf",
  68                                   WithProperties("build-%(other)s.tar.gz"),
  69                                   "source"])
  70         cmd = c._interpolateProperties(c.command)
  71         self.failUnlessEqual(cmd,
  72                              ["tar", "czf", "build-foo.tar.gz", "source"])
  73
  74     def testWithPropertiesEmpty(self):
  75         self.build.setProperty("empty", None)
  76         c = ShellCommand(workdir=dir, build=self.build,
  77                          command=["tar", "czf",
  78                                   WithProperties("build-%(empty)s.tar.gz"),
  79                                   "source"])
  80         cmd = c._interpolateProperties(c.command)
  81         self.failUnlessEqual(cmd,
  82                              ["tar", "czf", "build-.tar.gz", "source"])
  83
  84     def testCustomBuildStep(self):
  85         c = MyBuildStep(workdir=dir, build=self.build)
  86         cmd = c._interpolateProperties(c.command)
  87         self.failUnlessEqual(cmd,
  88                              ["tar", "czf", "build-1234.tar.gz", "source"])
  89
  90     def testSourceStamp(self):
  91         c = ShellCommand(workdir=dir, build=self.build,
  92                          command=["touch",
  93                                   WithProperties("%s-dir", "branch"),
  94                                   WithProperties("%s-rev", "revision"),
  95                                   ])
  96         cmd = c._interpolateProperties(c.command)
  97         self.failUnlessEqual(cmd,
  98                              ["touch", "branch2-dir", "1234-rev"])
  99
 100     def testSlaveName(self):
 101         c = ShellCommand(workdir=dir, build=self.build,
 102                          command=["touch",
 103                                   WithProperties("%s-slave", "slavename"),
 104                                   ])
 105         cmd = c._interpolateProperties(c.command)
 106         self.failUnlessEqual(cmd,
 107                              ["touch", "bot12-slave"])
 108
 109     def testBuildNumber(self):
 110         c = ShellCommand(workdir=dir, build=self.build,
 111                          command=["touch",
 112                                   WithProperties("build-%d", "buildnumber"),
 113                                   WithProperties("builder-%s", "buildername"),
 114                                   ])
 115         cmd = c._interpolateProperties(c.command)
 116         self.failUnlessEqual(cmd,
 117                              ["touch", "build-5", "builder-fakebuilder"])
 118
 119
 120 run_config = """
 121 from buildbot.process import factory
 122 from buildbot.steps.shell import ShellCommand, WithProperties
 123 s = factory.s
 124
 125 BuildmasterConfig = c = {}
 126 c['bots'] = [('bot1', 'sekrit')]
 127 c['sources'] = []
 128 c['schedulers'] = []
 129 c['slavePortnum'] = 0
 130
 131 # Note: when run against twisted-1.3.0, this locks up about 5% of the time. I
 132 # suspect that a command with no output that finishes quickly triggers a race
 133 # condition in 1.3.0's process-reaping code. The 'touch' process becomes a
 134 # zombie and the step never completes. To keep this from messing up the unit
 135 # tests too badly, this step runs with a reduced timeout.
 136
 137 f1 = factory.BuildFactory([s(ShellCommand,
 138                              flunkOnFailure=True,
 139                              command=['touch',
 140                                       WithProperties('%s-slave', 'slavename'),
 141                                       ],
 142                              workdir='.',
 143                              timeout=10,
 144                              )])
 145
 146 b1 = {'name': 'full1', 'slavename': 'bot1', 'builddir': 'bd1', 'factory': f1}
 147 c['builders'] = [b1]
 148
 149 """
 150
 151 class Run(RunMixin, unittest.TestCase):
 152     def testInterpolate(self):
 153         # run an actual build with a step that interpolates a build property
 154         d = self.master.loadConfig(run_config)
 155         d.addCallback(lambda res: self.master.startService())
 156         d.addCallback(lambda res: self.connectOneSlave("bot1"))
 157         d.addCallback(lambda res: self.requestBuild("full1"))
 158         d.addCallback(self.failUnlessBuildSucceeded)
 159         def _check_touch(res):
 160             f = os.path.join("slavebase-bot1", "bd1", "bot1-slave")
 161             self.failUnless(os.path.exists(f))
 162             return res
 163         d.addCallback(_check_touch)
 164         return maybeWait(d)
 165
 166
 167 # we test got_revision in test_vc