rust-raspberrypi-OS-tutorials/common/tests/test.rb

# frozen_string_literal: true

# SPDX-License-Identifier: MIT OR Apache-2.0
#
# Copyright (c) 2019-2022 Andre Richter <andre.o.richter@gmail.com>

# Test base class.
class Test
    INDENT = '         '

    # rubocop:disable Style/RedundantInitialize
    def initialize
        # Template instance variables.
        # @test_name
        # @test_description
        # @test_output
        # @test_error
    end
    # rubocop:enable Style/RedundantInitialize

    private

    def print_border(content)
        puts "#{INDENT}-------------------------------------------------------------------"
        puts content
        puts "#{INDENT}-------------------------------------------------------------------"
    end

    def print_header
        print_border("#{INDENT}🦀 #{@test_description}")
        puts
    end

    def print_footer_error(error)
        puts
        print_border("#{INDENT}❌ Failure: #{@test_name}: #{error}")
        puts
        puts
    end

    def print_footer_success
        puts
        print_border("#{INDENT}✅ Success: #{@test_name}")
        puts
        puts
    end

    # Expects @test_output the be an array of lines, without '\n'
    def print_output
        @test_output.each { |x| print "#{INDENT}#{x}\n" }
    end

    # Template method.
    def setup; end

    # Template method.
    def finish; end

    # Template method.
    def run_concrete_test
        raise('Not implemented')
    end

    public

    def run
        setup
        run_concrete_test
        finish

        print_header
        print_output

        exit_code = if @test_error
                        print_footer_error(@test_error)
                        false
                    else
                        print_footer_success
                        true
                    end

        exit(exit_code)
    end
end