/** 
 * @file test_llrefcounted
 * @brief unit tests for HttpStatus struct
 *
 * $LicenseInfo:firstyear=2012&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2012, Linden Research, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation;
 * version 2.1 of the License only.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
 * $/LicenseInfo$
 */

#ifndef TEST_HTTP_STATUS_H_
#define TEST_HTTP_STATUS_H_

#include "httpcommon.h"

#include <curl/curl.h>
#include <curl/multi.h>

using namespace LLCore;

namespace tut
{

struct HttpStatusTestData
{
	HttpStatusTestData()
		{}
};

typedef test_group<HttpStatusTestData> HttpStatusTestGroupType;
typedef HttpStatusTestGroupType::object HttpStatusTestObjectType;

HttpStatusTestGroupType HttpStatusTestGroup("HttpStatus Tests");

template <> template <>
void HttpStatusTestObjectType::test<1>()
{
	set_test_name("HttpStatus construction");
	
	// auto allocation fine for this
	HttpStatus status;
	status.mType = HttpStatus::EXT_CURL_EASY;
	status.mStatus = 0;
	
	ensure(bool(status));
	ensure(false == !(status));

	status.mType = HttpStatus::EXT_CURL_MULTI;
	status.mStatus = 0;

	ensure(bool(status));
	ensure(false == !(status));
	
	status.mType = HttpStatus::LLCORE;
	status.mStatus = HE_SUCCESS;
	
	ensure(bool(status));
	ensure(false == !(status));

	status.mType = HttpStatus::EXT_CURL_MULTI;
	status.mStatus = -1;

	ensure(false == bool(status));
	ensure(!(status));

	status.mType = HttpStatus::EXT_CURL_EASY;
	status.mStatus = CURLE_BAD_DOWNLOAD_RESUME;

	ensure(false == bool(status));
	ensure(!(status));
}


template <> template <>
void HttpStatusTestObjectType::test<2>()
{
	set_test_name("HttpStatus memory structure");
#if LL_WINDOWS
	skip("MAINT-2302: This frequently (though not always) fails on Windows.");
#endif

	// Require that an HttpStatus object can be trivially
	// returned as a function return value in registers.
	// One should fit in an int on all platforms.

	ensure(sizeof(HttpStatus) <= sizeof(int));
}


template <> template <>
void HttpStatusTestObjectType::test<3>()
{
	set_test_name("HttpStatus valid error string conversion");
#if LL_WINDOWS
	skip("MAINT-2302: This frequently (though not always) fails on Windows.");
#endif
	
	HttpStatus status;
	status.mType = HttpStatus::EXT_CURL_EASY;
	status.mStatus = 0;
	std::string msg = status.toString();
	// std::cout << "Result:  " << msg << std::endl;
	ensure(msg.empty());
	
	status.mType = HttpStatus::EXT_CURL_EASY;
	status.mStatus = CURLE_BAD_FUNCTION_ARGUMENT;
	msg = status.toString();
	// std::cout << "Result:  " << msg << std::endl;
	ensure(! msg.empty());

	status.mType = HttpStatus::EXT_CURL_MULTI;
	status.mStatus = CURLM_OUT_OF_MEMORY;
	msg = status.toString();
	// std::cout << "Result:  " << msg << std::endl;
	ensure(! msg.empty());

	status.mType = HttpStatus::LLCORE;
	status.mStatus = HE_SHUTTING_DOWN;
	msg = status.toString();
	// std::cout << "Result:  " << msg << std::endl;
	ensure(! msg.empty());
}


template <> template <>
void HttpStatusTestObjectType::test<4>()
{
	set_test_name("HttpStatus invalid error string conversion");
#if LL_WINDOWS
	skip("MAINT-2302: This frequently (though not always) fails on Windows.");
#endif
	
	HttpStatus status;
	status.mType = HttpStatus::EXT_CURL_EASY;
	status.mStatus = 32726;
	std::string msg = status.toString();
	// std::cout << "Result:  " << msg << std::endl;
	ensure(! msg.empty());
	
	status.mType = HttpStatus::EXT_CURL_MULTI;
	status.mStatus = -470;
	msg = status.toString();
	// std::cout << "Result:  " << msg << std::endl;
	ensure(! msg.empty());

	status.mType = HttpStatus::LLCORE;
	status.mStatus = 923;
	msg = status.toString();
	// std::cout << "Result:  " << msg << std::endl;
	ensure(! msg.empty());
}

template <> template <>
void HttpStatusTestObjectType::test<5>()
{
	set_test_name("HttpStatus equality/inequality testing");
#if LL_WINDOWS
	skip("MAINT-2302: This frequently (though not always) fails on Windows.");
#endif

	// Make certain equality/inequality tests do not pass
	// through the bool conversion.  Distinct successful
	// and error statuses should compare unequal.

	HttpStatus status1(HttpStatus::LLCORE, HE_SUCCESS);
	HttpStatus status2(HttpStatus::EXT_CURL_EASY, HE_SUCCESS);
	ensure(status1 != status2);

	status1.mType = HttpStatus::LLCORE;
	status1.mStatus = HE_REPLY_ERROR;
	status2.mType = HttpStatus::LLCORE;
	status2.mStatus= HE_SHUTTING_DOWN;
	ensure(status1 != status2);
}

template <> template <>
void HttpStatusTestObjectType::test<6>()
{
	set_test_name("HttpStatus basic HTTP status encoding");
#if LL_WINDOWS
	skip("MAINT-2302: This frequently (though not always) fails on Windows.");
#endif
	
	HttpStatus status;
	status.mType = 200;
	status.mStatus = HE_SUCCESS;
	std::string msg = status.toString();
	ensure(msg.empty());
	ensure(bool(status));

	// Normally a success but application says error
	status.mStatus = HE_REPLY_ERROR;
	msg = status.toString();
	ensure(! msg.empty());
	ensure(! bool(status));
	ensure(status.toULong() > 1UL);				// Biggish number, not a bool-to-ulong

	// Same statuses with distinct success/fail are distinct
	status.mType = 200;
	status.mStatus = HE_SUCCESS;
	HttpStatus status2(200, HE_REPLY_ERROR);
	ensure(status != status2);

	// Normally an error but application says okay
	status.mType = 406;
	status.mStatus = HE_SUCCESS;
	msg = status.toString();
	ensure(msg.empty());
	ensure(bool(status));

	// Different statuses but both successful are distinct
	status.mType = 200;
	status.mStatus = HE_SUCCESS;
	status2.mType = 201;
	status2.mStatus = HE_SUCCESS;
	ensure(status != status2);

	// Different statuses but both failed are distinct
	status.mType = 200;
	status.mStatus = HE_REPLY_ERROR;
	status2.mType = 201;
	status2.mStatus = HE_REPLY_ERROR;
	ensure(status != status2);
}

template <> template <>
void HttpStatusTestObjectType::test<7>()
{
	set_test_name("HttpStatus HTTP error text strings");
#if LL_WINDOWS
	skip("MAINT-2302: This frequently (though not always) fails on Windows.");
#endif

	HttpStatus status(100, HE_REPLY_ERROR);
	std::string msg(status.toString());
	ensure(! msg.empty());				// Should be something
	ensure(msg == "Continue");

	status.mStatus = HE_SUCCESS;
	msg = status.toString();
	ensure(msg.empty());				// Success is empty

	status.mType = 199;
	status.mStatus = HE_REPLY_ERROR;
	msg = status.toString();
	ensure(msg == "Unknown error");

	status.mType = 505;					// Last defined string
	status.mStatus = HE_REPLY_ERROR;
	msg = status.toString();
	ensure(msg == "HTTP Version not supported");

	status.mType = 506;					// One beyond
	status.mStatus = HE_REPLY_ERROR;
	msg = status.toString();
	ensure(msg == "Unknown error");

	status.mType = 999;					// Last HTTP status
	status.mStatus = HE_REPLY_ERROR;
	msg = status.toString();
	ensure(msg == "Unknown error");
}

} // end namespace tut

#endif	// TEST_HTTP_STATUS_H