Skip to content

Commit

Permalink
Changed: AutoIt Code formatting to the common notation without additi…
Browse files Browse the repository at this point in the history 
…onal spaces after opened brackets and before closed brackets.
  • Loading branch information
sven.seyfert committed Oct 8, 2021
1 parent f38233c commit 97f15e9
Show file tree
Hide file tree
Showing 12 changed files with 360 additions and 332 deletions.
10 changes: 5 additions & 5 deletions .github/ISSUE_TEMPLATE/bug_report.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@ Please execute the following function and copy the console result here.

``` au3
Func _getSystemInfos()
ConsoleWrite( '@AutoItExe: ' & @AutoItExe & @CRLF )
ConsoleWrite( '@AutoItVersion: ' & @AutoItVersion & @CRLF )
ConsoleWrite( '@CPUArch: ' & @CPUArch & @CRLF )
ConsoleWrite( '@OSArch: ' & @OSArch & @CRLF )
ConsoleWrite( '@OSVersion: ' & @OSVersion & @CRLF )
ConsoleWrite('@AutoItExe: ' & @AutoItExe & @CRLF)
ConsoleWrite('@AutoItVersion: ' & @AutoItVersion & @CRLF)
ConsoleWrite('@CPUArch: ' & @CPUArch & @CRLF)
ConsoleWrite('@OSArch: ' & @OSArch & @CRLF)
ConsoleWrite('@OSVersion: ' & @OSVersion & @CRLF)
EndFunc
_getSystemInfos()
```
Expand Down
28 changes: 28 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Changelog

All notable changes to "Au3LogFramework" will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [1.0.0] - 2021-10-05

### Added

- All repository data and dependencies (already added before in version v0.54.0).

### Changed

- AutoIt Code formatting to the common notation without additional spaces after opened brackets and before closed brackets.

[1.0.0]: https://github.com/Sven-Seyfert/Au3LogFramework/releases/tag/v1.0.0

---

### Legend - Types of changes
- `Added` for new features.
- `Changed` for changes in existing functionality.
- `Deprecated` for soon-to-be removed features.
- `Removed` for now removed features.
- `Fixed` for any bug fixes.
- `Security` in case of vulnerabilities.
Binary file modified build/Au3LogFramework.exe
View file
Binary file not shown.
10 changes: 5 additions & 5 deletions docs/BUG_REPORT.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@ Please execute the following function and copy the console result here.

``` au3
Func _getSystemInfos()
ConsoleWrite( '@AutoItExe: ' & @AutoItExe & @CRLF )
ConsoleWrite( '@AutoItVersion: ' & @AutoItVersion & @CRLF )
ConsoleWrite( '@CPUArch: ' & @CPUArch & @CRLF )
ConsoleWrite( '@OSArch: ' & @OSArch & @CRLF )
ConsoleWrite( '@OSVersion: ' & @OSVersion & @CRLF )
ConsoleWrite('@AutoItExe: ' & @AutoItExe & @CRLF)
ConsoleWrite('@AutoItVersion: ' & @AutoItVersion & @CRLF)
ConsoleWrite('@CPUArch: ' & @CPUArch & @CRLF)
ConsoleWrite('@OSArch: ' & @OSArch & @CRLF)
ConsoleWrite('@OSVersion: ' & @OSVersion & @CRLF)
EndFunc
_getSystemInfos()
```
Expand Down
10 changes: 5 additions & 5 deletions docs/PULL_REQUEST_TEMPLATE.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,11 @@ Please execute the following function and copy the console result here. Just to

``` au3
Func _getSystemInfos()
ConsoleWrite( '@AutoItExe: ' & @AutoItExe & @CRLF )
ConsoleWrite( '@AutoItVersion: ' & @AutoItVersion & @CRLF )
ConsoleWrite( '@CPUArch: ' & @CPUArch & @CRLF )
ConsoleWrite( '@OSArch: ' & @OSArch & @CRLF )
ConsoleWrite( '@OSVersion: ' & @OSVersion & @CRLF )
ConsoleWrite('@AutoItExe: ' & @AutoItExe & @CRLF)
ConsoleWrite('@AutoItVersion: ' & @AutoItVersion & @CRLF)
ConsoleWrite('@CPUArch: ' & @CPUArch & @CRLF)
ConsoleWrite('@OSArch: ' & @OSArch & @CRLF)
ConsoleWrite('@OSVersion: ' & @OSVersion & @CRLF)
EndFunc
_getSystemInfos()
```
Expand Down
120 changes: 60 additions & 60 deletions examples/AutoIt/Example.au3
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@


