summaryrefslogtreecommitdiff
path: root/vcl/source/uitest/logger.cxx
blob: cf63dd6ca70b11b325030551b57c123402bdf393 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */

#include <config_folders.h>

#include <vcl/uitest/logger.hxx>

#include <rtl/bootstrap.hxx>
#include <osl/file.hxx>
#include <vcl/event.hxx>
#include <vcl/uitest/uiobject.hxx>
#include <vcl/uitest/eventdescription.hxx>
#include <svdata.hxx>
#include <com/sun/star/beans/PropertyValue.hpp>
#include <memory>

namespace{

bool isDialogWindow(vcl::Window const * pWindow)
{
    WindowType nType = pWindow->GetType();
    // DIALOG to MODALDIALOG
    if (nType >= WindowType::DIALOG && nType <= WindowType::MODALDIALOG)
        return true;

    // MESSBOX, INFOBOX, WARNINGBOX, ERRORBOX, QUERYBOX
    if (nType >= WindowType::MESSBOX && nType <= WindowType::QUERYBOX)
        return true;

    if (nType == WindowType::TABDIALOG)
        return true;

    return false;
}

bool isTopWindow(vcl::Window const * pWindow)
{
    WindowType eType = pWindow->GetType();
    if (eType == WindowType::FLOATINGWINDOW)
    {
        return pWindow->GetStyle() & WB_SYSTEMFLOATWIN;
    }
    return false;
}

vcl::Window* get_top_parent(vcl::Window* pWindow)
{
    if (isDialogWindow(pWindow) || isTopWindow(pWindow))
        return pWindow;

    vcl::Window* pParent = pWindow->GetParent();
    if (!pParent)
        return pWindow;

    return get_top_parent(pParent);
}


}
UITestLogger::UITestLogger():
    maStream(),
    mbValid(false)
{
    static const char* pFile = std::getenv("LO_COLLECT_UIINFO");
    if (pFile)
    {
        OUString aDirPath("${$BRAND_BASE_DIR/" LIBO_ETC_FOLDER "/" SAL_CONFIGFILE("bootstrap") ":UserInstallation}/uitest/");
        rtl::Bootstrap::expandMacros(aDirPath);
        osl::Directory::createPath(aDirPath);
        OUString aFilePath = aDirPath + OUString::fromUtf8(pFile);

        maStream.Open(aFilePath, StreamMode::READWRITE | StreamMode::TRUNC);
        mbValid = true;
    }
}

void UITestLogger::logCommand(const OUString& rAction, const css::uno::Sequence< css::beans::PropertyValue >& rArgs)
{
    if (!mbValid)
        return;

    OUStringBuffer aBuffer(rAction);

    if (rArgs.hasElements())
    {
        aBuffer.append(" {");
        for (const css::beans::PropertyValue& rProp : rArgs)
        {
            OUString aTypeName = rProp.Value.getValueTypeName();

            if (aTypeName == "long" || aTypeName == "short")
            {
                sal_Int32 nValue = 0;
                rProp.Value >>= nValue;
                aBuffer.append("\"").append(rProp.Name).append("\": ");
                aBuffer.append(OUString::number(nValue)).append(", ");
            }
            else if (aTypeName == "unsigned long")
            {
                sal_uInt32 nValue = 0;
                rProp.Value >>= nValue;
                aBuffer.append("\"").append(rProp.Name).append("\": ");
                aBuffer.append(OUString::number(nValue)).append(", ");
            }
            else if (aTypeName == "boolean")
            {
                bool bValue = false;
                rProp.Value >>= bValue;
                aBuffer.append("\"").append(rProp.Name).append("\": ");
                if (bValue)
                    aBuffer.append("True, ");
                else
                    aBuffer.append("False, ");
            }
        }
        aBuffer.append("}");
    }

    OUString aCommand(aBuffer.makeStringAndClear());
    maStream.WriteLine(OUStringToOString(aCommand, RTL_TEXTENCODING_UTF8));
}

namespace {

// most likely this should be recursive
bool child_windows_have_focus(VclPtr<vcl::Window> const & xUIElement)
{
    sal_Int32 nCount = xUIElement->GetChildCount();
    for (sal_Int32 i = 0; i < nCount; ++i)
    {
        vcl::Window* pChild = xUIElement->GetChild(i);
        if (pChild->HasFocus())
        {
            return true;
        }
        if (child_windows_have_focus(VclPtr<vcl::Window>(pChild)))
            return true;
    }
    return false;
}

}

