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 built_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

#   BEREMIZPYTHONPATH is expected to be absolute path to python interpreter

    51

#

    52

#   Please note:

    53

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

    54

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

    55

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

    56

#   

    57

    58

all: source_check cli_tests ide_tests runtime_tests 

    59

    60

# Variable $(src) is directory such that executed 

    61

# $(src)/Makefile is this file.

    62

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

    63

    64

# $(workspace) is directory containing this project

    65

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

    66

    67

test_dir ?= $(HOME)/test

    68

build_dir = $(test_dir)/build

    69

    70

#

    71

# SOURCE and BUILD

    72

#

    73

    74

BUILT_PROJECTS=beremiz matiec open62541

    75

    76

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

    77

    78

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

    79

    80

define make_checksum_assign

    81

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

    82

endef

    83

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

    84

    85

$(build_dir):

    86

	mkdir -p $(build_dir)

    87

    88

define make_src_rule

    89

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

    90

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

    91

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

    92

	touch $$@

    93

endef

    94

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

    95

    96

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

    97

	cd $(build_dir)/matiec && \

    98

    autoreconf -i && \

    99

    ./configure && \

   100

    make

   101

   102

$(build_dir)/open62541/build/bin/libopen62541.a: | $(build_dir)/open62541/$(open62541_checksum).sha1

   103

	cd $(build_dir)/open62541 && \

   104

    rm -rf build && mkdir build && cd build && \

   105

	cmake -D UA_ENABLE_ENCRYPTION=OPENSSL .. && \

   106

	make

   107

   108

built_apps: $(build_dir)/matiec/iec2c $(build_dir)/beremiz/$(beremiz_checksum).sha1 $(build_dir)/open62541/build/bin/libopen62541.a

   109

	touch $@

   110

   111

define log_command

   112

	$(call $(1),$(2)) | tee test_stdout.txt; exit $$$${PIPESTATUS[0]}

   113

endef

   114

   115

define prep_test

   116

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

   117

	mkdir $(test_dir)/$(1)_results

   118

	cd $(test_dir)/$(1)_results

   119

endef

   120

   121

#

   122

# IDE TESTS

   123

#

   124

   125

ide_test_dir = $(src)/ide_tests

   126

sikuli_ide_tests = $(subst $(ide_test_dir)/,,$(wildcard $(ide_test_dir)/*.sikuli))

   127

pytest_ide_tests = $(subst $(ide_test_dir)/,,$(wildcard $(ide_test_dir)/*.pytest))

   128

   129

fluxbox_command ?= echo "session.screen0.toolbar.placement: TopCenter" > fluxbox_init; (fluxbox -rc fluxbox_init >/dev/null 2>&1 &)

   130

   131

define sikuli_idetest_command

   132

	$(fluxbox_command); BEREMIZPATH=$(build_dir)/beremiz sikulix -r $(src)/ide_tests/$(1)

   133

endef

   134

   135

   136

DELAY=400

   137

KILL_DELAY=430

   138

PYTEST=$(dir $(BEREMIZPYTHONPATH))pytest

   139

define pytest_idetest_command

   140

	$(fluxbox_command); PYTHONPATH=$(ide_test_dir) timeout -k $(KILL_DELAY) $(DELAY) $(PYTEST) --maxfail=1 --timeout=100  $(src)/ide_tests/$(1)

   141

endef

   142

   143

# Xnest based interactive sessions for tests edit and debug. 

   144

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

   145

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

   146

define xnest_run

   147

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

   148

endef

   149

   150

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

   151

   152

define make_idetest_rule

   153

$(test_dir)/$(1)_results/.passed: built_apps

   154

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

   155

	touch $$@

   156

   157

# Manually invoked rule {testname}.sikuli

   158

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

   159

   160

# Manually invoked rule xnest_{testname}.sikuli

   161

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

   162

xnest_$(1): built_apps

   163

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

   164

   165

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

   166

endef

   167

$(foreach idetest,$(sikuli_ide_tests),$(eval $(call make_idetest_rule,$(idetest),sikuli_idetest_command)))

   168

$(foreach idetest,$(pytest_ide_tests),$(eval $(call make_idetest_rule,$(idetest),pytest_idetest_command)))

   169

   170

ide_tests : $(ide_tests_targets)

   171

	echo "$(ide_tests_targets) : Passed"

   172

   173

xnest_xterm: built_apps

   174

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

   175

   176

xnest_sikuli: built_apps

   177

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

   178

   179

xvfb_sikuli: built_apps

   180

	echo "******************************************"

   181

	echo "On host, run 'xvncviewer 127.0.0.1:5900' to see sikuli X session"

   182

	echo "Docker container must be created with TESTDEBUG=YES. For example :"

   183

	echo "./clean_docker_container.sh && ./build_docker_image.sh && TESTDEBUG=YES ./create_docker_container.sh && ./do_test_in_docker.sh xvfb_sikuli"

   184

	echo "******************************************"

   185

	$(xserver_command) bash -c '(fluxbox &);(x11vnc &);(BEREMIZPATH=$(build_dir)/beremiz xterm -e sikulix &);xterm'

   186

   187

#

   188

# CLI TESTS

   189

#

   190

   191

cli_test_dir = $(src)/cli_tests

   192

cli_tests = $(subst $(cli_test_dir)/,,$(wildcard $(cli_test_dir)/*.bash))

   193

   194

define clitest_command

   195

	BEREMIZPATH=$(build_dir)/beremiz source $(src)/cli_tests/$(1)

   196

endef

   197

   198

define make_clitest_rule

   199

$(test_dir)/$(1)_results/.passed: built_apps

   200

	$(call prep_test,$(1)); bash -c '$(call log_command,$(2),$(1))'

   201

	touch $$@

   202

   203

# Manually invoked rule

   204

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

   205

   206

cli_tests_targets += $(test_dir)/$(1)_results/.passed

   207

endef

   208

$(foreach clitest,$(cli_tests),$(eval $(call make_clitest_rule,$(clitest),clitest_command)))

   209

   210

cli_tests: $(cli_tests_targets)

   211

	echo "$(cli_tests_targets) : Passed"

   212

   213

clean_results:

   214

	rm -rf $(test_dir)/*_results

   215

   216

clean: clean_results

   217

	rm -rf $(build_dir)

   218

   219

   220

# TODOs 

   221

   222

source_check:

   223

	echo TODO $@

   224

   225

runtime_tests:

   226

	echo TODO $@

   227

   228

   229