Since version 0.9.0 of Buildbot "slave"-based terminology is deprecated in favor of "worker"-based terminology.
API change is done in backward compatible way, so old "slave"-containing classes, functions and attributes are still available and can be used. Old API support will be removed in the future versions of Buildbot.
Rename of API introduced in beta versions of Buildbot 0.9.0 done without providing fallback. See release notes for the list of breaking changes of private interfaces. The fallbacks have been removed in Buildbot version 2.0.0.
Use of obsolete names will raise Python warnings with category :pybuildbot.worker_transition.DeprecatedWorkerAPIWarning
. By default these warnings are printed in the application log. This behaviour can be changed by setting appropriate Python warnings settings via Python's :pywarnings
module:
import warnings
from buildbot.worker_transition import DeprecatedWorkerAPIWarning
# Treat old-name usage as errors:
warnings.simplefilter("error", DeprecatedWorkerAPIWarning)
See Python's :pywarnings
module documentation for complete list of available actions, in particular warnings can be disabled using "ignore"
action.
It's recommended to configure warnings inside buildbot.tac
, before using any other Buildbot classes.
In general "Slave" and "Buildslave" parts in identifiers and messages were replaced with "Worker"; "SlaveBuilder" with "WorkerForBuilder".
Below is the list of changed API (use of old names from this list will work). Note that some of these symbols are not included in Buildbot's public API. Compatibility is provided as a convenience to those using the private symbols anyway.
- :py
buildbot.interfaces.IBuildSlave
was renamed to :py~buildbot.interfaces.IWorker
- :py
buildbot.interfaces.NoSlaveError
(private) left as is, but deprecated (it shouldn't be used at all) - :py
buildbot.interfaces.BuildSlaveTooOldError
was renamed to :py~buildbot.interfaces.WorkerTooOldError
- :py
buildbot.interfaces.LatentBuildSlaveFailedToSubstantiate
(private) was renamed to :py~buildbot.interfaces.LatentWorkerFailedToSubstantiate
- :py
buildbot.interfaces.ILatentBuildSlave
was renamed to :py~buildbot.interfaces.ILatentWorker
- :py
buildbot.interfaces.ISlaveStatus
(will be removed in 0.9.x) was renamed to :py~buildbot.interfaces.IWorkerStatus
- :py
buildbot.buildslave
module with all contents was renamed to :pybuildbot.worker
- :py
buildbot.buildslave.AbstractBuildSlave
was renamed to :pybuildbot.worker.AbstractWorker
- :py
buildbot.buildslave.AbstractBuildSlave.slavename
(private) was renamed to :pybuildbot.worker.AbstractWorker.workername
- :py
buildbot.buildslave.AbstractLatentBuildSlave
was renamed to :pybuildbot.worker.AbstractLatentWorker
- :py
buildbot.buildslave.BuildSlave
was renamed to :pybuildbot.worker.Worker
- :py
buildbot.buildslave.ec2
was renamed to :pybuildbot.worker.ec2
- :py
buildbot.buildslave.ec2.EC2LatentBuildSlave
was renamed to :pybuildbot.worker.ec2.EC2LatentWorker
- :py
buildbot.buildslave.libvirt
was renamed to :pybuildbot.worker.libvirt
- :py
buildbot.buildslave.libvirt.LibVirtSlave
was renamed to :pybuildbot.worker.libvirt.LibVirtWorker
- :py
buildbot.buildslave.openstack
was renamed to :pybuildbot.worker.openstack
- :py
buildbot.buildslave.openstack.OpenStackLatentBuildSlave
was renamed to :pybuildbot.worker.openstack.OpenStackLatentWorker
- :py
buildbot.config.MasterConfig.slaves
was renamed to :py~buildbot.config.MasterConfig.workers
- :py
buildbot.config.BuilderConfig
constructor keyword argumentslavename
was renamed toworkername
- :py
buildbot.config.BuilderConfig
constructor keyword argumentslavenames
was renamed toworkernames
- :py
buildbot.config.BuilderConfig
constructor keyword argumentslavebuilddir
was renamed toworkerbuilddir
- :py
buildbot.config.BuilderConfig
constructor keyword argumentnextSlave
was renamed tonextWorker
- :py
buildbot.config.BuilderConfig.slavenames
was renamed to :py~buildbot.config.BuilderConfig.workernames
- :py
buildbot.config.BuilderConfig.slavebuilddir
was renamed to :py~buildbot.config.BuilderConfig.workerbuilddir
- :py
buildbot.config.BuilderConfig.nextSlave
was renamed to :py~buildbot.config.BuilderConfig.nextWorker
- :py
buildbot.process.slavebuilder
was renamed to :pybuildbot.process.workerforbuilder
- :py
buildbot.process.slavebuilder.AbstractSlaveBuilder
was renamed to :pybuildbot.process.workerforbuilder.AbstractWorkerForBuilder
- :py
buildbot.process.slavebuilder.AbstractSlaveBuilder.slave
was renamed to :pybuildbot.process.workerforbuilder.AbstractWorkerForBuilder.worker
- :py
buildbot.process.slavebuilder.SlaveBuilder
was renamed to :pybuildbot.process.workerforbuilder.WorkerForBuilder
- :py
buildbot.process.slavebuilder.LatentSlaveBuilder
was renamed to :pybuildbot.process.workerforbuilder.LatentWorkerForBuilder
- :py
buildbot.process.build.Build.getSlaveName
was renamed to :py~buildbot.process.build.Build.getWorkerName
- :py
buildbot.process.build.Build.slavename
was renamed to :py~buildbot.process.build.Build.workername
- :py
buildbot.process.builder.enforceChosenSlave
was renamed to :py~buildbot.process.builder.enforceChosenWorker
- :py
buildbot.process.builder.Builder.canStartWithSlavebuilder
was renamed to :py~buildbot.process.builder.Builder.canStartWithWorkerForBuilder
- :py
buildbot.process.builder.Builder.attaching_slaves
was renamed to :py~buildbot.process.builder.Builder.attaching_workers
- :py
buildbot.process.builder.Builder.slaves
was renamed to :py~buildbot.process.builder.Builder.workers
- :py
buildbot.process.builder.Builder.addLatentSlave
was renamed to :py~buildbot.process.builder.Builder.addLatentWorker
- :py
buildbot.process.builder.Builder.getAvailableSlaves
was renamed to :py~buildbot.process.builder.Builder.getAvailableWorkers
- :py
buildbot.schedulers.forcesched.BuildslaveChoiceParameter
was renamed to :py~buildbot.schedulers.forcesched.WorkerChoiceParameter
- :py
buildbot.process.buildstep.BuildStep.buildslave
was renamed to :pybuildbot.process.buildstep.BuildStep.worker
(also it was moved from class static attribute to instance attribute) - :py
buildbot.process.buildstep.BuildStep.setBuildSlave
was renamed to :pybuildbot.process.buildstep.BuildStep.setWorker
- :py
buildbot.process.buildstep.BuildStep.slaveVersion
was renamed to :pybuildbot.process.buildstep.BuildStep.workerVersion
- :py
buildbot.process.buildstep.BuildStep.slaveVersionIsOlderThan
was renamed to :pybuildbot.process.buildstep.BuildStep.workerVersionIsOlderThan
- :py
buildbot.process.buildstep.BuildStep.checkSlaveHasCommand
was renamed to :pybuildbot.process.buildstep.BuildStep.checkWorkerHasCommand
- :py
buildbot.process.buildstep.BuildStep.getSlaveName
was renamed to :pybuildbot.process.buildstep.BuildStep.getWorkerName
- :py
buildbot.locks.SlaveLock
was renamed to :pybuildbot.locks.WorkerLock
- :py
buildbot.locks.SlaveLock.maxCountForSlave
was renamed to :pybuildbot.locks.WorkerLock.maxCountForWorker
- :py
buildbot.locks.SlaveLock
constructor argumentmaxCountForSlave
was renamed tomaxCountForWorker
- :py
buildbot.steps.slave
was renamed to :pybuildbot.steps.worker
- :py
buildbot.steps.slave.SlaveBuildStep
was renamed to :pybuildbot.steps.worker.WorkerBuildStep
- :py
buildbot.steps.slave.CompositeStepMixin.getFileContentFromSlave
was renamed to :pybuildbot.steps.worker.CompositeStepMixin.getFileContentFromWorker
- :py
buildbot.steps.transfer.FileUpload.slavesrc
was renamed :py~buildbot.steps.transfer.FileUpload.workersrc
- :py
buildbot.steps.transfer.FileUpload
constructor argumentslavesrc
was renamed toworkersrc
- :py
buildbot.steps.transfer.DirectoryUpload.slavesrc
was renamed to :py~buildbot.steps.transfer.DirectoryUpload.workersrc
- :py
buildbot.steps.transfer.DirectoryUpload
constructor argumentslavesrc
was renamed toworkersrc
- :py
buildbot.steps.transfer.MultipleFileUpload.slavesrcs
was renamed to :py~buildbot.steps.transfer.MultipleFileUpload.workersrcs
- :py
buildbot.steps.transfer.MultipleFileUpload
constructor argumentslavesrcs
was renamed toworkersrcs
- :py
buildbot.steps.transfer.FileDownload.slavedest
was renamed to :py~buildbot.steps.transfer.FileDownload.workerdest
- :py
buildbot.steps.transfer.FileDownload
constructor argumentslavedest
was renamed toworkerdest
- :py
buildbot.steps.transfer.StringDownload.slavedest
was renamed to :py~buildbot.steps.transfer.StringDownload.workerdest
- :py
buildbot.steps.transfer.StringDownload
constructor argumentslavedest
was renamed toworkerdest
- :py
buildbot.steps.transfer.JSONStringDownload.slavedest
was renamed to :py~buildbot.steps.transfer.JSONStringDownload.workerdest
- :py
buildbot.steps.transfer.JSONStringDownload
constructor argumentslavedest
was renamed toworkerdest
- :py
buildbot.steps.transfer.JSONPropertiesDownload.slavedest
was renamed to :py~buildbot.steps.transfer.JSONPropertiesDownload.workerdest
- :py
buildbot.steps.transfer.JSONPropertiesDownload
was renamed to constructor argumentslavedest
was renamed toworkerdest
- :py
buildbot.process.remotecommand.RemoteCommand.buildslave
was renamed to :py~buildbot.process.remotecommand.RemoteCommand.worker
buildbot.buildslave
entry point was renamed to buildbot.worker
, new plugins should be updated accordingly.
Plugins that use old buildbot.buildslave
entry point are still available in the configuration file in the same way, as they were in versions prior 0.9.0:
from buildbot.plugins import buildslave # deprecated, use "worker" instead
w = buildslave.ThirdPartyWorker()
But also they available using new namespace inside configuration file, so its recommended to use buildbot.plugins.worker
name even if plugin uses old entry points:
from buildbot.plugins import worker
# ThirdPartyWorker can be defined in using `buildbot.buildslave` entry
# point, this still will work.
w = worker.ThirdPartyWorker()
Other changes:
buildbot.plugins.util.BuildslaveChoiceParameter
is deprecated in favor ofWorkerChoiceParameter
.buildbot.plugins.util.enforceChosenSlave
is deprecated in favor ofenforceChosenWorker
.buildbot.plugins.util.SlaveLock
is deprecated in favor ofWorkerLock
.
c['slaves']
was replaced withc['workers']
. Use ofc['slaves']
will work, but is considered deprecated, and will be removed in the future versions of Buildbot.- Configuration key
c['slavePortnum']
is deprecated in favor ofc['protocols']['pb']['port']
.
In addition to class being renamed, environment variables that are set inside container SLAVENAME
and SLAVEPASS
were renamed to WORKERNAME
and WORKERPASS
accordingly. Old environment variable are still available, but are deprecated and will be removed in the future.
Use of default values of keypair_name
and security_name
constructor arguments of :pybuildbot.worker.ec2.EC2LatentWorker
is deprecated. Please specify them explicitly.
In addition to buildbot.steps.slave
module being renamed to :pybuildbot.steps.worker
, default source
value for :py~buildbot.steps.worker.SetPropertiesFromEnv
was changed from "SlaveEnvironment"
to "WorkerEnvironment"
.
Working directory for local workers were changed from master-basedir/slaves/name
to master-basedir/workers/name
.
slave_config
function argument was renamed to worker_config
.
slavename
property is deprecated in favor ofworkername
property. Render of deprecated property will produce warning.:py
buildbot.worker.AbstractWorker
(previouslybuildbot.buildslave.AbstractBuildSlave
)slavename
property source were changed fromBuildSlave
toWorker (deprecated)
:py
~buildbot.worker.AbstractWorker
now setsworkername
property with sourceWorker
which should be used.
- :py
buildbot.process.metrics.AttachedSlavesWatcher
was renamed to :pybuildbot.process.metrics.AttachedWorkersWatcher
. - :py
buildbot.worker.manager.WorkerManager.name
(previouslybuildbot.buildslave.manager.BuildslaveManager.name
) metric measurement class name changed fromBuildslaveManager
toWorkerManager
- :py
buildbot.worker.manager.WorkerManager.managed_services_name
(previouslybuildbot.buildslave.manager.BuildslaveManager.managed_services_name`) metric measurement managed service name changed from
buildslavesto
workers``
Renamed events:
Old name | New name |
---|---|
AbstractBuildSlave.attached_slaves |
AbstractWorker.attached_workers |
BotMaster.attached_slaves |
BotMaster.attached_workers |
BotMaster.slaveLost() |
BotMaster.workerLost() |
BotMaster.getBuildersForSlave() |
BotMaster.getBuildersForWorker() |
AttachedSlavesWatcher |
AttachedWorkersWatcher |
attached_slaves |
attached_workers |
Schema changes:
Old name | New name |
---|---|
buildslaves table |
workers |
builds.buildslaveid (not ForeignKey) column |
workerid (now ForeignKey) |
configured_buildslaves table |
configured_workers |
configured_buildslaves.buildslaveid (ForeignKey) column |
workerid |
connected_buildslaves table |
connected_workers |
connected_buildslaves.buildslaveid (ForeignKey) column |
workerid |
buildslaves_name index |
workers_name |
configured_slaves_buildmasterid index |
configured_workers_buildmasterid |
configured_slaves_slaves index |
configured_workers_workers |
configured_slaves_identity index |
configured_workers_identity |
connected_slaves_masterid index |
connected_workers_masterid |
connected_slaves_slaves index |
connected_workers_workers |
connected_slaves_identity index |
connected_workers_identity |
builds_buildslaveid index |
builds_workerid |
List of database-related changes in API (fallback for old API is provided):
- :py
buildbot.db.buildslaves
was renamed to :py~buildbot.db.workers
- :py
buildbot.db.buildslaves.BuildslavesConnectorComponent
was renamed to :pybuildbot.db.workers.WorkersConnectorComponent
- :py
buildbot.db.buildslaves.BuildslavesConnectorComponent.getBuildslaves
(rewritten in nine) was renamed to :pybuildbot.db.workers.WorkersConnectorComponent.getWorkers
- :py
buildbot.db.connector.DBConnector.buildslaves
was renamed to :pybuildbot.db.connector.DBConnector.workers
usePTY
default value has been changed from slave-config
to None
(use of slave-config
will still work, but discouraged).
buildbot-slave
package has been renamed to buildbot-worker
.
buildbot-worker
has backward incompatible changes and requires buildmaster >= 0.9.0b8. buildbot-slave
from 0.8.x will work with both 0.8.x and 0.9.x versions of buildmaster, so there is no need to upgrade currently deployed buildbot-slaves during switch from 0.8.x to 0.9.x.
master 0.8.x | master 0.9.x | |
---|---|---|
buildbot-slave | yes | yes |
buildbot-worker | no | yes |
buildbot-worker
doesn't support worker-side specification of usePTY
(with --usepty
command line switch of buildbot-worker create-worker
), you need to specify this option on master side.
getSlaveInfo
remote command was renamed to getWorkerInfo
in buildbot-worker
.