1

"Commons definitions for sikuli based beremiz IDE GUI tests"

     2

     3

import os

     4

import sys

     5

import subprocess

     6

import traceback

     7

from threading import Thread, Event, Lock

     8

from time import time as timesec

     9

    10

import sikuli

    11

    12

beremiz_path = os.environ["BEREMIZPATH"]

    13

python_bin = os.environ.get("BEREMIZPYTHONPATH", "/usr/bin/python")

    14

    15

opj = os.path.join

    16

    17

    18

class KBDShortcut:

    19

    """Send shortut to app by calling corresponding methods.

    20

    21

    example:

    22

        k = KBDShortcut()

    23

        k.Clean()

    24

    """

    25

    26

    fkeys = {"Stop":     sikuli.Key.F4,

    27

             "Run":      sikuli.Key.F5,

    28

             "Transfer": sikuli.Key.F6,

    29

             "Connect":  sikuli.Key.F7,

    30

             "Clean":    sikuli.Key.F9,

    31

             "Build":    sikuli.Key.F11,

    32

             "Save":     ("s",sikuli.Key.CTRL),

    33

             "New":      ("n",sikuli.Key.CTRL),

    34

             "Address":  ("l",sikuli.Key.CTRL)}  # to reach address bar in GTK's file selector

    35

    36

    def __init__(self, app):

    37

        self.app = app

    38

    39

    def __getattr__(self, name):

    40

        fkey = self.fkeys[name]

    41

        if type(fkey) != tuple:

    42

            fkey = (fkey,)

    43

    44

        def PressShortCut():

    45

            self.app.sikuliapp.focus()

    46

            sikuli.type(*fkey)

    47

            self.app.ReportText("Sending " + name + " shortcut")

    48

    49

        return PressShortCut

    50

    51

    52

class IDEIdleObserver:

    53

    "Detects when IDE is idle. This is particularly handy when staring an operation and witing for the en of it."

    54

    55

    def __init__(self):

    56

        """

    57

        Parameters: 

    58

            app (class BeremizApp)

    59

        """

    60

        self.r = sikuli.Region(self.sikuliapp.window())

    61

    62

        self.idechanged = False

    63

    64

        # 200 was selected because default 50 was still catching cursor blinking in console

    65

        # FIXME : remove blinking cursor in console

    66

        self.r.onChange(200,self._OnIDEWindowChange)

    67

        self.r.observeInBackground()

    68

    69

    def __del__(self):

    70

        self.r.stopObserver()

    71

    72

    def _OnIDEWindowChange(self, event):

    73

        self.idechanged = True

    74

    75

    def WaitIdleUI(self, period=1, timeout=15):

    76

        """

    77

        Wait for IDE to stop changing

    78

        Parameters: 

    79

            period (int): how many seconds with no change to consider idle

    80

            timeout (int): how long to wait for idle, in seconds

    81

        """

    82

        c = max(timeout/period,1)

    83

        while c > 0:

    84

            self.idechanged = False

    85

            sikuli.wait(period)

    86

            if not self.idechanged:

    87

                break

    88

            c = c - 1

    89

    90

        self.ReportScreenShot("UI is idle" if c != 0 else "UI is not idle")

    91

    92

        if c == 0:

    93

            raise Exception("Window did not idle before timeout")

    94

    95

    96