void UITestLogger::logAction(VclPtr<Control> const & xUIElement, VclEventId nEvent)
{
    if (!mbValid)
        return;

    if (xUIElement->get_id().isEmpty())
        return;

    std::unique_ptr<UIObject> pUIObject = xUIElement->GetUITestFactory()(xUIElement.get());
    OUString aAction = pUIObject->get_action(nEvent);
    if (!xUIElement->HasFocus() && !child_windows_have_focus(xUIElement))
    {
        return;
    }

    if (!aAction.isEmpty())
        maStream.WriteLine(OUStringToOString(aAction, RTL_TEXTENCODING_UTF8));
}

void UITestLogger::log(const OUString& rString)
{
    if (!mbValid)
        return;

    if (rString.isEmpty())
        return;

    maStream.WriteLine(OUStringToOString(rString, RTL_TEXTENCODING_UTF8));
}

void UITestLogger::logKeyInput(VclPtr<vcl::Window> const & xUIElement, const KeyEvent& rEvent)
{
    if (!mbValid)
        return;

    //We need to check for Parent's ID in case the UI Element is SubEdit of Combobox/SpinField
    const OUString& rID = xUIElement->get_id().isEmpty() ?
        xUIElement->GetParent()->get_id() : xUIElement->get_id();
    if (rID.isEmpty())
        return;

    sal_Unicode nChar = rEvent.GetCharCode();
    sal_uInt16 nKeyCode = rEvent.GetKeyCode().GetCode();
    bool bShift = rEvent.GetKeyCode().IsShift();
    bool bMod1 = rEvent.GetKeyCode().IsMod1();
    bool bMod2 = rEvent.GetKeyCode().IsMod2();
    bool bMod3 = rEvent.GetKeyCode().IsMod3();

    std::map<OUString, sal_uInt16> aKeyMap = {
        {"ESC", KEY_ESCAPE},
        {"TAB", KEY_TAB},
        {"DOWN", KEY_DOWN},
        {"UP", KEY_UP},
        {"LEFT", KEY_LEFT},
        {"RIGHT", KEY_RIGHT},
        {"DELETE", KEY_DELETE},
        {"INSERT", KEY_INSERT},
        {"BACKSPACE", KEY_BACKSPACE},
        {"RETURN", KEY_RETURN},
        {"HOME", KEY_HOME},
        {"END", KEY_END},
        {"PAGEUP", KEY_PAGEUP},
        {"PAGEDOWN", KEY_PAGEDOWN}
    };

    OUString aFound;
    for (auto& itr : aKeyMap)
    {
        if (itr.second == nKeyCode)
        {
            aFound = itr.first;
            break;
        }
    }

    OUString aKeyCode;
    if (!aFound.isEmpty() || bShift || bMod1 || bMod2 || bMod3)
    {
        aKeyCode = "{\"KEYCODE\": \"";
        if (bShift)
            aKeyCode += "SHIFT+";

        if (bMod1)
            aKeyCode += "CTRL+";

        if (bMod2)
            aKeyCode += "ALT+";

        if (aFound.isEmpty())
            aKeyCode += OUStringLiteral1(nChar) + "\"}";
        else
            aKeyCode += aFound + "\"}";
    }
    else
    {
        aKeyCode = "{\"TEXT\": \"" + OUStringLiteral1(nChar) + "\"}";
    }

    std::unique_ptr<UIObject> pUIObject = xUIElement->GetUITestFactory()(xUIElement.get());

    VclPtr <vcl::Window> pParent = xUIElement->GetParent();

    while (!pParent->IsTopWindow())
    {
        pParent = pParent->GetParent();
    }

    OUString aParentID = pParent->get_id();

    OUString aContent;

    if(pUIObject->get_type()=="EditUIObject"){
        if(aParentID=="")
        {
            VclPtr <vcl::Window> pParent_top = get_top_parent(xUIElement);
            aParentID= pParent_top->get_id();
        }
        if(aParentID==""){
            aContent =  aContent+"Type on '" + rID + "' " + aKeyCode;
        }
        else{
            aContent =  aContent+"Type on '" + rID + "' " + aKeyCode + " from " + aParentID ;
        }
    }
    else if(pUIObject->get_type()=="SwEditWinUIObject" && rID=="writer_edit"){
        aContent = "Type on writer " + aKeyCode ;
    }
    else if(pUIObject->get_type()=="ScGridWinUIObject" && rID=="grid_window"){
        aContent = "Type on current cell " + aKeyCode ;
    }
    else if(pUIObject->get_type()=="ImpressWindowUIObject" && rID=="impress_win"){
        aContent = "Type on impress " + aKeyCode ;
    }
    else if(pUIObject->get_type()=="WindowUIObject" && rID=="math_edit"){
        aContent = "Type on math " + aKeyCode ;
    }
    else if(rID=="draw_win"){
        aContent = "Type on draw " + aKeyCode ;
    }
    else{
        if(aParentID=="")
        {
            VclPtr <vcl::Window> pParent_top = get_top_parent(xUIElement);
            aParentID= pParent_top->get_id();
        }
        if(aParentID==""){
            aContent =  "Type on '" + rID + "' " + aKeyCode ;
        }
        else{
            aContent =  "Type on '" + rID + "' " + aKeyCode + " from " + aParentID ;
        }
    }
    maStream.WriteLine(OUStringToOString(aContent, RTL_TEXTENCODING_UTF8));
}

