CWebService Class Reference

#include <CWebService.h>

Collaboration diagram for CWebService:

Public Member Functions
	CWebService ()
	~CWebService ()
void	Finish (const char *TestType)
void	Submit (const char *TestType, CTestInfo *TestInfo)

Private Member Functions
PCHAR	DoRequest (const string &InputData)
void	GetTestID (const char *TestType)
PCHAR	GetSuiteID (const char *TestType, CTestInfo *TestInfo)

Private Attributes
HINTERNET	m_hInet
HINTERNET	m_hHTTP
HINTERNET	m_hHTTPRequest
PCHAR	m_TestID

Detailed Description

Definition at line 8 of file CWebService.h.

Constructor & Destructor Documentation

CWebService()

CWebService::CWebService

(

)

Constructs a CWebService object and immediately establishes a connection to the "testman" Web Service.

Definition at line 17 of file CWebService.cpp.

{
    /* Zero-initialize variables */
    m_hHTTP = NULL;
    m_hHTTPRequest = NULL;
    m_TestID = NULL;
 
    /* Establish an internet connection to the "testman" server */
    m_hInet = InternetOpenW(L"rosautotest", INTERNET_OPEN_TYPE_PRECONFIG, NULL, NULL, 0);
 
    if(!m_hInet)
        FATAL("InternetOpenW failed\n");
 
    m_hHTTP = InternetConnectW(m_hInet, szHostname, ServerPort, NULL, NULL, INTERNET_SERVICE_HTTP, 0, 0);
 
    if(!m_hHTTP)
        FATAL("InternetConnectW failed\n");
}

~CWebService()

CWebService::~CWebService

(

)

Destructs a CWebService object and closes all connections to the Web Service.

Definition at line 39 of file CWebService.cpp.

{
    if(m_hInet)
        InternetCloseHandle(m_hInet);
 
    if(m_hHTTP)
        InternetCloseHandle(m_hHTTP);
 
    if(m_hHTTPRequest)
        InternetCloseHandle(m_hHTTPRequest);
 
    if(m_TestID)
        delete m_TestID;
}

Member Function Documentation

DoRequest()

PCHAR CWebService::DoRequest ( const string &  InputData )

private

Sends data to the Web Service.

Parameters

InputData

A std::string containing all the data, which is going to be submitted as HTTP POST data.

Returns

Returns a pointer to a char array containing the data received from the Web Service. The caller needs to free that pointer.

Definition at line 65 of file CWebService.cpp.

{
    const WCHAR szHeaders[] = L"Content-Type: application/x-www-form-urlencoded";
 
    auto_array_ptr<char> Data;
    DWORD DataLength;
 
    /* Post our test results to the web service */
    m_hHTTPRequest = HttpOpenRequestW(m_hHTTP, L"POST", szServerFile, NULL, NULL, NULL, INTERNET_FLAG_SECURE | INTERNET_FLAG_NO_COOKIES | INTERNET_FLAG_RELOAD | INTERNET_FLAG_NO_CACHE_WRITE, 0);
 
    if(!m_hHTTPRequest)
        FATAL("HttpOpenRequestW failed\n");
 
    Data.reset(new char[InputData.size() + 1]);
    strcpy(Data, InputData.c_str());
 
    if(!HttpSendRequestW(m_hHTTPRequest, szHeaders, lstrlenW(szHeaders), Data, (DWORD)InputData.size()))
        FATAL("HttpSendRequestW failed\n");
 
    /* Get the response */
    if(!InternetQueryDataAvailable(m_hHTTPRequest, &DataLength, 0, 0))
        FATAL("InternetQueryDataAvailable failed\n");
 
    Data.reset(new char[DataLength + 1]);
 
    if(!InternetReadFile(m_hHTTPRequest, Data, DataLength, &DataLength))
        FATAL("InternetReadFile failed\n");
 
    Data[DataLength] = 0;
 
    return Data.release();
}

Referenced by Finish(), GetSuiteID(), GetTestID(), and Submit().

Finish()

void CWebService::Finish

(

const char *

TestType

)

Interface to other classes for finishing this test run

Parameters

TestType

Constant pointer to a char array containing the test type to be run (i.e. "wine")

Definition at line 105 of file CWebService.cpp.

{
    auto_array_ptr<char> Response;
    string Data;
    stringstream ss;
 
    if (!m_TestID)
        EXCEPTION("CWebService::Finish was called, but not a single result had been submitted!\n");
 
    Data = "action=finish";
    Data += Configuration.GetAuthenticationRequestString();
    Data += "&testtype=";
    Data += TestType;
    Data += "&testid=";
    Data += m_TestID;
 
    Response.reset(DoRequest(Data));
 
    if (strcmp(Response, "OK"))
    {
        ss << "When finishing the test run, the server responded:" << endl << Response << endl;
        SSEXCEPTION;
    }
}

