tests/testthat/testPrintSummaryRcompareObject.R

In dataCompareR: Compare Two Data Frames and Summarise the Difference

# SPDX-Copyright: Copyright (c) Capital One Services, LLC 
# SPDX-License-Identifier: Apache-2.0 
# Copyright 2017 Capital One Services, LLC 
#
# 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.

#
# UNIT TEST: print.summary.dataCompareRobject
#
# * Assumes that the output of dataCompareR is accurate
#
# The print output of the summary object of the dataCompareR object 
# should have a certain structure depending on the content of the object.
#

library(testthat)

context('test printsummaryrcompobj')


test_that("test printsummaryrcompobj", {
  
  
  # Create a couple of R compare objects
  testSame <- rCompare(iris,iris)
  
  iris2 <- iris[1:140,]
  testDiff <- rCompare(iris,iris2)
  
  # Capture the outpts of createReportText as text
  textSame <- capture.output(print(summary(testSame)))
  textDiff <- capture.output(print(summary(testDiff)))
  
  # For now we won't hard code each - instead, we will just check a few points...
  
  # We should look for the names of the data
  expect_true(any(grepl("iris",textSame)))
  expect_true(any(grepl("iris",textDiff)))
  expect_false(any(grepl("iris2",textSame)))
  expect_true(any(grepl("iris2",textDiff)))
  
  # Check that the column equal report is working
  expect_true(any(grepl("Columns with all rows equal : PETAL.LENGTH, PETAL.WIDTH, SEPAL.LENGTH, SEPAL.WIDTH, SPECIES",textSame)))
  expect_true(any(grepl("Columns with all rows equal : PETAL.LENGTH, PETAL.WIDTH, SEPAL.LENGTH, SEPAL.WIDTH, SPECIES",textDiff)))
  
  # Expect the diff report to contain 140 (10 rows are missing) and 10
  expect_true(any(grepl("140",textDiff)))
  expect_true(any(grepl("10",textDiff)))
  
  # And both contain 150
  expect_true(any(grepl("150",textSame)))
  expect_true(any(grepl("150",textDiff)))
  
  # Both contain some data, say more than 40 lines
  expect_true(length(textSame) > 40)
  expect_true(length(textDiff) > 40)
  
  # Expect a bunch of words will always be there
  expect_true(any(grepl("columns",textDiff)))
  expect_true(any(grepl("columns",textSame)))
  
  expect_true(any(grepl("rows",textDiff)))
  expect_true(any(grepl("rows",textSame)))
  
  expect_true(any(grepl("Variable",textDiff)))
  expect_true(any(grepl("Variable",textSame)))
  
  expect_true(any(grepl("equal",textDiff)))
  expect_true(any(grepl("equal",textSame)))
  
  expect_true(any(grepl("unequal",textDiff)))
  expect_true(any(grepl("unequal",textSame)))
  
  # Expect they differ
  expect_false(all(textDiff==textSame))
  
})

test_that("rounding note appears", {
  
  
  # Create a couple of R compare objects
  
  # With rounding
  testRound <- rCompare(iris,iris, roundDigits = 0)
  
  # Capture the outputs of createReportText as text
  textRound <- capture.output(print(summary(testRound)))
  
  expect_true(any(grepl("Numeric values were rounded to 0 decimal.", textRound)))
  
  # without rounding
  testNoRound <- rCompare(iris,iris)
  # Capture the outpts of createReportText as text
  textNoRound <- capture.output(print(summary(testNoRound)))
  
  expect_false(any(grepl("Numeric values were rounded", textNoRound)))
  
  
  
  
})


test_that("complete mismatching data output is truncated", {
  
  
  # Create a couple of R compare objects
  
  # With rounding
  testVeryDifferent <- rCompare(iris,pressure)
  testSame <- rCompare(iris,iris)
  
  # Capture the outputs of createReportText as text
  textVeryDifferent <- capture.output(print(summary(testVeryDifferent)))
  textSame <- capture.output(print(summary(testSame)))
  
  expect_true(any(grepl("No columns match, so no comparison could take place", textVeryDifferent)))
  expect_false(any(grepl("No columns match, so no comparison could take place", textSame)))

  
})


