livecode/tests/_testlib.livecodescript at develop-8.2 · livecode/livecode

This repository was archived by the owner on Aug 31, 2021. It is now read-only.
484 lines (393 loc) · 14 KB
﻿script "TestLibrary"
Copyright (C) 2015 LiveCode Ltd.
This file is part of LiveCode.
LiveCode is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License v3 as published by the Free
Software Foundation.
LiveCode is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with LiveCode.  If not see <http://www.gnu.org/licenses/>.  */
on revLoadLibrary
	insert the script of me into back
	set the lockErrorDialogs to true
end revLoadLibrary
----------------------------------------------------------------
-- Helper functions
----------------------------------------------------------------
local sOutputToVariable
local sOutput
private function _TestValidateCount pCount
   if pCount is not an integer or pCount <= 0 then
      throw "Bad test count '" & pCount & "': must be positive integer"
   return pCount
end _TestValidateCount
private function _TestValidateDescription pDescription
   if the number of lines in pDescription > 1 then
      throw "Bad test description '" & line 1 of pDescription & "...': multiple lines"
   if "0123456789" contains codepoint 1 of pDescription then
      throw "Bad test description '" & pDescription & "': starts with digit"
   if pDescription contains "#" then
      throw "Bad test description '" & pDescription & "': contains '#'"
   return line 1 of pDescription
end _TestValidateDescription
private function _TestValidateReason pReason
   if the number of lines in pReason > 1 then
      throw "Bad test directive reason '" & line 1 of pReason & "...': multiple lines"
   if pReason contains "#" then
      throw "Bad test directive reason '" & pReason & "': contains '#'"
   return line 1 of pReason
end _TestValidateReason
private function _TestValidateDirective pDirective
   switch pDirective
      case empty
         return empty
      case "TODO"
         return "TODO"
      case "SKIP"
         return "SKIP"
      default
         throw "Bad test directive '" & line 1 of pDirective & "'"
   end switch
end _TestValidateDirective
-- Used by top level assertion functions to generate output
private command _TestOutput pIsOkay, pDescription, pDirective, pReason
   local tDescription, tDirective, tReason
   put _TestValidateDescription(pDescription) into tDescription
   put _TestValidateDirective(pDirective) into tDirective
   put _TestValidateReason(pReason) into tReason
   local tMessage
   if pIsOkay then
      put "ok" into tMessage
      put "not ok" into tMessage
   if tDescription is not empty then
      put " - " & tDEscription after tMessage
   if tDirective is not empty then
      put " # " & tDirective after tMessage
      if tReason is not empty then
         put " " & tReason after tMessage
      end if
   _TestWriteOutput tMessage & return
end _TestOutput
private command _TestWriteOutput pMessage
   -- As stdout is considered to be a 'native' stream, we encode to UTF-8 first
   -- then will unencode in the test runner.
   if sOutputToVariable then
      put pMessage after sOutput
      write textEncode(pMessage, "UTF8") to stdout
end _TestWriteOutput
private function _TestGetBuildFolder
   local tPath, tRepoPath
   put specialfolderpath("engine") into tPath
   put TestGetEngineRepositoryPath() into tRepoPath
   # Find the built extensions folder
   set the itemdelimiter to slash
   repeat while tPath is not tRepoPath and tPath is not empty
      if there is a folder (tPath & slash & "packaged_extensions") then
         return tPath
      end if
      delete item -1 of tPath
   end repeat	
end _TestGetBuildFolder
private function _TestGetBuiltExtensionsFolder
   return _TestGetBuildFolder() & slash & "packaged_extensions"
end _TestGetBuiltExtensionsFolder
private command _TestLoadExtension pFolder, pPath
   if there is a folder (pFolder & slash & "resources") then
      do "load extension from file pPath with resource path (pFolder & slash & " & quote & "resources" & quote & ")"
      do "load extension from file pPath"
   return the result
end _TestLoadExtension
private function __TestBuildErrorMap pErrorFile, pErrorPrefix, pZerothError
   local tSourceFile
   put TestGetEngineRepositoryPath() & slash & "engine/src/" & \
         pErrorFile into tSourceFile
   local tSource
   put textDecode(url("binfile:" & tSourceFile), "utf-8") into tSource
   local tErrorMap, tCurrentCode, tCodeFound
   put false into tCodeFound
   repeat for each line tLine in tSource
      if tLine is empty then next repeat
      if word 1 of tLine begins with pErrorPrefix & "_" & pZerothError then 
      	  next repeat
      end if
      local tCode
      if matchText(tLine, ".*\/\/ \{" & pErrorPrefix & "-([0-9]{4})\}.*", tCode) then
         put tCode into tCurrentCode
         put true into tCodeFound
         next repeat
      end if
      if word 1 of tLine begins with pErrorPrefix & "_" then
         if tCodeFound is false then
            if tCurrentCode is empty then 
               throw "no error code found:" && tLine
            else
               throw "duplicate error code" && tCurrentCode && "found:" && tLine
            end if
         end if
         put item 1 of (word 1 of tLine) into tErrorMap[tCurrentCode]
         put false into tCodeFound
      end if
   end repeat
   return tErrorMap