GetSuiteID()

PCHAR CWebService::GetSuiteID ( const char *  TestType, CTestInfo *  TestInfo  )

private

Gets a Suite ID from the Web Service for this module/test combination.

Parameters

TestType	Constant pointer to a char array containing the test type to be run (i.e. "wine")
TestInfo	Pointer to a CTestInfo object containing information about the test

Returns

Returns a pointer to a char array containing the Suite ID received from the Web Service. The caller needs to free that pointer.

Definition at line 179 of file CWebService.cpp.

{
    auto_array_ptr<char> SuiteID;
    string Data;
 
    Data = "action=getsuiteid";
    Data += Configuration.GetAuthenticationRequestString();
    Data += "&testtype=";
    Data += TestType;
    Data += "&module=";
    Data += TestInfo->Module;
    Data += "&test=";
    Data += TestInfo->Test;
 
    SuiteID.reset(DoRequest(Data));
 
    /* Verify that this is really a number */
    if(!IsNumber(SuiteID))
    {
        stringstream ss;
 
        ss << "Expected Suite ID, but received:" << endl << SuiteID << endl;
        SSEXCEPTION;
    }
 
    return SuiteID.release();
}

Referenced by Submit().

GetTestID()

void CWebService::GetTestID ( const char *  TestType )

private

Requests a Test ID from the Web Service for our test run.

Parameters

TestType

Constant pointer to a char array containing the test type to be run (i.e. "wine")

Definition at line 137 of file CWebService.cpp.

{
    string Data;
 
    Data = "action=gettestid";
    Data += Configuration.GetAuthenticationRequestString();
    Data += Configuration.GetSystemInfoRequestString();
    Data += "&testtype=";
    Data += TestType;
 
    if(!Configuration.GetComment().empty())
    {
        Data += "&comment=";
        Data += Configuration.GetComment();
    }
 
    m_TestID = DoRequest(Data);
 
    /* Verify that this is really a number */
    if(!IsNumber(m_TestID))
    {
        stringstream ss;
 
        ss << "Expected Test ID, but received:" << endl << m_TestID << endl;
        SSEXCEPTION;
    }
}

Referenced by Submit().

Submit()

void CWebService::Submit	(	const char *	TestType,
		CTestInfo *	TestInfo
	)

Interface to other classes for submitting a result of one test

Parameters

TestType	Constant pointer to a char array containing the test type to be run (i.e. "wine")
TestInfo	Pointer to a CTestInfo object containing information about the test

Definition at line 217 of file CWebService.cpp.

{
    auto_array_ptr<char> Response;
    auto_array_ptr<char> SuiteID;
    string Data;
    stringstream ss;
 
    if(!m_TestID)
        GetTestID(TestType);
 
    SuiteID.reset(GetSuiteID(TestType, TestInfo));
 
    Data = "action=submit";
    Data += Configuration.GetAuthenticationRequestString();
    Data += "&testtype=";
    Data += TestType;
    Data += "&testid=";
    Data += m_TestID;
    Data += "&suiteid=";
    Data += SuiteID;
    Data += "&log=";
    Data += EscapeString(TestInfo->Log);
 
    Response.reset(DoRequest(Data));
 
    if (strcmp(Response, "OK"))
    {
        ss << "When submitting the result, the server responded:" << endl << Response << endl;
        SSEXCEPTION;
    }
}

Member Data Documentation

m_hHTTP

HINTERNET CWebService::m_hHTTP

private

Definition at line 12 of file CWebService.h.

Referenced by CWebService(), DoRequest(), and ~CWebService().

m_hHTTPRequest

HINTERNET CWebService::m_hHTTPRequest

private

Definition at line 13 of file CWebService.h.

Referenced by CWebService(), DoRequest(), and ~CWebService().

m_hInet

HINTERNET CWebService::m_hInet

private

Definition at line 11 of file CWebService.h.

Referenced by CWebService(), and ~CWebService().

m_TestID

PCHAR CWebService::m_TestID

private

Definition at line 14 of file CWebService.h.

Referenced by CWebService(), Finish(), GetTestID(), Submit(), and ~CWebService().

---

The documentation for this class was generated from the following files:

• modules/rostests/rosautotest/CWebService.h
• modules/rostests/rosautotest/CWebService.cpp