test_that("row matching details appear only when matching on keys and row matching is incomplete", {
  
  
  # Create a couple of R compare objects
  
  # With rounding
  testExpectNoRowsSummary <- rCompare(iris,iris)
  testExpectNoRowsSummary2 <- rCompare(pressure,pressure,key='temperature')
  
  pressure2 <- pressure[1:10,]
  testExpectRowsSummary <- rCompare(pressure,pressure2,key='temperature')
  
  
  # Capture the outputs of createReportText as text
  texttestExpectNoRowsSummary <- capture.output(print(summary(testExpectNoRowsSummary)))
  testtestExpectNoRowsSummary2 <- capture.output(print(summary(testExpectNoRowsSummary2)))
  testtestExpectRowsSummary <- capture.output(print(summary(testExpectRowsSummary)))
  
  
  expect_false(any(grepl("The following rows were dropped from  pressure", texttestExpectNoRowsSummary)))
  expect_false(any(grepl("The following rows were dropped from  pressure", testtestExpectNoRowsSummary2)))
  expect_true(any(grepl("The following rows were dropped from  pressure", testtestExpectRowsSummary)))
  
  
  
  
})


test_that("the number of rows and columns returned are correct", {
  
  pressure2 <- pressure
  pressure2$ID2 <- 1
  pressure2$field2 <- 10
  pressure3 <- pressure2
  pressure3$pressure <- pressure3$pressure * 2
  pressure3$field2 <- 9
  
  withkeys <- capture.output(print(rCompare(pressure2, pressure2, keys = c('temperature'))) )
  withoutkeys <- capture.output(print(rCompare(pressure2, pressure2))) 
  
  expect_equal(withkeys[1], "All columns were compared, all rows were compared ")
  expect_equal(withkeys[2], "All compared variables match ")
  expect_equal(withkeys[3], " Number of rows compared: 19 ")
  expect_equal(withkeys[4], " Number of columns compared: 4")
  expect_equal(withoutkeys[1], "All columns were compared, all rows were compared ")
  expect_equal(withoutkeys[2], "All compared variables match ")
  expect_equal(withoutkeys[3], " Number of rows compared: 19 ")
  expect_equal(withoutkeys[4], " Number of columns compared: 4")
  
}) 


test_that("the output is correct when both dataframes have no rows", {
  
  # create an empty data frame
  df_empty <-  data.frame(ColA = character(),
                          ColB = as.Date(character()),
                          ColC = character(),
                          stringsAsFactors = FALSE)
  
  comp1 <- rCompare(df_empty, df_empty)
  comp2 <- rCompare(df_empty, df_empty,  keys = "ColA")
  comp3 <- rCompare(df_empty, df_empty, keys = c("ColA","ColB"))
  comp4 <- rCompare(df_empty, df_empty, keys = c("ColA","ColB","ColC"))
  
  
  text1 <- capture.output(print(summary(comp1)))
  text2 <- capture.output(print(summary(comp2)))
  text3 <- capture.output(print(summary(comp3)))
  text4 <- capture.output(print(summary(comp4)))

    
  expect_equal(text1[37], "Number of rows dropped from df_empty: 0  ")
  expect_equal(text1[38], "Number of rows dropped from  df_empty: 0  ")
  expect_equal(text1[44], "No rows were compared, so no summary can be provided")
  
  expect_equal(text2[37], "Number of rows dropped from df_empty: 0  ")
  expect_equal(text2[38], "Number of rows dropped from  df_empty: 0  ")
  expect_equal(text2[44], "No rows were compared, so no summary can be provided")
  
  expect_equal(text3[37], "Number of rows dropped from df_empty: 0  ")
  expect_equal(text3[38], "Number of rows dropped from  df_empty: 0  ")
  expect_equal(text3[44], "No rows were compared, so no summary can be provided")
  
  expect_equal(text4[37], "Number of rows dropped from df_empty: 0  ")
  expect_equal(text4[38], "Number of rows dropped from  df_empty: 0  ")
  expect_equal(text4[44], "No rows were compared, so no summary can be provided")
  
  
})


