Property Detail

• static org.slf4j.Logger logger_

Constructor Detail

• ImageCollectionDiffer(MaterialRepository mr)

  constructor

  Parameters:

  mr

  Authors:

  kazurayam

Method Detail

• static MaterialPair decorateMaterialPair(MaterialPair source, TSuiteResult expectedTSR, TSuiteResult actualTSR)

  Check the source MaterialPair has an orphan, which means if it lacks the Expected Material or it lacks the Actual Material. Fill the vacancy with a Material object which returns fileExists()==false

  Parameters:

  source

  Returns:

• @java.lang.Override void endImageCollection(TCaseName tCaseName)

  serialize the list of EvaluationResult objects into file.

• @java.lang.Override void endMaterialPair(ComparisonResult cr)

• static java.lang.Object fakeMaterial(TSuiteResult targetTSuiteResult, Material existingMaterial)

  Parameters:

  targetTSuiteResult - e.g, './Materials/main.TS1/20180530_130419/'

  existingMaterial - e.g, './Materials/main.TS1/20180530_150000/main.TC1/foo/bar/fixture.xls'

  Returns:

  fakeMaterial with path './Materials/main.TS1/20180530_130419/main.TC1/foo/bar/fixture.xls'

• MaterialDescription findMaterialDescription(TSuiteResult tSuiteResult, Material material)

  MaterialMetadataBundle file may look like as this:

   {
       "MaterialMetadataBundle": [
           ...
           {
               "MaterialMetadata": {
                   "MaterialPath": "CURA.chronos_capture/CURA_DevelopmentEnv/20200729_130109/CURA.visitSite/screenshots/profile.php%23login.png",
                   "TCaseName": "Test Cases/CURA/visitSite",
                   "MaterialDescription": {
                       "category": "1",
                       "description": "Login page"
                   },
                   "InvokedMethodName": "resolveScreenshotPathByUrlPathComponents",
                   "SubPath": "screenshots",
                   "URL": "https://katalon-demo-cura.herokullogin"
               }
           },
   

  Material may look like this:

   {
                           "url": "null",
                           "suffix": "",
                           "fileType": {
                               "FileType": {
                                   "extension": "png",
                                   "mimeTypes": [
                                       "image/png"
                                   ]
  }
                           },
                           "path": "/Users/kazuakiurayama/katalon-workspace/VisualTestingInKatalonStudio/Materials/CURA.chronos_capture/CURA_DevelopmentEnv/20200729_130109/CURA.visitSite/screenshots/profile.php%23login.png",
                           "hrefRelativeToRepositoryRoot": "CURA.chronos_capture/CURA_DevelopmentEnv/20200729_130109/CURA.visitSite/screenshots/profile.php%23login.png",
                           "lastModified": "2020-07-29T04:02:06",
                           "de_130109"
                       }
   

  Given above two arguments, find a MaterialDescription of the Material and return:

   {
        "category": "1",
        "description": "Login page"
   }
   

• java.nio.file.Path getOutput()

  Returns:

  the Path of comparison-result-bundle.json file created by endImageCollection() method call.

• @java.lang.Override boolean makeImageCollectionDifferences(MaterialPairs materialPairs, TCaseName callerTCaseName, ImageDeltaStats imageDeltaStats)

  Parameters:

  materialPairs

  tCaseName

  imageDeltaStats

• @java.lang.Override boolean makeImageCollectionDifferences(MaterialPairs materialPairs, TCaseName callerTCaseName, double criteriaPercentage)

  compare 2 Material files in each MaterialPair object, create ImageDiff and store the diff image files under the directory ./Materials//yyyyMMdd_hhmmss/. The difference ratio is compared with the criteriaPercent given. Will be marked FAILED if any of the pairs has greater difference.

  Parameters:

  materialPairs - created by com.kazurayam.materials.MaterialRpository#createMaterialPairs() method

  tCaseName - the name of test case which called the ImageCollectionDiffer#makeImageCollectionDifferences()

  criteriaPercent - e.g. 3.00 percent. If the difference of a MaterialPair is greater than this, the MaterialPair is evaluated FAILED

• static java.awt.image.BufferedImage makeMarkerImage(java.nio.file.Path pathNotFound)

  make a Marker image which shows """File not found: C: └─Users └─qcq0264 └─eclipse-workspace ... """

  Parameters:

  pathNotFound

  Returns:

• void setImageDifferenceFilenameResolver(ImageDifferenceFilenameResolver filenameResolver)

• @java.lang.Override void setVisualTestingLogger(VisualTestingLogger logger)

  set instance of VisualTestingListener, which will consume messages from ImageCollectionDiffer

  Parameters:

  listener

• @java.lang.Override void startImageCollection(TCaseName tCaseName)

  prepare File of 'comparison-result.json'

• @java.lang.Override ComparisonResult startMaterialPair(TCaseName tCaseName, MaterialPair materialPair, double criteriaPercentage, MaterialDescription materialDescription)

  This method is the core part of ImageCollectionDiffer.