namespace {

OUString StringMapToOUString(const std::map<OUString, OUString>& rParameters)
{
    if (rParameters.empty())
        return OUString("");

    OUStringBuffer aParameterString = " {";

    for (std::map<OUString, OUString>::const_iterator itr = rParameters.begin();
        itr != rParameters.end(); ++itr)
    {
        if (itr != rParameters.begin())
            aParameterString.append(", ");
        aParameterString.append("\"").append(itr->first).append("\": \"").append(itr->second).append("\"");
    }

    aParameterString.append("}");

    return aParameterString.makeStringAndClear();
}

OUString GetValueInMapWithIndex(const std::map<OUString, OUString>& rParameters,sal_Int32 index)
{
    sal_Int32 j=0;

    std::map<OUString, OUString>::const_iterator itr = rParameters.begin();

    for ( ; itr != rParameters.end() && j<index ; ++itr,++j);

    return itr->second;
}


OUString GetKeyInMapWithIndex(const std::map<OUString, OUString>& rParameters,sal_Int32 index)
{
    sal_Int32 j=0;

    std::map<OUString, OUString>::const_iterator itr = rParameters.begin();

    for ( ; itr != rParameters.end() && j<index ; ++itr,++j);

    return itr->first;
}

}

void UITestLogger::logEvent(const EventDescription& rDescription)
{
    OUString aParameterString = StringMapToOUString(rDescription.aParameters);

    //here we will customize our statments depending on the caller of this function
    OUString aLogLine ;
    //first check on general commands
    if(rDescription.aAction=="SET"){
        aLogLine =  "Set Zoom to "  + GetValueInMapWithIndex(rDescription.aParameters,0);
    }
    else if(rDescription.aAction=="SIDEBAR"){
        aLogLine = "From SIDEBAR Choose " + aParameterString;
    }
    else if(rDescription.aAction=="SELECT" && rDescription.aID==""){
        aLogLine = "Select " + aParameterString;
    }
    else if(rDescription.aID=="writer_edit"){
        if(rDescription.aAction=="GOTO"){
            aLogLine = "GOTO page number " + GetValueInMapWithIndex(rDescription.aParameters,0);
        }
        else if(rDescription.aAction=="SELECT"){
            OUString to = GetValueInMapWithIndex(rDescription.aParameters,0);
            OUString from =   GetValueInMapWithIndex(rDescription.aParameters,1);
            aLogLine =  "Select from Pos "  +  from + " to Pos " + to ;
        }
        else if(rDescription.aAction=="CREATE_TABLE"){
            OUString size = GetValueInMapWithIndex(rDescription.aParameters,0);
            aLogLine =  "Create Table with " + size; ;
        }
        else if(rDescription.aAction=="COPY"){
            aLogLine =  "Copy the Selected Text";
        }
        else if(rDescription.aAction=="CUT"){
            aLogLine =  "Cut the Selected Text";
        }
        else if(rDescription.aAction=="PASTE"){
            aLogLine =  "Paste in the Current Cursor Location";
        }
        else if(rDescription.aAction=="BREAK_PAGE"){
            aLogLine =  "Insert Break Page";
        }
    }
    else if(rDescription.aID=="grid_window"){

        if(rDescription.aAction=="SELECT"){
            OUString type = GetKeyInMapWithIndex(rDescription.aParameters,0);
            if(type=="CELL" || type=="RANGE"){
                aLogLine = "Select from calc" + aParameterString ;
            }
            else if(type=="TABLE")
            {
                aLogLine = "Switch to sheet number " + GetValueInMapWithIndex(rDescription.aParameters,0) ;
            }
        }
        else if(rDescription.aAction=="LAUNCH"){
            aLogLine = "Lanuch AutoFilter from Col "+
            GetValueInMapWithIndex(rDescription.aParameters,2) +
            " and Row " + GetValueInMapWithIndex(rDescription.aParameters,1);
        }
        else if(rDescription.aAction=="DELETE_CONTENT"){
            aLogLine = "Remove Content from This " + aParameterString;
        }
        else if(rDescription.aAction=="DELETE_CELLS"){
            aLogLine = "Delete The Cells in" + aParameterString;
        }
        else if(rDescription.aAction=="INSERT_CELLS"){
            aLogLine = "Insert Cell around the " + aParameterString;
        }
        else if(rDescription.aAction=="CUT"){
            aLogLine = "CUT the selected " + aParameterString;
        }
        else if(rDescription.aAction=="COPY"){
            aLogLine = "COPY the selected " + aParameterString;
        }
        else if(rDescription.aAction=="PASTE"){
            aLogLine = "Paste in the " + aParameterString;
        }
        else if(rDescription.aAction=="MERGE_CELLS"){
            aLogLine = "Merge " + aParameterString;
        }
        else if(rDescription.aAction=="UNMERGE_CELL"){
            aLogLine = "Delete the merged " + aParameterString;
        }
        else if(rDescription.aAction=="Rename_Sheet"){
            aLogLine = "Rename The Selected Tab to \""+\
            GetValueInMapWithIndex(rDescription.aParameters,0)+"\"";
        }
        else if(rDescription.aAction=="InsertTab"){
            aLogLine = "Insert New Tab ";
        }
    }
    else if(rDescription.aID=="impress_win_or_draw_win"){
        if(rDescription.aAction=="Insert_New_Page_or_Slide"){
            if(UITestLogger::getInstance().getAppName()=="impress"){
                aLogLine = "Insert New Slide at Position " + GetValueInMapWithIndex(rDescription.aParameters,0);
            }
            else if(UITestLogger::getInstance().getAppName()=="draw"){
                aLogLine = "Insert New Page at Position " + GetValueInMapWithIndex(rDescription.aParameters,0);
            }
        }
        else if(rDescription.aAction=="Delete_Slide_or_Page"){
            if(UITestLogger::getInstance().getAppName()=="impress"){
            aLogLine = "Delete Slide number "+ GetValueInMapWithIndex(rDescription.aParameters,0);
            }
            else if(UITestLogger::getInstance().getAppName()=="draw"){
            aLogLine = "Delete Page number "+ GetValueInMapWithIndex(rDescription.aParameters,0);
            }
        }
        else if(rDescription.aAction=="Duplicate"){
            aLogLine = "Duplicate The Selected Slide ";
        }
        else if(rDescription.aAction=="RENAME"){
            if(UITestLogger::getInstance().getAppName()=="impress"){
                aLogLine = "Rename The Selected Slide from \""+ GetValueInMapWithIndex(rDescription.aParameters,1)+\
                 "\" to \"" + GetValueInMapWithIndex(rDescription.aParameters,0)+"\"";
            }
            else if(UITestLogger::getInstance().getAppName()=="draw"){
                aLogLine = "Rename The Selected Page from \""+ GetValueInMapWithIndex(rDescription.aParameters,1)+\
                 "\" to \"" + GetValueInMapWithIndex(rDescription.aParameters,0)+"\"";
            }
        }
    }
    else if(rDescription.aParent=="element_selector"){
        aLogLine ="Select element no " + rDescription.aID +
            " From " + rDescription.aParent;
    }
    else{
        aLogLine = rDescription.aKeyWord + " Action:" +
            rDescription.aAction + " Id:" + rDescription.aID +
            " Parent:" + rDescription.aParent + aParameterString;
    }
    log(aLogLine);
}

UITestLogger& UITestLogger::getInstance()
{
    ImplSVData *const pSVData = ImplGetSVData();
    assert(pSVData);

    if (!pSVData->maWinData.m_pUITestLogger)
    {
        pSVData->maWinData.m_pUITestLogger.reset(new UITestLogger);
    }

    return *pSVData->maWinData.m_pUITestLogger;
}


/* vim:set shiftwidth=4 softtabstop=4 expandtab: */