CWebService Class Reference

#include <CWebService.h>

Inheritance diagram for CWebService:

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

Private Member Functions
virtual PCHAR	DoRequest (const char *Hostname, INTERNET_PORT Port, const char *ServerFile, const string &InputData)=0
void	GetTestID (const char *TestType)
PCHAR	GetSuiteID (const char *TestType, CTestInfo *TestInfo)

Private Attributes
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_TestID = NULL;
}

~CWebService()

CWebService::~CWebService ( )

virtual

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

Definition at line 26 of file CWebService.cpp.

{
    if(m_TestID)
        delete m_TestID;
}

Member Function Documentation

DoRequest()

virtual PCHAR CWebService::DoRequest ( const char *  Hostname, INTERNET_PORT  Port, const char *  ServerFile, const string &  InputData  )

privatepure virtual

Implemented in CWebServiceLibCurl, and CWebServiceWinInet.

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 39 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(szHostname, ServerPort, szServerFile, 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 113 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(szHostname, ServerPort, szServerFile, 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 71 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(szHostname, ServerPort, szServerFile, 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 151 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(szHostname, ServerPort, szServerFile, Data));
 
    if (strcmp(Response, "OK"))
    {
        ss << "When submitting the result, the server responded:" << endl << Response << endl;
        SSEXCEPTION;
    }
}

Member Data Documentation

m_TestID

PCHAR CWebService::m_TestID

private

Definition at line 11 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