tests/analysis_test.py

   1 # The MIT License (MIT)
   2 #
   3 # Copyright (C) 2016 - Julien Desfossez <jdesfossez@efficios.com>
   4 #                      Antoine Busque <abusque@efficios.com>
   5 #
   6 # Permission is hereby granted, free of charge, to any person obtaining a copy
   7 # of this software and associated documentation files (the "Software"), to deal
   8 # in the Software without restriction, including without limitation the rights
   9 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10 # copies of the Software, and to permit persons to whom the Software is
  11 # furnished to do so, subject to the following conditions:
  12 #
  13 # The above copyright notice and this permission notice shall be included in
  14 # all copies or substantial portions of the Software.
  15 #
  16 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  22 # SOFTWARE.
  23
  24 import os
  25 import subprocess
  26 import unittest
  27 from .trace_writer import TraceWriter
  28
  29
  30 class AnalysisTest(unittest.TestCase):
  31     COMMON_OPTIONS = '--no-progress --skip-validation --gmt'
  32
  33     def __init__(self, *args, **kwargs):
  34         super().__init__(*args, **kwargs)
  35         self.rm_trace = True
  36
  37     def set_up_class(self):
  38         dirname = os.path.dirname(os.path.realpath(__file__))
  39         self.data_path = dirname + '/expected/'
  40         self.maxDiff = None
  41         self.trace_writer = TraceWriter()
  42         self.write_trace()
  43
  44     def tear_down_class(self):
  45         if self.rm_trace:
  46             self.trace_writer.rm_trace()
  47
  48     def write_trace(self):
  49         raise NotImplementedError
  50
  51     def run(self, result=None):
  52         self.set_up_class()
  53         super().run(result)
  54         self.tear_down_class()
  55
  56         return result
  57
  58     def get_expected_output(self, filename):
  59         with open(self.data_path + filename, 'r') as expected_file:
  60             return expected_file.read()
  61
  62     def get_cmd_output(self, exec_name, options=''):
  63         cmd_fmt = './{} {} {} {}'
  64         cmd = cmd_fmt.format(exec_name, self.COMMON_OPTIONS,
  65                              options, self.trace_writer.trace_root)
  66
  67         return subprocess.getoutput(cmd)
  68
  69     def get_output(self, name, output):
  70         out = open(os.path.join(self.trace_writer.trace_root, name), "w")
  71         out.write(output)
  72         out.close()
  73         self.rm_trace = False
  74
  75     def diff(self, name, result, expected):
  76         try:
  77             self.assertMultiLineEqual(result, expected)
  78         except AssertionError:
  79             self.get_output(name, result)
  80             raise