; opt and just singleton -------------------------------------------------------
Opt( 'MustDeclareVars', 1 )
Global $aInst = ProcessList( 'Example.exe' )
Opt('MustDeclareVars', 1)
Global $aInst = ProcessList('Example.exe')
If $aInst[0][0] > 1 Then Exit


Expand All @@ -24,15 +24,15 @@ If $aInst[0][0] > 1 Then Exit
; declaration ------------------------------------------------------------------
Global $iFileOpenMode = $FO_OVERWRITE + $FO_CREATEPATH + $FO_UTF8_NOBOM

Global $sAu3LogFrameworkPath = _PathFull( '..\..\build' )
Global $sAu3LogFrameworkPath = _PathFull('..\..\build')
Global $sAu3LogFrameworkExe = 'Au3LogFramework.exe'
Global $sAu3LogFrameworkOutputPath = '..\..\output\'
Global $sAu3LogFrameworkReportPath = '..\..\reports\'

ConsoleWrite( $sAu3LogFrameworkPath & @CRLF )
ConsoleWrite( $sAu3LogFrameworkExe & @CRLF )
ConsoleWrite( $sAu3LogFrameworkOutputPath & @CRLF )
ConsoleWrite( $sAu3LogFrameworkReportPath & @CRLF )
ConsoleWrite($sAu3LogFrameworkPath & @CRLF)
ConsoleWrite($sAu3LogFrameworkExe & @CRLF)
ConsoleWrite($sAu3LogFrameworkOutputPath & @CRLF)
ConsoleWrite($sAu3LogFrameworkReportPath & @CRLF)

Global $sTestObjectName = 'Example'
Global $sScreenshotWindow = 'Firefox'
Expand All @@ -42,7 +42,7 @@ Global $sFileCurrentReport


