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_xterm

    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

#   Variable $(src) is directory such that executed 

    38

#   $(src)/beremiz/tests/Makefile is this file.

    39

#   

    40

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

    41

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

    42

#       $ make test_dir=${HOME}/other_test_dir

    43

#

    44

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

    45

#   X server instance. This behavior can be overloaded

    46

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

    47

#

    48

#   Matiec and Beremiz code are expected to be clean as if after hg clean --all.

    49

#   Any change in Matiec directory triggers rebuild of matiec.

    50

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

    51

#   to $(test_dir)/build.

    52

#

    53

#

    54

#   Please note:

    55

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

    56

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

    57

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

    58

#   

    59

    60

all: source_check cli_tests ide_tests runtime_tests 

    61

    62

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

    63

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

    64

    65

test_dir ?= $(HOME)/test

    66

build_dir = $(test_dir)/build

    67

    68

OWN_PROJECTS=beremiz matiec

    69

    70

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

    71

    72

define make_checksum_assign

    73

$(1)_checksum = $(shell tar --exclude=.hg --exclude=.git --exclude=.*.swp -c $(workspace)/$(1) | sha1sum | cut -d ' ' -f 1)

    74

endef

    75

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

    76

    77

$(build_dir):

    78

	mkdir -p $(build_dir)

    79

    80

define make_src_rule

    81

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

    82

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

    83

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

    84

	touch $$@

    85

endef

    86

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

    87

    88

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

    89

	cd $(build_dir)/matiec && \

    90

    autoreconf -i && \

    91

    ./configure && \

    92

    make

    93

    94

# TODO: use packge (deb/snap ?)

    95

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

    96

	touch $@

    97

    98

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

    99

   100

define idetest_command

   101

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

   102

endef

   103

   104

# Xnest based interactive sessions for tests edit and debug. 

   105

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

   106

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

   107

define xnest_run

   108

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

   109

endef

   110

   111

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

   112

   113

define make_idetest_rule

   114

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

   115

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

   116

	mkdir $(test_dir)/$(1)_idetest

   117

	cd $(test_dir)/$(1)_idetest; $(xserver_command) bash -c '$(call idetest_command, $(1))'

   118

	touch $$@

   119

   120

# Manually invoked rule {testname}.sikuli

   121

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

   122

   123

# Manually invoked rule xnest_{testname}.sikuli

   124

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

   125

xnest_$(1): own_apps

   126

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

   127

	mkdir $(test_dir)/$(1)_idetest

   128

	cd $(test_dir)/$(1)_idetest; $$(call xnest_run, bash -c '$(call idetest_command, $(1))')

   129

   130

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

   131

endef

   132

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

   133

   134

ide_tests : $(ide_tests_targets)

   135

	echo "$(ide_tests_targets)" : Passed

   136

   137

xnest_xterm: own_apps

   138

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

   139

   140

xnest_sikuli: own_apps

   141

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

   142

   143

   144

# in case VNC would be used 

   145

	#xvfb-run -s '-screen 0 1920x1080x24' bash -c '(fluxbox &);(x11vnc &);xterm;'

   146

   147

   148

clean:

   149

	rm -rf $(ide_tests_targets) $(build_dir)

   150

   151

   152

# TODOs 

   153

   154

source_check:

   155

	echo TODO $@

   156

   157

cli_tests :

   158

	echo TODO $@

   159

   160

runtime_tests:

   161

	echo TODO $@

   162

   163

   164