[Buildbot-commits] [Buildbot] #2670: describe/_describe are backward

[Buildbot trac]

#2670: describe/_describe are backward
----------------------+---------------------
Reporter:  dustin     |       Owner:  dustin
    Type:  undecided  |      Status:  new
Priority:  critical   |   Milestone:  0.8.9
 Version:  0.8.8      |  Resolution:
Keywords:             |
----------------------+---------------------

Comment (by dustin):

 A brain-dump about this whole area of Buildbot, based on reading source
 and some conversations with tardyp:

 * "text" is the status text displayed for the step itself (e.g., on the
 build page)
 * "text2" is the status text contributed by this step for the build's
 status (e.g., on the builder page)

 * `setText`/`setText2` set the corresponding status strings in the step
 status

 * `getText`/`getText2` are in !LoggingBuildStep only, and return text
 based on a command.  `getText` calls `self.describe`.

 * the default `describe` calls `_describe`, which returns either
 `descriptionDone`, `description`, or just the step name.  `describe` then
 appends `descriptionSuffix`.

 * The suffix support was primarily added to allow source steps for
 different codebases to distinguish themselves.  It's relatively new.

 * a very common invocation in tests is
   {{{
   #!python
   self.step_status.setText(self.describe(done=True))
   }}}
   This is where the "pull" meets the "push".
   And, of course, this needs to change for new-style steps.

 I feel like new-style steps can throw out almost all of this, and use some
 elegant design.  I'm just not sure yet what that design is.

-- 
Ticket URL: <http://trac.buildbot.net/ticket/2670#comment:2>
Buildbot <http://buildbot.net/>
Buildbot: build/test automation