reports/stx_goodies_builder_reports.st
author Claus Gittinger <cg@exept.de>
Thu, 28 Mar 2019 13:54:38 +0100
changeset 542 aa25a71be62a
parent 289 258f98c24a4e
child 295 4dd4d4b67e42
permissions -rw-r--r--
#DOCUMENTATION by cg
class: stx_goodies_builder_quickSelfTest
class definition

class: stx_goodies_builder_quickSelfTest class
added:18 methods
jan@70
     1
"{ Package: 'stx:goodies/builder/reports' }"
jan@70
     2
jan@283
     3
"{ NameSpace: Smalltalk }"
jan@283
     4
jan@70
     5
LibraryDefinition subclass:#stx_goodies_builder_reports
jan@70
     6
	instanceVariableNames:''
jan@70
     7
	classVariableNames:''
jan@70
     8
	poolDictionaries:''
jan@70
     9
	category:'* Projects & Packages *'
jan@70
    10
!
jan@70
    11
jan@70
    12
jan@70
    13
!stx_goodies_builder_reports class methodsFor:'description'!
jan@70
    14
jan@70
    15
excludedFromPreRequisites
jan@70
    16
    "list all packages which should be ignored in the automatic
jan@70
    17
     preRequisites scan. See #preRequisites for more."
jan@70
    18
jan@70
    19
    ^ #(
jan@70
    20
        #'stx:goodies/monticello'    "MCPatch - referenced by HDChangeReport>>changesFor: "
jan@70
    21
    )
jan@70
    22
jan@70
    23
    "Modified: / 08-03-2011 / 22:08:29 / Jan Vrany <jan.vrany@fit.cvut.cz>"
jan@70
    24
!
jan@70
    25
jan@140
    26
mandatoryPreRequisites
jan@140
    27
    "list all required mandatory packages.
jan@140
    28
     Packages are mandatory, if they contain superclasses of the package's classes
jan@140
    29
     or classes which are extended by this package.
jan@70
    30
     This list can be maintained manually or (better) generated and
jan@140
    31
     updated by scanning the superclass hierarchies
jan@165
    32
     (the browser has a menu function for that)"
jan@140
    33
jan@140
    34
    ^ #(
jan@165
    35
        #'stx:goodies/sunit'    "TestAsserter - extended "
jan@165
    36
        #'stx:libbasic'    "LibraryDefinition - superclass of stx_goodies_builder_reports "
jan@140
    37
    )
jan@140
    38
!
jan@140
    39
jan@140
    40
referencedPreRequisites
jan@140
    41
    "list all packages containing classes referenced by the packages's members.
jan@140
    42
     This list can be maintained manually or (better) generated and
jan@140
    43
     updated by looking for global variable accesses
jan@140
    44
     (the browser has a menu function for that)
jan@140
    45
     However, often too much is found, and you may want to explicitely
jan@140
    46
     exclude individual packages in the #excludedFromPreRequisites method."
jan@70
    47
jan@70
    48
    ^ #(
jan@70
    49
        #'stx:goodies/refactoryBrowser/browser'    "PackageEnvironment - referenced by Builder::LintReport>>setupForPackages: "
sv@129
    50
        #'stx:goodies/refactoryBrowser/helpers'    "BrowserEnvironment - referenced by Builder::LintReport>>setupForClasses: "
jan@165
    51
        #'stx:goodies/refactoryBrowser/lint'    "RBBasicLintRule - referenced by Builder::LintReport>>setUp "
jan@165
    52
        #'stx:libcomp'    "InstrumentationContext - referenced by Builder::TestReport>>runReport "
jan@165
    53
    )
jan@165
    54
!
jan@165
    55
jan@165
    56
subProjects
jan@165
    57
    "list packages which are known as subprojects.
jan@165
    58
     The generated makefile will enter those and make there as well.
jan@165
    59
     However: they are not forced to be loaded when a package is loaded;
jan@165
    60
     for those, redefine requiredPrerequisites"
jan@165
    61
jan@165
    62
    ^ #(
jan@70
    63
    )
jan@70
    64
! !
jan@70
    65
jan@70
    66
!stx_goodies_builder_reports class methodsFor:'description - contents'!
jan@70
    67
jan@70
    68
classNamesAndAttributes
jan@70
    69
    "lists the classes which are to be included in the project.
jan@70
    70
     Each entry in the list may be: a single class-name (symbol),
jan@70
    71
     or an array-literal consisting of class name and attributes.
jan@70
    72
     Attributes are: #autoload or #<os> where os is one of win32, unix,..."
jan@70
    73
jan@70
    74
    ^ #(
jan@70
    75
        "<className> or (<className> attributes...) in load order"
jan@289
    76
        (#'Builder::JUnitReportReader' autoload)
jan@70
    77
        #'Builder::Report'
jan@70
    78
        #'Builder::ReportFormat'
jan@70
    79
        #'Builder::ReportRunner'
jan@283
    80
        #'Builder::ReportSourceInfo'
jan@70
    81
        #'stx_goodies_builder_reports'
jan@70
    82
        #'Builder::ChangeReport'
jan@283
    83
        #'Builder::CoverageReport'
jan@283
    84
        #'Builder::CoverageReportFormat'
jan@70
    85
        #'Builder::LintReport'
jan@70
    86
        #'Builder::LintReportFormat'
jan@283
    87
        #'Builder::ReportClassSourceInfo'
jan@283
    88
        #'Builder::ReportExtensionsSourceInfo'
jan@70
    89
        #'Builder::TestReport'
jan@70
    90
        #'Builder::TestReportFormat'
jan@70
    91
    )
