summaryrefslogtreecommitdiffstats
path: root/tests/arthur/common/baselineprotocol.cpp
blob: 83b7adc78da90f8e4742c0fc8b32e23fd4d5a454 (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

#include "baselineprotocol.h"
#include <QLibraryInfo>
#include <QImage>
#include <QBuffer>
#include <QHostInfo>

PlatformInfo::PlatformInfo(bool useLocal)
{
    if (useLocal) {
        buildKey = QLibraryInfo::buildKey();
        qtVersion = QLatin1String(qVersion());
        hostname = QHostInfo::localHostName();
    }
}

QDataStream & operator<< (QDataStream &stream, const PlatformInfo &pinfo)
{
    stream << pinfo.buildKey << pinfo.qtVersion << pinfo.hostname;
    return stream;
}

QDataStream & operator>> (QDataStream& stream, PlatformInfo& pinfo)
{
    stream >> pinfo.buildKey >> pinfo.qtVersion >> pinfo.hostname;
    return stream;
}

BaselineProtocol::~BaselineProtocol()
{
    socket.close();
    if (socket.state() != QTcpSocket::UnconnectedState)
        socket.waitForDisconnected(Timeout);
}


bool BaselineProtocol::connect()
{
    errMsg.clear();
    //###TBD: determine server address; for now local devhost
    QLatin1String serverName("chimera.europe.nokia.com");

    socket.connectToHost(serverName, ServerPort);

    if (!socket.waitForConnected(Timeout)) {
        errMsg += QLatin1String("TCP connectToHost failed. Host:") + serverName + QLatin1String(" port:") + QString::number(ServerPort);
        return false;
    }

    PlatformInfo pi(true);
    QByteArray block;
    QDataStream ds(&block, QIODevice::ReadWrite);
    ds << pi;
    if (!sendBlock(AcceptPlatformInfo, block)) {
        errMsg += QLatin1String("Failed to send data to server.");
        return false;
    }

    Command cmd = Ack;
    if (!receiveBlock(&cmd, &block) || cmd != Ack) {
        errMsg += QLatin1String("Failed to get response from server.");
        return false;
    }

    return true;
}


bool BaselineProtocol::acceptConnection(PlatformInfo *pi)
{
    errMsg.clear();

    QByteArray block;
    Command cmd = AcceptPlatformInfo;
    if (!receiveBlock(&cmd, &block) || cmd != AcceptPlatformInfo)
        return false;

    if (pi) {
        QDataStream ds(block);
        ds >> *pi;
    }

    if (!sendBlock(Ack, QByteArray()))
        return false;
    return true;
}


bool BaselineProtocol::requestBaseline(const QString &caseId, Command *response, QImage *baseline)
{
    errMsg.clear();
    if (!sendBlock(RequestBaseline, caseId.toLatin1()))
        return false;
    QByteArray imgData;
    Command cmd;
    if (!receiveBlock(&cmd, &imgData))
        return false;
    if (response)
        *response = cmd;
    if (cmd == BaselineNotPresent || cmd == IgnoreCase)
        return true;
    else if (cmd == AcceptBaseline) {
        if (baseline) {
            // hm, get the name also, for checking?
            *baseline = QImage::fromData(imgData);
            if (baseline->isNull()) {
                errMsg.prepend(QLatin1String("Invalid baseline image data received. "));
                return false;
            }
        }
        return true;
    }
    errMsg.prepend(QLatin1String("Unexpected reply from server on baseline request. "));
    return false;
}


bool BaselineProtocol::submitNewBaseline(const QString &caseId, const QImage &baseline)
{
    errMsg.clear();
    QBuffer buf;
    buf.open(QIODevice::WriteOnly);
    QDataStream ds(&buf);
    ds << caseId.toLatin1();
    if (!baseline.save(&buf, FileFormat)) {
        errMsg = QLatin1String("Failed to convert new baseline image to ") + QLatin1String(FileFormat);
        return false;
    }
    if (!sendBlock(AcceptNewBaseline, buf.data())) {
        errMsg.prepend(QLatin1String("Failed to submit new baseline to server. "));
        return false;
    }
    Command cmd;
    receiveBlock(&cmd, 0);  // Just wait for the pong; ignore reply contents
    return true;
}


bool BaselineProtocol::submitMismatch(const QString &caseId, const QImage &mismatch, QByteArray *failMsg)
{
    errMsg.clear();
    QBuffer buf;
    buf.open(QIODevice::WriteOnly);
    QDataStream ds(&buf);
    ds << caseId.toLatin1();
    if (!mismatch.save(&buf, FileFormat)) {
        errMsg = QLatin1String("Failed to convert mismatched image to ") + QLatin1String(FileFormat);
        return false;
    }
    if (!sendBlock(AcceptMismatch, buf.data())) {
        errMsg.prepend(QLatin1String("Failed to submit mismatched image to server. "));
        return false;
    }
    Command cmd;
    if (!receiveBlock(&cmd, failMsg)) {
        errMsg.prepend(QLatin1String("Failed to receive response on mismatched image from server. "));
        return false;
    }
    return true;
}


bool BaselineProtocol::sendBlock(Command cmd, const QByteArray &block)
{
    QDataStream s(&socket);
    // TBD: set qds version as a constant
    s << quint16(ProtocolVersion) << quint16(cmd);
    s.writeBytes(block.constData(), block.size());
    return true;
}


bool BaselineProtocol::receiveBlock(Command *cmd, QByteArray *block)
{
    while (socket.bytesAvailable() < int(2*sizeof(quint16) + sizeof(quint32))) {
        if (!socket.waitForReadyRead(Timeout))
            return false;
    }
    QDataStream ds(&socket);
    quint16 rcvProtocolVersion, rcvCmd;
    ds >> rcvProtocolVersion >> rcvCmd;
    if (rcvProtocolVersion != ProtocolVersion) {
        // TBD: More resilient handling of this case; the server should accept client's version
        errMsg = QLatin1String("Server protocol version mismatch, received:") + QString::number(rcvProtocolVersion);

        return false;
    }
    if (cmd)
        *cmd = Command(rcvCmd);

    QByteArray uMsg;
    quint32 remaining;
    ds >> remaining;
    uMsg.resize(remaining);
    int got = 0;
    char* uMsgBuf = uMsg.data();
    do {
        got = ds.readRawData(uMsgBuf, remaining);
        remaining -= got;
        uMsgBuf += got;
    } while (remaining && got >= 0 && socket.waitForReadyRead(Timeout));

    if (got < 0)
        return false;

    if (block)
        *block = uMsg;

    return true;
}


QString BaselineProtocol::errorMessage()
{
    QString ret = errMsg;
    if (socket.error() >= 0)
        ret += QLatin1String(" Socket state: ") + socket.errorString();
    return ret;
}