; functions --------------------------------------------------------------------
Func _callAu3LogFramework( $iAu3LogFrameworkAction, $sTestObject = '', $sTestScenario = '', $sTestScenarioState = '', $sTestScenarioStepType = '', $sTestScenarioStepDescription = '', $sTestScenarioAdditionalInfo = '', $sSystemUnderTestTitle = '' )
Func _callAu3LogFramework($iAu3LogFrameworkAction, $sTestObject = '', $sTestScenario = '', $sTestScenarioState = '', $sTestScenarioStepType = '', $sTestScenarioStepDescription = '', $sTestScenarioAdditionalInfo = '', $sSystemUnderTestTitle = '')
Local $sArguments = _
'"' & $iAu3LogFrameworkAction & '" ' & _
'"' & $sTestObject & '" ' & _
Expand All @@ -53,68 +53,68 @@ Func _callAu3LogFramework( $iAu3LogFrameworkAction, $sTestObject = '', $sTestSce
'"' & $sTestScenarioAdditionalInfo & '" ' & _
'"' & $sSystemUnderTestTitle & '"'

ToolTip( $iIndex & ' of 26: ' & $sArguments, 10, 10 )
ToolTip($iIndex & ' of 26: ' & $sArguments, 10, 10)
$iIndex += 1

ShellExecuteWait( @ComSpec, ' /C cd "' & $sAu3LogFrameworkPath & '" && ' & $sAu3LogFrameworkExe & ' ' & $sArguments, '', '', @SW_HIDE )
ShellExecuteWait(@ComSpec, ' /C cd "' & $sAu3LogFrameworkPath & '" && ' & $sAu3LogFrameworkExe & ' ' & $sArguments, '', '', @SW_HIDE)

_randomSleep()
EndFunc

Func _getCurrentCreatedReport()
Local $aFileList = _FileListToArray( $sAu3LogFrameworkReportPath, '*.html', 1, True )
Local $aFileList = _FileListToArray($sAu3LogFrameworkReportPath, '*.html', 1, True)
Local $iFileCount = $aFileList[0]

Return $aFileList[$iFileCount]
EndFunc

Func _writeFile( $sFolderReport, $sText )
Local $hFile = FileOpen( $sFolderReport, $iFileOpenMode )
FileWrite( $hFile, $sText )
FileClose( $hFile )
Func _writeFile($sFolderReport, $sText)
Local $hFile = FileOpen($sFolderReport, $iFileOpenMode)
FileWrite($hFile, $sText)
FileClose($hFile)
EndFunc

Func _getJustFileName( $sFilePath )
Return StringRegExpReplace( $sFilePath, '(.+?)\\', '', 0 )
Func _getJustFileName($sFilePath)
Return StringRegExpReplace($sFilePath, '(.+?)\\', '', 0)
EndFunc

Func _createAdditionalInfosFile( $sFile, $sText )
Local $sFolderReport = StringReplace( _getJustFileName( $sFile ), '.html', '\' )
Func _createAdditionalInfosFile($sFile, $sText)
Local $sFolderReport = StringReplace(_getJustFileName($sFile), '.html', '\')
Local $sTimestamp = @YEAR & '-' & @MON & '-' & @MDAY & ' ' & @HOUR & '''' & @MIN & '''' & @SEC & '''' & @MSEC
Local $sFileAdditionalInfos = $sAu3LogFrameworkOutputPath & $sFolderReport & $sTimestamp & '.txt'

ConsoleWrite( $sFileAdditionalInfos & @CRLF )
ConsoleWrite($sFileAdditionalInfos & @CRLF)

_writeFile( $sFileAdditionalInfos, $sText )
_writeFile($sFileAdditionalInfos, $sText)

Return $sFileAdditionalInfos
EndFunc

Func _getHtmlATagWithAdditionalInfosFileLink( $sFile )
Local $sHtmlHref = StringReplace( $sFile, '\', '/' )
$sHtmlHref = StringReplace( $sHtmlHref, '../../', '../' )
Func _getHtmlATagWithAdditionalInfosFileLink($sFile)
Local $sHtmlHref = StringReplace($sFile, '\', '/')
$sHtmlHref = StringReplace($sHtmlHref, '../../', '../')
Local $sHtmlATag = '"<a href="' & $sHtmlHref & '" title="Additional infos" style="color: #DC3912;" target="_blank"><i class="fa fa-info-circle"></i></a>'

Return StringReplace( $sHtmlATag, '"', '""' )
Return StringReplace($sHtmlATag, '"', '""')
EndFunc

Func _getAdditionalInfoHtmlATag()
Local $sFileAdditionalInfos = _createAdditionalInfosFile( $sFileCurrentReport, 'FailureMessage:' & @CRLF & _randomWords() & @CRLF & @CRLF & 'StackTrace:' & @CRLF & _randomWords() )
Return _getHtmlATagWithAdditionalInfosFileLink( $sFileAdditionalInfos )
Local $sFileAdditionalInfos = _createAdditionalInfosFile($sFileCurrentReport, 'FailureMessage:' & @CRLF & _randomWords() & @CRLF & @CRLF & 'StackTrace:' & @CRLF & _randomWords())
Return _getHtmlATagWithAdditionalInfosFileLink($sFileAdditionalInfos)
EndFunc

Func _randomWords( $iWords = 30 )
Func _randomWords($iWords = 30)
Local $sText = ''

For $i = 1 To $iWords Step 1
Local $iLength = Random( 3, 18, 1 )
Local $iLength = Random(3, 18, 1)

Dim $aChr[3]
For $j = 1 To $iLength Step 1
$aChr[0] = Chr( Random( 65, 90, 1 ) ) ; A-Z
$aChr[1] = Chr( Random( 97, 122, 1 ) ) ; a-z
$aChr[2] = Chr( Random( 48, 57, 1 ) ) ; 0-9
$sText &= $aChr[Random( 0, 2, 1 )]
$aChr[0] = Chr(Random(65, 90, 1)) ; A-Z
$aChr[1] = Chr(Random(97, 122, 1)) ; a-z
$aChr[2] = Chr(Random(48, 57, 1)) ; 0-9
$sText &= $aChr[Random(0, 2, 1)]
Next

$sText &= ' '
Expand All @@ -124,45 +124,45 @@ Func _randomWords( $iWords = 30 )
EndFunc

Func _randomSleep()
Sleep( Random( 500, 1250, 1 ) )
Sleep(Random(500, 1250, 1))
EndFunc



; processing -------------------------------------------------------------------
_callAu3LogFramework( 'start', $sTestObjectName )
_callAu3LogFramework('start', $sTestObjectName)

Global $sFileCurrentReport = _getCurrentCreatedReport()

_callAu3LogFramework( 'test', $sTestObjectName, 'First test name', 'Ok', 'Given', 'Test with status Ok' )
_callAu3LogFramework( 'test', $sTestObjectName, 'First test name', 'Screenshot', 'When', 'Test with status Screenshot', '', $sScreenshotWindow )
_callAu3LogFramework( 'test', $sTestObjectName, 'First test name', 'Ok', 'Then', 'Test with status Ok' )
_callAu3LogFramework('test', $sTestObjectName, 'First test name', 'Ok', 'Given', 'Test with status Ok')
_callAu3LogFramework('test', $sTestObjectName, 'First test name', 'Screenshot', 'When', 'Test with status Screenshot', '', $sScreenshotWindow)
_callAu3LogFramework('test', $sTestObjectName, 'First test name', 'Ok', 'Then', 'Test with status Ok')

_callAu3LogFramework( 'test', $sTestObjectName, 'Second test name', 'Ok', 'Given', 'Test with status Ok' )
_callAu3LogFramework( 'test', $sTestObjectName, 'Second test name', 'Ok', 'When', 'Test with status Ok' )
_callAu3LogFramework( 'test', $sTestObjectName, 'Second test name', 'Ok', 'When', 'Test with status Ok' )
_callAu3LogFramework( 'test', $sTestObjectName, 'Second test name', 'Screenshot', 'When', 'Test with status Screenshot', '', $sScreenshotWindow )
_callAu3LogFramework( 'test', $sTestObjectName, 'Second test name', 'Warn', 'Then', 'Test with status Warn', _getAdditionalInfoHtmlATag(), $sScreenshotWindow )
_callAu3LogFramework('test', $sTestObjectName, 'Second test name', 'Ok', 'Given', 'Test with status Ok')
_callAu3LogFramework('test', $sTestObjectName, 'Second test name', 'Ok', 'When', 'Test with status Ok')
_callAu3LogFramework('test', $sTestObjectName, 'Second test name', 'Ok', 'When', 'Test with status Ok')
_callAu3LogFramework('test', $sTestObjectName, 'Second test name', 'Screenshot', 'When', 'Test with status Screenshot', '', $sScreenshotWindow)
_callAu3LogFramework('test', $sTestObjectName, 'Second test name', 'Warn', 'Then', 'Test with status Warn', _getAdditionalInfoHtmlATag(), $sScreenshotWindow)

_callAu3LogFramework( 'test', $sTestObjectName, 'Third test name', 'Ok', 'Given', 'Test with status Ok' )
_callAu3LogFramework( 'test', $sTestObjectName, 'Third test name', 'Ok', 'When', 'Test with status Ok' )
_callAu3LogFramework( 'test', $sTestObjectName, 'Third test name', 'Warn', 'Then', 'Test with status Warn', _getAdditionalInfoHtmlATag(), $sScreenshotWindow )
_callAu3LogFramework( 'test', $sTestObjectName, 'Third test name', 'Screenshot', 'When', 'Test with status Screenshot', '', $sScreenshotWindow )
_callAu3LogFramework( 'test', $sTestObjectName, 'Third test name', 'Error', 'Then', 'Test with status Error', _getAdditionalInfoHtmlATag(), $sScreenshotWindow )
_callAu3LogFramework('test', $sTestObjectName, 'Third test name', 'Ok', 'Given', 'Test with status Ok')
_callAu3LogFramework('test', $sTestObjectName, 'Third test name', 'Ok', 'When', 'Test with status Ok')
_callAu3LogFramework('test', $sTestObjectName, 'Third test name', 'Warn', 'Then', 'Test with status Warn', _getAdditionalInfoHtmlATag(), $sScreenshotWindow)
_callAu3LogFramework('test', $sTestObjectName, 'Third test name', 'Screenshot', 'When', 'Test with status Screenshot', '', $sScreenshotWindow)
_callAu3LogFramework('test', $sTestObjectName, 'Third test name', 'Error', 'Then', 'Test with status Error', _getAdditionalInfoHtmlATag(), $sScreenshotWindow)

_callAu3LogFramework( 'test', $sTestObjectName, 'Fourth test name', 'Warn', 'Given', 'Test with status Warn', '', $sScreenshotWindow )
_callAu3LogFramework( 'test', $sTestObjectName, 'Fourth test name', 'Ok', 'When', 'Test with status Ok' )
_callAu3LogFramework( 'test', $sTestObjectName, 'Fourth test name', 'Ok', 'Then', 'Test with status Ok' )
_callAu3LogFramework('test', $sTestObjectName, 'Fourth test name', 'Warn', 'Given', 'Test with status Warn', '', $sScreenshotWindow)
_callAu3LogFramework('test', $sTestObjectName, 'Fourth test name', 'Ok', 'When', 'Test with status Ok')
_callAu3LogFramework('test', $sTestObjectName, 'Fourth test name', 'Ok', 'Then', 'Test with status Ok')

_callAu3LogFramework( 'test', $sTestObjectName, 'Sixth test name', 'Warn', 'Given', 'Test with status Warn', _getAdditionalInfoHtmlATag(), $sScreenshotWindow )
_callAu3LogFramework( 'test', $sTestObjectName, 'Sixth test name', 'Error', 'Then', 'Test with status Error', _getAdditionalInfoHtmlATag(), $sScreenshotWindow )
_callAu3LogFramework('test', $sTestObjectName, 'Sixth test name', 'Warn', 'Given', 'Test with status Warn', _getAdditionalInfoHtmlATag(), $sScreenshotWindow)
_callAu3LogFramework('test', $sTestObjectName, 'Sixth test name', 'Error', 'Then', 'Test with status Error', _getAdditionalInfoHtmlATag(), $sScreenshotWindow)

_callAu3LogFramework( 'test', $sTestObjectName, 'Seventh test name', 'Ok', 'Given', 'Test with status Ok' )
_callAu3LogFramework( 'test', $sTestObjectName, 'Seventh test name', 'Ok', 'When', 'Test with status Ok' )
_callAu3LogFramework( 'test', $sTestObjectName, 'Seventh test name', 'Ok', 'Then', 'Test with status Ok' )
_callAu3LogFramework('test', $sTestObjectName, 'Seventh test name', 'Ok', 'Given', 'Test with status Ok')
_callAu3LogFramework('test', $sTestObjectName, 'Seventh test name', 'Ok', 'When', 'Test with status Ok')
_callAu3LogFramework('test', $sTestObjectName, 'Seventh test name', 'Ok', 'Then', 'Test with status Ok')

_callAu3LogFramework( 'test', $sTestObjectName, 'Eighth test name', 'Ok', 'Given', 'Test with status Ok' )
_callAu3LogFramework( 'test', $sTestObjectName, 'Eighth test name', 'Ok', 'When', 'Test with status Ok' )
_callAu3LogFramework( 'test', $sTestObjectName, 'Eighth test name', 'Ok', 'Then', 'Test with status Ok' )
_callAu3LogFramework('test', $sTestObjectName, 'Eighth test name', 'Ok', 'Given', 'Test with status Ok')
_callAu3LogFramework('test', $sTestObjectName, 'Eighth test name', 'Ok', 'When', 'Test with status Ok')
_callAu3LogFramework('test', $sTestObjectName, 'Eighth test name', 'Ok', 'Then', 'Test with status Ok')

_callAu3LogFramework( 'stop' )
_callAu3LogFramework('stop')
32 changes: 16 additions & 16 deletions src/Au3LogFramework.au3
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
#AutoIt3Wrapper_AU3Check_Stop_OnWarning=y
#AutoIt3Wrapper_Icon=..\media\favicon.ico
#AutoIt3Wrapper_Outfile_x64=..\build\Au3LogFramework.exe
#AutoIt3Wrapper_Res_Description=Au3LogFramework (2021-10-01)
#AutoIt3Wrapper_Res_Fileversion=0.54
#AutoIt3Wrapper_Res_Description=Au3LogFramework (2021-10-08)
#AutoIt3Wrapper_Res_Fileversion=1.0.0
#AutoIt3Wrapper_UseUpx=n
#AutoIt3Wrapper_UseX64=y

Expand All @@ -19,8 +19,8 @@


; opt and just singleton -------------------------------------------------------
Opt( 'MustDeclareVars', 1 )
Global $aInst = ProcessList( 'Au3LogFramework.exe' )
Opt('MustDeclareVars', 1)
Global $aInst = ProcessList('Au3LogFramework.exe')
If $aInst[0][0] > 1 Then Exit


Expand All @@ -38,37 +38,37 @@ If $aInst[0][0] > 1 Then Exit
; processing -------------------------------------------------------------------
Switch $aCmdArg[$eAu3LogFrameworkAction]
Case 'start'
If StringLower( $bShouldDisplayResolutionBeAdjusted ) == 'true' Then
If StringLower($bShouldDisplayResolutionBeAdjusted) == 'true' Then
_setDisplayResolution()
Sleep( 1500 )
Sleep(1500)
EndIf

_createReportStructure()

Case 'test'
Switch $aCmdArg[$eTestScenarioState]
Case 'ok', 'screenshot'
_createTestScenarioOrScenarioStep( $aColor[$eOk], $aCmdArg[$eTestScenarioState] )
_createTestScenarioOrScenarioStep($aColor[$eOk], $aCmdArg[$eTestScenarioState])

Case 'warn'
_createTestScenarioOrScenarioStep( $aColor[$eWarn], $aCmdArg[$eTestScenarioState] )
_createTestScenarioOrScenarioStep($aColor[$eWarn], $aCmdArg[$eTestScenarioState])

Case 'error'
_createTestScenarioOrScenarioStep( $aColor[$eError], $aCmdArg[$eTestScenarioState] )
_createTestScenarioOrScenarioStep($aColor[$eError], $aCmdArg[$eTestScenarioState])
EndSwitch

Case 'stop'
$aIni[$eReportFile] = _readIniValue( 'ReportFile' )
_setTestScenarioExecutionTime( $aIni[$eReportFile] )
$aIni[$eReportFile] = _readIniValue('ReportFile')
_setTestScenarioExecutionTime($aIni[$eReportFile])

If StringLower( $bSilentModeWithoutMsgBoxes ) == 'false' Then
If MsgBox( $iMsgBoxQuestionIcon, 'Question', 'Processing done.' & @CRLF & 'Open log report in default browser?', 30 ) == 6 Then
ShellExecute( $aIni[$eReportFile] )
If StringLower($bSilentModeWithoutMsgBoxes) == 'false' Then
If MsgBox($iMsgBoxQuestionIcon, 'Question', 'Processing done.' & @CRLF & 'Open log report in default browser?', 30) == 6 Then
ShellExecute($aIni[$eReportFile])
EndIf
EndIf

_setMaxDirectories( $aPath[$eOutput], $iAmountOfLastReportsToStore )
_setMaxFiles( $aPath[$eReports], $iAmountOfLastReportsToStore)
_setMaxDirectories($aPath[$eOutput], $iAmountOfLastReportsToStore)
_setMaxFiles($aPath[$eReports], $iAmountOfLastReportsToStore)

Exit
EndSwitch
Loading

0 comments on commit 97f15e9

Please sign in to comment.