jan@70
    92
!
jan@70
    93
jan@70
    94
extensionMethodNames
jan@70
    95
    "lists the extension methods which are to be included in the project.
jan@70
    96
     Entries are 2-element array literals, consisting of class-name and selector."
jan@70
    97
jan@70
    98
    ^ #(
jan@70
    99
        TestCase nameForHDTestReport
jan@70
   100
        TestCase selectorForHDTestReport
jan@70
   101
        'TestCase class' isJUnitTestCaseProxy
jan@70
   102
        'TestCase class' isTestletTestCaseProxy
sv@129
   103
        TestCase timeout
jan@70
   104
    )
jan@70
   105
! !
jan@70
   106
jan@70
   107
!stx_goodies_builder_reports class methodsFor:'description - project information'!
jan@70
   108
jan@70
   109
applicationIconFileName
jan@70
   110
    "Return the name (without suffix) of an icon-file (the app's icon); will be included in the rc-resource file"
jan@70
   111
jan@70
   112
    ^ nil
jan@70
   113
    "/ ^ self applicationName
jan@70
   114
!
jan@70
   115
jan@70
   116
companyName
jan@70
   117
    "Return a companyname which will appear in <lib>.rc"
jan@70
   118
jan@70
   119
    ^ 'SWING Research Group & eXept Software AG'
jan@70
   120
jan@70
   121
    "Modified: / 21-07-2011 / 10:05:05 / Jan Vrany <jan.vrany@fit.cvut.cz>"
jan@70
   122
!
jan@70
   123
jan@70
   124
description
jan@70
   125
    "Return a description string which will appear in vc.def / bc.def"
jan@70
   126
jan@70
   127
    ^ 'Report Runner for Jenkins CI Server'
jan@70
   128
jan@70
   129
    "Modified: / 21-07-2011 / 10:06:33 / Jan Vrany <jan.vrany@fit.cvut.cz>"
jan@70
   130
!
jan@70
   131
jan@70
   132
legalCopyright
jan@70
   133
    "Return a copyright string which will appear in <lib>.rc"
jan@70
   134
jan@70
   135
    ^ 'Copyright Jan Vrany 2011\nCopyright eXept Software AG 2011'
jan@70
   136
jan@70
   137
    "Modified: / 21-07-2011 / 10:05:37 / Jan Vrany <jan.vrany@fit.cvut.cz>"
jan@70
   138
!
jan@70
   139
sv@129
   140
productInstallDirBaseName
sv@129
   141
    "Returns a default installDir which will appear in <app>.nsi.
sv@129
   142
     This is usually not the one you want to keep"
sv@129
   143
sv@129
   144
    ^ (self package asCollectionOfSubstringsSeparatedByAny:':/') last
sv@129
   145
!
sv@129
   146
jan@70
   147
productName
jan@70
   148
    "Return a product name which will appear in <lib>.rc"
jan@70
   149
jan@70
   150
    ^ 'ReportRunner'
jan@70
   151
jan@70
   152
    "Modified: / 21-07-2011 / 10:06:24 / Jan Vrany <jan.vrany@fit.cvut.cz>"
jan@70
   153
! !
jan@70
   154
jan@70
   155
!stx_goodies_builder_reports class methodsFor:'description - startup'!
jan@70
   156
jan@70
   157
startupClassName
jan@70
   158
    "the name of the class which starts the show in its <startupSelector> method.
jan@70
   159
     Usually, the name of a subclass of StandAloneStartup."
jan@70
   160
jan@70
   161
jan@70
   162
    ^ 'HDReportRunner'
jan@70
   163
jan@70
   164
    "Modified: / 21-07-2011 / 10:06:51 / Jan Vrany <jan.vrany@fit.cvut.cz>"
jan@70
   165
!
jan@70
   166
jan@70
   167
startupSelector
jan@70
   168
    "the message that is sent to the startupClass to start the show"
jan@70
   169
jan@70
   170
    ^ #'start'        
jan@70
   171
! !
jan@70
   172
jan@70
   173
!stx_goodies_builder_reports class methodsFor:'description - svn'!
jan@70
   174
jan@70
   175
svnRepositoryUrlString
jan@70
   176
    "Return a SVN repository URL of myself.
jan@70
   177
     (Generated since 2011-04-08)
jan@70
   178
    "        
jan@70
   179
jan@70
   180
    ^ '$URL$'
jan@70
   181
!
jan@70
   182
jan@70
   183
svnRevisionNr
jan@70
   184
    "Return a SVN revision number of myself.
jan@70
   185
     This number is updated after a commit"
jan@70
   186
jan@140
   187
    ^ "$SVN-Revision:"'exported'"$"
jan@70
   188
! !
jan@70
   189
jan@70
   190
!stx_goodies_builder_reports class methodsFor:'documentation'!
jan@70
   191
jan@70
   192
version
jan@70
   193
    ^ '$Header$'
jan@70
   194
!
jan@70
   195
jan@70
   196
version_CVS
jan@70
   197
    ^ '$Header$'
jan@70
   198
!
jan@70
   199
jan@70
   200
version_SVN
jan@157
   201
    ^ '$Id$'
jan@70
   202
! !
sv@129
   203