test_that("the output is correct when one dataframes has no columns", {
  
  
  df_empty <-  data.frame(ColA = character(),
                          ColB = as.Date(character()),
                          ColC = character(),
                          stringsAsFactors = FALSE)
  
  df_not_empty <- data.frame(ColA = c("A","B"),
                             ColB = c(Sys.Date(), Sys.Date()),
                             ColC = c(1,1),
                             stringsAsFactors = FALSE)
  
  
  comp1 <- rCompare(df_empty, df_not_empty)
  comp2 <- rCompare(df_empty, df_not_empty,  keys = "ColA")
  comp3 <- rCompare(df_empty, df_not_empty, keys = c("ColA","ColB"))
  comp4 <- rCompare(df_empty, df_not_empty, keys = c("ColA","ColB","ColC"))
  
  
  comp5 <- rCompare(df_not_empty, df_empty)
  comp6 <- rCompare(df_not_empty, df_empty,  keys = "ColA")
  comp7 <- rCompare(df_not_empty, df_empty, keys = c("ColA","ColB"))
  comp8 <- rCompare(df_not_empty, df_empty, keys = c("ColA","ColB","ColC"))
  
  
  
  text1 <- capture.output(print(summary(comp1)))
  text2 <- capture.output(print(summary(comp2)))
  text3 <- capture.output(print(summary(comp3)))
  text4 <- capture.output(print(summary(comp4)))
  
  text5 <- capture.output(print(summary(comp5)))
  text6 <- capture.output(print(summary(comp6)))
  text7 <- capture.output(print(summary(comp7)))
  text8 <- capture.output(print(summary(comp8)))
  
  
  expect_equal(text1[35], "Total number of rows read from df_not_empty: 2    ")
  expect_equal(text1[36], "Number of rows in common: 0  ")
  expect_equal(text1[37], "Number of rows dropped from df_empty: 0  ")
  expect_equal(text1[38], "Number of rows dropped from  df_not_empty: 2  ")
  expect_equal(text1[44], "No rows were compared, so no summary can be provided")
  
  expect_equal(text2[35], "Total number of rows read from df_not_empty: 2    ")
  expect_equal(text2[36], "Number of rows in common: 0  ")
  expect_equal(text2[37], "Number of rows dropped from df_empty: 0  ")
  expect_equal(text2[38], "Number of rows dropped from  df_not_empty: 2  ")
  expect_equal(text2[44], "No rows were compared, so no summary can be provided")
  
  expect_equal(text3[35], "Total number of rows read from df_not_empty: 2    ")
  expect_equal(text3[36], "Number of rows in common: 0  ")
  expect_equal(text3[37], "Number of rows dropped from df_empty: 0  ")
  expect_equal(text3[38], "Number of rows dropped from  df_not_empty: 2  ")
  expect_equal(text3[44], "No rows were compared, so no summary can be provided")
  
  expect_equal(text4[35], "Total number of rows read from df_not_empty: 2    ")
  expect_equal(text4[36], "Number of rows in common: 0  ")
  expect_equal(text4[37], "Number of rows dropped from df_empty: 0  ")
  expect_equal(text4[38], "Number of rows dropped from  df_not_empty: 2  ")
  expect_equal(text4[44], "No rows were compared, so no summary can be provided")
  
  
  expect_equal(text5[34], "Total number of rows read from df_not_empty: 2  ")
  expect_equal(text5[36], "Number of rows in common: 0  ")
  expect_equal(text5[38], "Number of rows dropped from  df_empty: 0  ")
  expect_equal(text5[37], "Number of rows dropped from df_not_empty: 2  ")
  expect_equal(text5[44], "No rows were compared, so no summary can be provided")
  
  expect_equal(text6[34], "Total number of rows read from df_not_empty: 2  ")
  expect_equal(text6[36], "Number of rows in common: 0  ")
  expect_equal(text6[38], "Number of rows dropped from  df_empty: 0  ")
  expect_equal(text6[37], "Number of rows dropped from df_not_empty: 2  ")
  expect_equal(text6[44], "No rows were compared, so no summary can be provided")
  
  expect_equal(text7[34], "Total number of rows read from df_not_empty: 2  ")
  expect_equal(text7[36], "Number of rows in common: 0  ")
  expect_equal(text7[38], "Number of rows dropped from  df_empty: 0  ")
  expect_equal(text7[37], "Number of rows dropped from df_not_empty: 2  ")
  expect_equal(text7[44], "No rows were compared, so no summary can be provided")
  
  expect_equal(text8[34], "Total number of rows read from df_not_empty: 2  ")
  expect_equal(text8[36], "Number of rows in common: 0  ")
  expect_equal(text8[38], "Number of rows dropped from  df_empty: 0  ")
  expect_equal(text8[37], "Number of rows dropped from df_not_empty: 2  ")
  expect_equal(text8[44], "No rows were compared, so no summary can be provided")
  
})