1

#! gmake

     2

     3

# beremiz/tests/Makefile :

     4

#

     5

#   Makefile to prepare and run Beremiz tests.

     6

#

     7

#   For developper to:

     8

#       - quickly run a test (TDD) on current code 

     9

#       - write new tests, debug existing tests 

    10

#

    11

#     Use cases :

    12

#

    13

#       run given tests

    14

#           $ make run_python_exemple.sikuli

    15

#

    16

#       run tests from particular test classes

    17

#           $ make ide_tests

    18

#

    19

#       run one particular test in a Xnest window

    20

#           $ make xnest_run_python_exemple.sikuli

    21

#

    22

#       run Xnest window with just xterm

    23

#           $ make xnest_xterm

    24

#

    25

#       run Xnest window with sikuli IDE and xterm

    26

#           $ make xnest_sikuli

    27

#

    28

#       build minimal beremiz and matiec to run tests

    29

#           $ make own_apps

    30

#

    31

#   For CI/CD scripts to catch and report all failures. Use cases :

    32

#

    33

#       run all tests

    34

#           $ make

    35

#

    36

#   

    37

#   Test results, and other test byproducts are in $(test_dir), 

    38

#   $(test_dir) defaults to $(HOME)/test and can be overloaded:

    39

#       $ make test_dir=${HOME}/other_test_dir

    40

#

    41

#   Makefile attemps to use xvfb-run to run each test individually with its own

    42

#   X server instance. This behavior can be overloaded

    43

#       $ DISPLAY=:42 make xserver_command='echo "Using $DISPLAY X Server !";'

    44

#

    45

#   Matiec and Beremiz code are expected to be clean, ready to build

    46

#   Any change in Matiec directory triggers rebuild of matiec.

    47

#   Any change in Matiec and Beremiz directory triggers copy of source code

    48

#   to $(test_dir)/build.

    49

#

    50

#

    51

#   Please note:

    52

#       In order to run asside a freshly build Matiec, tested beremiz instance

    53

#       needs to run on code from $(test_dir)/build/beremiz, a fresh copy

    54

#       of the Beremiz directory $(src)/beremiz, where we run tests from.

    55

#   

    56

    57

all: source_check cli_tests ide_tests runtime_tests 

    58

    59

# Variable $(src) is directory such that executed 

    60

# $(src)/Makefile is this file.

    61

src := $(abspath $(dir $(lastword $(MAKEFILE_LIST))))

    62

    63

# $(workspace) is directory containing this project

    64

workspace ?= $(abspath $(src)/../..)

    65

    66

test_dir ?= $(HOME)/test

    67

build_dir = $(test_dir)/build

    68

    69

OWN_PROJECTS=beremiz matiec

    70

    71

tar_opts=--absolute-names --exclude=.hg --exclude=.git --exclude=.*.pyc --exclude=.*.swp

    72

    73

# sha1 checksum of source is used to force copy/compile on each change

    74

    75

define make_checksum_assign

    76

$(1)_checksum = $(shell tar $(tar_opts) -c $(workspace)/$(1) | sha1sum | cut -d ' ' -f 1)

    77

endef

    78

$(foreach project,$(OWN_PROJECTS),$(eval $(call make_checksum_assign,$(project))))

    79

    80

$(build_dir):

    81

	mkdir -p $(build_dir)

    82

    83

define make_src_rule

    84

$(build_dir)/$(1)/$($(1)_checksum).sha1: $(build_dir) $(workspace)/$(1)

    85

	rm -rf $(build_dir)/$(1)

    86

	tar -C $(workspace) $(tar_opts) -c $(1) | tar -C $(build_dir) -x

    87

	#cp -a $(workspace)/$(1) $(build_dir)/$(1)

    88

	touch $$@

    89

endef

    90

$(foreach project,$(OWN_PROJECTS),$(eval $(call make_src_rule,$(project))))

    91

    92

$(build_dir)/matiec/iec2c: | $(build_dir)/matiec/$(matiec_checksum).sha1

    93

	cd $(build_dir)/matiec && \

    94

    autoreconf -i && \

    95

    ./configure && \

    96

    make

    97

    98

# TODO: use packge (deb/snap ?)

    99

own_apps: $(build_dir)/matiec/iec2c $(build_dir)/beremiz/$(beremiz_checksum).sha1

   100

	touch $@

   101

   102

ide_tests = $(subst $(src)/ide_tests/,,$(wildcard $(src)/ide_tests/*.sikuli))

   103

   104

define idetest_command

   105

	(fluxbox >/dev/null 2>&1 &); BEREMIZPATH=$(build_dir)/beremiz sikulix -r $(src)/ide_tests/$(1) | tee test_stdout.txt; exit $$$${PIPESTATUS[0]}

   106

endef

   107

   108

# Xnest based interactive sessions for tests edit and debug. 

   109

# Would be nice with something equivalent to xvfb-run, waiting for USR1.

   110

# Arbitrary "sleep 1" is probably enough for interactive use

   111

define xnest_run

   112

	Xnest :42 -geometry 1920x1080+0+0 & export xnestpid=$$!; sleep 1; DISPLAY=:42 $(1); export res=$$?; kill $${xnestpid} 2>/dev/null; exit $${res}

   113

endef

   114

   115

define prep_test

   116

	rm -rf $(test_dir)/$(1)_idetest

   117

	mkdir $(test_dir)/$(1)_idetest

   118

	cd $(test_dir)/$(1)_idetest

   119

endef

   120

   121

xserver_command ?= xvfb-run -s '-screen 0 1920x1080x24'

   122

   123

define make_idetest_rule

   124

$(test_dir)/$(1)_idetest/.passed: own_apps

   125

	$(call prep_test,$(1)); $(xserver_command) bash -c '$(call idetest_command,$(1))'

   126

	touch $$@

   127

   128

# Manually invoked rule {testname}.sikuli

   129

$(1): $(test_dir)/$(1)_idetest/.passed

   130

   131

# Manually invoked rule xnest_{testname}.sikuli

   132

# runs test in xnest so that one can see what happens

   133

xnest_$(1): own_apps

   134

	$(call prep_test,$(1)); $$(call xnest_run, bash -c '$(call idetest_command,$(1))')

   135

   136

ide_tests_targets += $(test_dir)/$(1)_idetest/.passed

   137

endef

   138

$(foreach idetest,$(ide_tests),$(eval $(call make_idetest_rule,$(idetest))))

   139

   140

ide_tests : $(ide_tests_targets)

   142

   143

xnest_xterm: own_apps

   144

	$(call xnest_run, bash -c '(fluxbox &);xterm')

   145

   146

xnest_sikuli: own_apps

   147

	$(call xnest_run, bash -c '(fluxbox &);(BEREMIZPATH=$(build_dir)/beremiz xterm -e sikulix &);xterm')

   148

   156

   157

clean:

   158

	rm -rf $(ide_tests_targets) $(build_dir)

   159

   160

   161

# TODOs 

   162

   163

source_check:

   164

	echo TODO $@

   165

   166

cli_tests :

   167

	echo TODO $@

   168

   169

runtime_tests:

   170

	echo TODO $@

   171

   172

   173