end __TestBuildErrorMap
local sExecErrorMap
private command __TestEnsureExecErrorMap
   if sExecErrorMap is not empty then
      exit __TestEnsureExecErrorMap
   put __TestBuildErrorMap("executionerrors.h", "EE", "UNDEFINED") \
   	   into sExecErrorMap
end __TestEnsureExecErrorMap
private function __TestErrorMatches pError, pCode
	__TestEnsureExecErrorMap
	local tErrorNumber
	put format("%04d", item 1 of line 1 of pError) into tErrorNumber
	return sExecErrorMap[tErrorNumber] is pCode
end __TestErrorMatches
----------------------------------------------------------------
-- Unit test library functions
----------------------------------------------------------------
on TestOutputToVariable
   put true into sOutputToVariable
end TestOutputToVariable
function TestFetchAndClearOutput
   if not sOutputToVariable then
      return empty
   local tOutput
   put sOutput into tOutput
   put empty into sOutput
   return tOutput
end TestFetchAndClearOutput
on TestPlan pCount
   _TestWriteOutput "1.." & _TestValidateCount(pCount) & return
end TestPlan
on TestDiagnostic pMessage
   local tLine
   repeat for each line tLine in pMessage
      _TestWriteOutput "#" && tLine & return
   end repeat
end TestDiagnostic
on TestSkip pDescription, pReasonSkipped
   _TestOutput true, pDescription, "SKIP", pReasonSkipped
end TestSkip
on TestAssert pDescription, pExpectTrue
   _TestOutput pExpectTrue, pDescription, empty, empty
end TestAssert
on TestAssertBroken pDescription, pExpectTrue, pReasonBroken
   _TestOutput pExpectTrue, pDescription, "TODO", pReasonBroken
end TestAssertBroken
on TestAssertThrow pDescription, pHandler, pTarget, pErrorCode, pParam
   local tError
      dispatch pHandler to pTarget with pParam
    catch tError
    end try
    TestAssert pDescription, __TestErrorMatches(tError, pErrorCode)
end TestAssertThrow
on TestAssertDoesNotThrow pDescription, pHandler, pTarget, pParam
  local tError
    dispatch pHandler to pTarget with pParam
  catch tError
  TestAssert pDescription, tError is empty 
end TestAssertDoesNotThrow
local sError
on ErrorDialog pError
	put pError into sError
end ErrorDialog
on TestAssertErrorDialog pDescription, pErrorCode
	wait for messages
	TestAssert pDescription, __TestErrorMatches(sError, pErrorCode)
	put empty into sError
end TestAssertErrorDialog
function TestGetUncaughtErrorDialog
	return sError
end TestGetUncaughtErrorDialog
function TestGetEngineRepositoryPath
  set the itemdelimiter to "/"
  return item 1 to -3 of the filename of me
end TestGetEngineRepositoryPath
function TestGetIDERepositoryPath
  set the itemdelimiter to "/"
  return item 1 to -3 of the filename of me & slash & "ide"
end TestGetIDERepositoryPath
function TestGetExtractedDocsFolder
   return _TestGetBuildFolder() & slash & "extracted_docs"
end TestGetExtractedDocsFolder
on TestLoadExtension pName	
   set the itemdelimiter to "."
   local tExtensionUnzipFolder
   put pName into tExtensionUnzipFolder
   local tError
   put "extension" && pName && "not found" into tError
   local tExtensionsFolder
   put _TestGetBuiltExtensionsFolder() into tExtensionsFolder
   local tExtensionFolder
   if tExtensionsFolder is not empty then
      if there is a folder (tExtensionsFolder & slash & tExtensionUnzipFolder) then
        put (tExtensionsFolder & slash & tExtensionUnzipFolder) into tExtensionFolder
      end if
   local tExtensionFile
   if tExtensionFolder is not empty then
      if there is a file (tExtensionFolder & slash & "module.lcm") then
         put (tExtensionFolder & slash & "module.lcm") into tExtensionFile
      end if
   if tExtensionFile is not empty then
      _TestLoadExtension tExtensionFolder, tExtensionFile
   put the result into tError
   if tError is not empty then
      write tError & return to stderr
      quit 1