class stdoutIdleObserver:

    97

    "Detects when IDE's stdout is idle. Can be more reliable than pixel based version (false changes ?)"

    98

    99

    def __init__(self):

   100

        """

   101

        Parameters: 

   102

            app (class BeremizApp)

   103

        """

   104

        self.stdoutchanged = False

   105

   106

        self.event = Event()

   107

   108

        self.pattern = None

   109

        self.success_event = Event()

   110

   111

        self.thread = Thread(target = self._waitStdoutProc).start()

   112

   113

    def __del__(self):

   114

        pass  # self.thread.join() ?

   115

   116

    def _waitStdoutProc(self):

   117

        while True:

   118

            a = self.proc.stdout.readline()

   119

            if len(a) == 0 or a is None: 

   120

                break

   121

            sys.stdout.write(a)

   122

            self.ReportOutput(a)

   123

            self.event.set()

   124

            if self.pattern is not None and a.find(self.pattern) >= 0:

   125

                sys.stdout.write("found pattern in '" + a +"'")

   126

                self.success_event.set()

   127

   128

    def waitForChangeAndIdleStdout(self, period=2, timeout=15):

   129

        """

   130

        Wait for IDE'stdout to start changing

   131

        Parameters: 

   132

            timeout (int): how long to wait for change, in seconds

   133

        """

   134

        start_time = timesec()

   135

   136

        wait_result = self.event.wait(timeout)

   137

   138

        self.ReportScreenShot("stdout changed" if wait_result else "stdout didn't change")

   139

   140

        if wait_result:

   141

            self.event.clear()

   142

        else:

   143

            raise Exception("Stdout didn't become active before timeout")

   144

   145

        self.waitIdleStdout(period, timeout - (timesec() - start_time))

   146

   147

    def waitIdleStdout(self, period=2, timeout=15):

   148

        """

   149

        Wait for IDE'stdout to stop changing

   150

        Parameters: 

   151

            period (int): how many seconds with no change to consider idle

   152

            timeout (int): how long to wait for idle, in seconds

   153

        """

   154

        end_time = timesec() + timeout

   155

        self.event.clear()

   156

        while timesec() < end_time:

   157

            if self.event.wait(period):

   158

                # no timeout -> got event -> not idle -> loop again

   159

                self.event.clear()

   160

            else:

   161

                # timeout -> no event -> idle -> exit

   162

                self.ReportScreenShot("stdout is idle")

   163

                return True

   164

   165

        self.ReportScreenShot("stdout did not idle")

   166

   167

        raise Exception("Stdout did not idle before timeout")

   168

   169

    def waitPatternInStdout(self, pattern, timeout, count=1):

   170

        found = 0

   171

        self.pattern = pattern

   172

        end_time = timesec() + timeout

   173

        self.event.clear()

   174

        while True:

   175

            remain = end_time - timesec()

   176

            if remain <= 0 :

   177

                res = False

   178

                break

   179

   180

            res = self.success_event.wait(remain)

   181

            if res:

   182

                self.success_event.clear()

   183

                found = found + 1

   184

                if found >= count:

   185

                    break

   186

        self.pattern = None

   187

        self.ReportScreenShot("found pattern" if res else "pattern not found")

   188

        return res

   189

   190

