com.netflix.atlas.test.GraphAssertions.scala Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2015 Netflix, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.netflix.atlas.test

import java.awt.image.RenderedImage
import java.io.File
import java.io.FileInputStream
import java.io.FileOutputStream
import java.io.InputStream

import com.netflix.atlas.core.util.PngImage
import com.netflix.atlas.core.util.Streams
import org.scalatest.Assertions


/**
 * Helper assertions for working with graphs.
 */
class GraphAssertions(goldenDir: String, targetDir: String) extends Assertions {

  private def getInputStream(file: String): InputStream = {
    new FileInputStream(new File(s"$goldenDir/$file"))
  }

  private def getImage(file: String): PngImage = {
    PngImage(getInputStream(file))
  }

  private def getString(file: String): String = {
    Streams.scope(getInputStream(file)) { in =>
      new String(Streams.byteArray(in), "UTF-8")
    }
  }

  def generateReport(clazz: Class[_]) {
    val report = 
      {clazz.getSimpleName}
      {clazz.getSimpleName}
 {
        val dir = new File(goldenDir)
        dir.listFiles.flatMap { f =>
          if (!f.getName.endsWith(".png")) None else {
            val table = 
              {f.getName}
              
                Golden Test Diff
                
                  
                  
                  
                
              
            
            Some(table)
          }
        }
      } 
    

    Streams.scope(Streams.fileOut(new File(s"$targetDir/report.html"))) { out =>
      out.write(report.toString.getBytes("UTF-8"))
    }
  }

  def assertEquals(v1: Double, v2: Double, delta: Double) {
    val diff = scala.math.abs(v1 - v2)
    if (diff > delta) {
      throw new AssertionError("%f != %f".format(v1, v2))
    }
  }

  def assertEquals(v1: Double, v2: Double, delta: Double, msg: String) {
    val diff = scala.math.abs(v1 - v2)
    if (diff > delta) {
      throw new AssertionError("%f != %f, %s".format(v1, v2, msg))
    }
  }

  def assertEquals(i1: RenderedImage, i2: RenderedImage) {
    val diff = PngImage.diff(i1, i2)
    assert(diff.metadata("identical") === "true")
  }

  def assertEquals(i1: PngImage, i2: PngImage) {
    assertEquals(i1.data, i2.data)
    assert(i1.metadata === i2.metadata)
  }

  def assertEquals(i1: PngImage, f: String, bless: Boolean = false) {
    val file = new File(new File(goldenDir), f)
    if (bless) blessImage(i1, f)
    val i2 = getImage(f)
    val diff = PngImage.diff(i1.data, i2.data)
    writeImage(i1, targetDir, f)
    writeImage(diff, targetDir, "diff_" + f)
    assertEquals(i1, i2)
  }

  private def blessImage(img: PngImage, f: String) {
    writeImage(img, goldenDir, f)
  }

  private def writeImage(img: PngImage, dir: String, f: String) {
    val file = new File(new File(dir), f)
    file.getParentFile.mkdirs()
    val stream = new FileOutputStream(file)
    img.write(stream)
  }

  def assertEquals(s1: String, f: String, bless: Boolean) {
    if (bless) blessString(s1, f)
    val s2 = getString(f)
    assert(s1 === s2)
  }

  private def blessString(s: String, f: String) {
    writeString(s, goldenDir, f)
  }

  private def writeString(s: String, dir: String, f: String) {
    val file = new File(new File(dir), f)
    file.getParentFile.mkdirs()
    val stream = new FileOutputStream(file)
    try stream.write(s.getBytes("UTF-8")) finally stream.close()
  }
}