end TestLoadExtension
on TestLoadExternal pExternal
   local tEnginePath
   put specialfolderpath("engine") into tEnginePath
   if the platform is "MacOS" then
      set the externals of the templateStack to tEnginePath & slash & pExternal & ".bundle"
   else if the platform is "linux" then
      set the externals of the templateStack to tEnginePath & slash & pExternal & ".so"
   create stack pExternal && "External"
   start using it
   if the externalCommands of it is empty then
      write "Cannot load external" && pExternal & return to stderr
end TestLoadExternal 
private function __GetCaller
   get item 1 to -3 of line -3 of the executionContexts
   if there is not an it then
      delete item -1 of it
   return it
end __GetCaller
private function __StackOfObject pLongID
   local tOffset
   put wordOffset("stack",pLongID) into tOffset
   return word tOffset to -1 of pLongID
end __StackOfObject
-- This loads an extension whose lcb source sits in the same folder as the
-- current test.
on TestLoadAuxillaryExtension pName
	local tBasePath, tExtraPath
	set the itemDelimiter to slash
	put item 1 to -2 of the effective filename of __StackOfObject(__GetCaller()) into tBasePath
	repeat while the last item of tBasePath is not "tests"
		put item -1 of tBasePath & slash before tExtraPath
		delete the last item of tBasePath
	end repeat
	local tModuleFile
	put tBasePath & "/../_tests/_build/" & tExtraPath & pName & ".lcm" into tModuleFile
	load extension from data url ("binfile:" & tModuleFile)
	if the result is not empty then
		throw "Failed to load auxillary extension:" && the result && tModuleFile
end TestLoadAuxillaryExtension
on TestLoadAllExtensions
   local tExtFolder
   put _TestGetBuiltExtensionsFolder() into tExtFolder
   local tExtensions
   put folders(tExtFolder) into tExtensions
   local tFiles, tExtensionsA
   local tHasCompiled, tSource
   # Collect all the valid (and compiled) extension files
   repeat for each line tFolder in tExtensions
      if tFolder begins with "." then
         next repeat
      end if
      put false into tHasCompiled
      put empty into tSource
      put tExtFolder & slash before tFolder
      put files(tFolder) into tFiles
      repeat for each line tFile in tFiles
         if tFile ends with ".lcb" then
            put tFile into tSource
         else if tFile is "module.lcm" then
            put true into tHasCompiled
         end if
         if tHasCompiled and tSource is not empty then
         	local tPath
         	put tFolder & slash & tSource into tPath
            put tFolder into tExtensionsA[tPath]
            exit repeat
         end if
      end repeat
   end repeat
   # Use the lc-compile --deps option to sort by dependency
   local tLCCompile, tLCBFiles
   put the keys of tExtensionsA into tLCBFiles
   replace return with " " in tLCBFiles
   set the itemdelimiter to slash
   put item 1 to -2 of tExtFolder & slash & "lc-compile" into tLCCompile
   put shell(tLCCompile && "--deps order --" && tLCBFiles) into tLCBFiles
   if the result is not 0 then
      write the result & return to stderr
      quit 1
   # Load the extensions in order
   repeat for each line tExtFile in tLCBFiles
      _TestLoadExtension tExtensionsA[tExtFile], tExtensionsA[tExtFile] & slash & "module.lcm"
   end repeat
end TestLoadAllExtensions
on TestRepeat pDesc, pHandler, pTarget, pTimeOut, pParamsArray
	# Construct a dispatch command with all the desired parameters
	local tDoString, tParams, tResult
	put "dispatch pHandler to pTarget" into tDoString
	repeat with tParam = 1 to the number of elements in pParamsArray
		if tParams is empty then
        	put " with pParamsArray[" & tParam & "]" into tParams
        else
        	put ", pParamsArray[" & tParam & "]" after tParams
        end if
    end repeat
    put tParams after tDoString
    put "; put the result into tResult" after tDoString
    put false into tResult
    local tTimer, tTimeout
    put false into tTimeout
    put the millisecs into tTimerStart
    repeat while tResult is false and not tTimeout
       wait 1 millisecs with messages
	   do tDoString
       if the millisecs - tTimerStart > pTimeOut then
          put true into tTimeOut
       end if
	end repeat
    TestAssert pDesc, tResult
    if (not tResult) and tTimeOut then
		TestDiagnostic pDesc & "- timed out"
end TestRepeat
on TestRunStack pOptions, pStackFilePath
	local tEnginePath
	set the itemDelimiter to ":"
	put item 2 of the address into tEnginePath
	local tCommand
	put format("\"%s\" %s \"%s\"", tEnginePath, pOptions, pStackFilePath) into tCommand
	local tOutput
	put shell(tCommand) into tOutput
	return the result
end TestRunStack
Navigation Menu

Uh oh!

Uh oh!

FilesExpand file tree

_testlib.livecodescript

Latest commit

History

_testlib.livecodescript

File metadata and controls