class BeremizApp(IDEIdleObserver, stdoutIdleObserver):

   191

    def __init__(self, projectpath=None, exemple=None):

   192

        """

   193

        Starts Beremiz IDE, waits for main window to appear, maximize it.

   194

   195

            Parameters: 

   196

                projectpath (str): path to project to open

   197

                exemple (str): path relative to exemples directory

   198

   199

            Returns:

   200

                Sikuli App class instance

   201

        """

   202

   203

        sikuli.OCR.Options().smallFont()

   204

   205

        self.screenshotnum = 0

   206

        self.starttime = timesec()

   207

        self.screen = sikuli.Screen()

   208

   209

        self.report = open("report.html", "w")

   210

        self.report.write("""<!doctype html>

   211

<html>

   212

  <head>

   213

    <meta charset="utf-8">

   214

    <meta name="color-scheme" content="light dark">

   215

    <title>Test report</title>

   216

  </head>

   217

  <body>

   218

""")

   219

   220

        command = [python_bin, opj(beremiz_path,"Beremiz.py"), "--log=/dev/stdout"]

   221

   222

        if exemple is not None:

   223

            command.append(opj(beremiz_path,"exemples",exemple))

   224

        elif projectpath is not None:

   225

            command.append(projectpath)

   226

   227

        # App class is broken in Sikuli 2.0.5: can't start process with arguments.

   228

        # 

   229

        # Workaround : - use subprocess module to spawn IDE process,

   230

        #              - use wmctrl to find IDE window details and maximize it

   231

        #              - pass exact window title to App class constructor

   232

   233

        self.ReportText("Launching " + repr(command))

   234

   235

        self.proc = subprocess.Popen(command, stdout=subprocess.PIPE, bufsize=0)

   236

   237

        # Window are macthed against process' PID

   238

        ppid = self.proc.pid

   239

   240

        # Timeout 5s

   241

        c = 50

   242

        while c > 0:

   243

            # equiv to "wmctrl -l -p | grep $pid"

   244

            try:

   245

                wlist = filter(lambda l:(len(l)>2 and l[2]==str(ppid)), map(lambda s:s.split(None,4), subprocess.check_output(["wmctrl", "-l", "-p"]).splitlines()))

   246

            except subprocess.CalledProcessError:

   247

                wlist = []

   248

   249

            # window with no title only has 4 fields do describe it

   250

            # beremiz splashcreen has no title

   251

            # wait until main window is visible

   252

            if len(wlist) == 1 and len(wlist[0]) == 5:

   253

                windowID,_zero,wpid,_XID,wtitle = wlist[0] 

   254

                break

   255

   256

            sikuli.wait(0.1)

   257

            c = c - 1

   258

   259

        if c == 0:

   260

            raise Exception("Couldn't find Beremiz window")

   261

   262

        # Maximize window x and y

   263

        subprocess.check_call(["wmctrl", "-i", "-r", windowID, "-b", "add,maximized_vert,maximized_horz"])

   264

   265

        # switchApp creates an App object by finding window by title, is not supposed to spawn a process

   266

        self.sikuliapp = sikuli.switchApp(wtitle)

   267

        self.k = KBDShortcut(self)

   268

   269

        IDEIdleObserver.__init__(self)

   270

        stdoutIdleObserver.__init__(self)

   271

   272

        # stubs for common sikuli calls to allow adding hooks later

   273

        for name in ["click","doubleClick","type","rightClick","wait"]:

   274

            def makeMyMeth(n):

   275

                def myMeth(*args, **kwargs):

   276

                    self.ReportScreenShot("Begin: " + n + "(" + repr(args) + "," + repr(kwargs) + ")")

   277

                    try:

   278

                        getattr(sikuli, n)(*args, **kwargs)

   279

                    finally:

   280

                        self.ReportScreenShot("end: " + n + "(" + repr(args) + "," + repr(kwargs) + ")")

   281

                return myMeth

   282

            setattr(self, name, makeMyMeth(name))

   283

   284

    def close(self):

   285

        self.sikuliapp.close()

   286

        self.sikuliapp = None

   287

        self.report.write("""

   288

  </body>

   289

</html>""")

   290

        self.report.close()

   291

   292

    def __del__(self):

   293

        if self.sikuliapp is not None:

   294

            self.sikuliapp.close()

   295

        IDEIdleObserver.__del__(self)

   296

        stdoutIdleObserver.__del__(self)

   297

   298

    def ReportScreenShot(self, msg):

   299

        elapsed = "%.3fs: "%(timesec() - self.starttime)

   300

        fname = "capture"+str(self.screenshotnum)+".png"

   301

        cap = self.screen.capture(self.r)

   302

        cap.save(".", fname)

   303

        self.screenshotnum = self.screenshotnum + 1

   304

        self.report.write( "<p>" + elapsed + msg + "<br/><img src=\""+ fname + "\">" + "</p>")

   305

   306

    def ReportText(self, text):

   307

        elapsed = "%.3fs: "%(timesec() - self.starttime)

   308

        self.report.write("<p>" + elapsed + text + "</p>")

   309

   310

    def ReportOutput(self, text):

   311

        elapsed = "%.3fs: "%(timesec() - self.starttime)

   312

        self.report.write("<pre>" + elapsed + text + "</pre>")

   313

   314

   315

def run_test(func, *args, **kwargs):

   316

    app = BeremizApp(*args, **kwargs)

   317

    try:

   318

        success = func(app)

   319

    except:

   320

        # sadly, sys.excepthook is broken in sikuli/jython 

   321

        # purpose of this run_test function is to work around it.

   322

        # and catch exception cleanly anyhow

   323

        e_type, e_value, e_traceback = sys.exc_info()

   324

        err_msg = "\n".join(traceback.format_exception(e_type, e_value, e_traceback))

   325

        sys.stdout.write(err_msg)

   326

        app.ReportOutput(err_msg)

   327

        success = False

   328

   329

    app.close()

   330

   331

    if success:

   332

        sikuli.exit(0)

   333

    else:

   334

        sikuli.exit(1)

   335

   336

   337