// Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).

// All rights reserved.

// This component and the accompanying materials are made available

// under the terms of "Eclipse Public License v1.0"

// which accompanies this distribution, and is available

// at the URL "http://www.eclipse.org/legal/epl-v10.html".

//

// Initial Contributors:

// Nokia Corporation - initial contribution.

//

// Contributors:

//

// Description:

// This contains ESock Test cases from section 27

// Integration test for DNS Query interface.

// Note: These tests try to make different queries to the external DNS, using network connection.

// This test requires a network connection and a properly configured DNS.

// See also appropriate ini file, which contains information about DNS requests for testing.

// 

//

// EPOC includes

#include <e32base.h>

#include <in_sock.h>

#include <dns_qry.h>

// Test system includes

#include "EsockTestSection27.h"

#ifdef _DEBUG

// Panic category for "absolutely impossible!" vanilla ASSERT()-type panics from this module

// (if it could happen through user error then you should give it an explicit, documented, category + code)

_LIT(KSpecAssert_ESockTestEsckTst, "ESockTestEsckTst");

#endif

const TInt  KMaxStrLen = 256;

// From ../../networking/inhook6/inc/dnd_err.h

const TInt KErrDndNameNotFound = -5120; 

//-------------------------------------------------------------------------------------------------------

/**

*   test preamble: open Host Resolver for using with implicit connection 

*/

TVerdict CTestRHostRslvQuery_27::doTestStepPreambleL (void)

    {

    TInt    ret;

    //-- open host resolver on UDP

    Logger().WriteFormat(_L("Opening host resolver on UDP using implicit connection scenario"));

    ret = iHostRslv.Open(iEsockSuite->iSocketServer, KAfInet, KProtocolInetUdp);

    if(ret != KErrNone)

        {

        Logger().WriteFormat(_L("iHostRslv.Open error code: %d"), ret);    

        return EFail;

        }

    return EPass;

    }

	/**

	*   test postamble: close Host Resolver

*/

TVerdict CTestRHostRslvQuery_27::doTestStepPostambleL(void)

    {

    Logger().WriteFormat(_L("Closing host resolver"));

    iHostRslv.Close();

    return EPass;

    }

//-------------------------------------------------------------------------------------------------------

/**

*   Read string from .ini file into 8-bit string descriptor

*

*   @param  aSectName section name descriptor.

*   @param  aKeyName  key name descriptor.  

*   @param  aStr      ref. to the 8-bit descriptor for the result string.  

*

*   @return ETrue on success.

*/

TBool   CTestRHostRslvQuery_27::GetIniFileString8(const TDesC &aSectName, const TDesC &aKeyName, TDes8& aStr)

    {

    TBuf<KMaxStrLen>    buff;

    TPtrC               buffPtr(buff);

    TBool bRes = GetStringFromConfig(aSectName, aKeyName, buffPtr);

    if(bRes)

        aStr.Copy(buffPtr);

    return bRes;

    }

	/**

	*   read IP address from .ini file, the address may have either IPv4 or IPv6 format.

	*

	*   @param  aSectName section name descriptor.

	*   @param  aKeyName  key name descriptor.  

	*   @param  aInetAddr will contain result.

	*

	*   @return ETrue on success

*/

TBool   CTestRHostRslvQuery_27::GetIniFileIpAddr(const TDesC &aSectName, const TDesC &aKeyName, TInetAddr& aInetAddr)

    {

    TBuf<KMaxStrLen>    buff;

    TPtrC               buffPtr(buff);

    TBool bRes = GetStringFromConfig(aSectName, aKeyName, buffPtr);

    if(!bRes) 

        return EFalse;

    return aInetAddr.Input(buffPtr) == KErrNone ? ETrue : EFalse;

    }

/**

*   Internal helper function to handle DND error codes

*   

*   @param  aErrCode    original code to process

*   @param  aEntryCount determines whether it was Query() 0 or QueryGetNext >0

*   @return possibly    modified new code.

*/

TInt CTestRHostRslvQuery_27::ProcessDndError(TInt aErrCode, TInt aEntryCount)

	{

    __ASSERT_DEBUG(aEntryCount >=0, User::Panic(KSpecAssert_ESockTestEsckTst, 1));

    if(aErrCode == KErrNone)

        return KErrNone;

    if(aErrCode == KErrNotFound || aErrCode == KErrDndNameNotFound)

		{

        if(aEntryCount == 0)

			{//-- no result at all for the first Query(). DNS may be down or just has no records

			//-- int his case test is inconsistent.

			return KErrNotFound;

			}

        else

			{//-- OK, no more resulsts for QueryGetNext(), normal situation

			return KErrNone;

			}

		}

	else //-- real error

		{    

		TBuf<KMaxStrLen>  tmpBuf;

		tmpBuf.Format(_L("! Query finished with error code:%d"), aErrCode);

		Logger().WriteFormat(tmpBuf);

		}

	return aErrCode;

	}

	/**

	*   Requests all RR of type 'A' for the given host and prints them out

	*

	*   @param      aHostName name of the nost

	*

	*   @return     standard error code

*/

TInt    CTestRHostRslvQuery_27::ListDnsRecordsA(const TDesC8& aHostName)

    {

    TInt    ret = KErrNone;

    TDnsQueryBuf      dnsQryBuf;

    TDnsRespABuf      dnsRespABuf;

    TBuf<KMaxStrLen>  addrBuf;

    TBuf<KMaxStrLen>  tmpBuf;

    dnsQryBuf().SetType(KDnsRRTypeA);

    dnsQryBuf().SetData(aHostName);

    tmpBuf.Copy(aHostName);

    addrBuf.Copy(_L("* Listing 'A' RRs for the host: "));

    addrBuf.Append(tmpBuf);

    Logger().WriteFormat(addrBuf);

    for(TInt recCnt=0; ;++recCnt)

        {

        //-- make an 'A' query. 

        if(recCnt == 0) 

            ret = iHostRslv.Query(dnsQryBuf, dnsRespABuf);  //-- make a query and get the result

        else

            ret = iHostRslv.QueryGetNext(dnsRespABuf);      //-- get the rest of the RRs

        const TDnsRespA& dnsRespA = dnsRespABuf();

        if(ret == KErrNone)

            {//-- everything is all right, print record data out

            tmpBuf.Format(_L("RR Type=%d, Class=%d, TTL=%d, Address="),dnsRespA.RRType(), dnsRespA.RRClass(), dnsRespA.RRTtl());

            dnsRespA.HostAddress().Output(addrBuf);

            tmpBuf.Append(addrBuf);

            Logger().WriteFormat(tmpBuf);

            }

        else //-- real error

            {

			ret = ProcessDndError(ret, recCnt);

			break;

            }

        }// for

    Logger().WriteFormat(_L(""));

    return ret;

    }

	/**

	*   Requests all RR of type 'SRV' for the given host and prints them out

	*

	*   @param      aQuery  a query string that contains desired service, protocol and host definition

	*

	*   @return     standard error code

*/

TInt    CTestRHostRslvQuery_27::ListDnsRecordsSRV(const TDesC8& aQuery)

    {

    TInt    ret = KErrNone;

    TDnsQueryBuf      dnsQryBuf;

    TDnsRespSRVBuf    dnsRespSRVBuf;

    TBuf<KMaxStrLen>  targetBuf;

    TBuf<KMaxStrLen>  tmpBuf;

    dnsQryBuf().SetType(KDnsRRTypeSRV);

    dnsQryBuf().SetData(aQuery);

    tmpBuf.Copy(aQuery);

    targetBuf.Copy(_L("* Listing 'SRV' RRs according to the query: "));

    targetBuf.Append(tmpBuf);

    Logger().WriteFormat(targetBuf);

    for(TInt recCnt =0; ;++recCnt)

        {

        //-- make an 'SRV' query. 

        if(recCnt == 0) 

            ret = iHostRslv.Query(dnsQryBuf, dnsRespSRVBuf);  //-- make a query and get the result

        else

            ret = iHostRslv.QueryGetNext(dnsRespSRVBuf);      //-- get the rest of the RRs

        const TDnsRespSRV& dnsRespSRV = dnsRespSRVBuf();

        if(ret == KErrNone)

            {//-- everything is all right, print record data out

            tmpBuf.Format(_L("RR Type=%d, Class=%d, TTL=%d, target="),dnsRespSRV.RRType(), dnsRespSRV.RRClass(), dnsRespSRV.RRTtl());

            targetBuf.Copy(dnsRespSRV.Target());

            tmpBuf.Append(targetBuf);

            Logger().WriteFormat(tmpBuf);

            }

        else //-- real error

            {

			ret = ProcessDndError(ret, recCnt);

			break;

            }

        }// for

    Logger().WriteFormat(_L(""));

    return ret;

    }

	/**

	*   Requests all RR of type 'PTR' for the given IP address and prints them out

	*

	*   @param      aQuery  string containing 'PTR' query, pointer address representation, 

	*                       e.g "3.253.253.192.in-addr.arpa"  to resolve 192.253.253.2 address.

	*

	*   @return     standard error code

*/

TInt    CTestRHostRslvQuery_27::ListDnsRecordsPTR(const TDesC8& aQuery)

    {

    TInt    ret = KErrNone;

    TDnsQueryBuf      dnsQryBuf;

    TDnsRespPTRBuf    dnsRespPTRBuf;

    TBuf<KMaxStrLen>  targetBuf;

    TBuf<KMaxStrLen>  tmpBuf;

    dnsQryBuf().SetType(KDnsRRTypePTR);

    dnsQryBuf().SetData(aQuery);

    targetBuf.Copy(_L("* Listing 'PTR' RRs according to the address query: "));

    tmpBuf.Copy(aQuery);

    targetBuf.Append(tmpBuf);

    Logger().WriteFormat(targetBuf);

    for(TInt recCnt =0; ;++recCnt)

        {

        //-- make an 'PTR' query. 

        if(recCnt == 0) 

            ret = iHostRslv.Query(dnsQryBuf, dnsRespPTRBuf);  //-- make a query and get the result

        else

            ret = iHostRslv.QueryGetNext(dnsRespPTRBuf);      //-- get the rest of the RRs

        const TDnsRespPTR& dnsRespPTR = dnsRespPTRBuf();

        if(ret == KErrNone)

            {//-- everything is all right, print record data out

            tmpBuf.Format(_L("RR Type=%d, Class=%d, TTL=%d, host name="),dnsRespPTR.RRType(), dnsRespPTR.RRClass(), dnsRespPTR.RRTtl());

            targetBuf.Copy(dnsRespPTR.HostName());

            tmpBuf.Append(targetBuf);

            Logger().WriteFormat(tmpBuf);

            }

        else //-- real error

            {

			ret = ProcessDndError(ret, recCnt);

			break;

            }

        }// for

    Logger().WriteFormat(_L(""));

    return ret;

    }

	/**

	*   Requests all RR of type 'NAPTR' for the given host and prints them out

	*

	*   @param      aHostName name of the nost

	*

	*   @return     standard error code

*/

TInt    CTestRHostRslvQuery_27::ListDnsRecordsNAPTR(const TDesC8& aHostName)

    {

    TInt    ret = KErrNone;

    TDnsQueryBuf      dnsQryBuf;

    TDnsRespNAPTRBuf  dnsRespNAPTRBuf;

    TBuf<KMaxStrLen>  targetBuf;

    TBuf<KMaxStrLen>  tmpBuf;

    dnsQryBuf().SetType(KDnsRRTypeNAPTR);

    dnsQryBuf().SetData(aHostName);

    targetBuf.Copy(_L("* Listing 'NAPTR' RRs for host: "));

    tmpBuf.Copy(aHostName);

    targetBuf.Append(tmpBuf);

    Logger().WriteFormat(targetBuf);

    for(TInt recCnt =0; ;++recCnt)

        {

        //-- make an 'SRV' query. 

        if(recCnt == 0) 

            ret = iHostRslv.Query(dnsQryBuf, dnsRespNAPTRBuf);  //-- make a query and get the result

        else

            ret = iHostRslv.QueryGetNext(dnsRespNAPTRBuf);      //-- get the rest of the RRs

        const TDnsRespNAPTR& dnsRespNAPTR = dnsRespNAPTRBuf();

        if(ret == KErrNone)

            {//-- everything is all right, print record data out

            tmpBuf.Format(_L("RR Type=%d, Class=%d, TTL=%d, Order=%d, Pref=%d, Flags="),

                dnsRespNAPTR.RRType(), dnsRespNAPTR.RRClass(), dnsRespNAPTR.RRTtl(), dnsRespNAPTR.Order(), dnsRespNAPTR.Pref());

            targetBuf.Copy(dnsRespNAPTR.Flags());

            tmpBuf.Append(targetBuf);

            Logger().WriteFormat(tmpBuf);

            tmpBuf.Copy(_L("Service: "));

            targetBuf.Copy(dnsRespNAPTR.Service());

            tmpBuf.Append(targetBuf);

            tmpBuf.Append(_L(", Regexp: "));

            targetBuf.Copy(dnsRespNAPTR.Regexp());

            tmpBuf.Append(targetBuf);

            tmpBuf.Append(_L(", Replacement: "));

            targetBuf.Copy(dnsRespNAPTR.Replacement());

            tmpBuf.Append(targetBuf);

            Logger().WriteFormat(tmpBuf);

            }

        else //-- real error

            {

			ret = ProcessDndError(ret, recCnt);

			break;

            }

        }// for

    Logger().WriteFormat(_L(""));

    return ret;

    }

	/**

	*   Requests all RR of type 'MX' for the given host and prints them out

	*

	*   @param      aHostName name of the nost

	*

	*   @return     standard error code

*/

TInt    CTestRHostRslvQuery_27::ListDnsRecordsMX(const TDesC8& aHostName)

    {

    TInt    ret = KErrNone;

    TDnsQueryBuf      dnsQryBuf;

    TDnsRespMXBuf     dnsRespMXBuf;

    TBuf<KMaxStrLen>  addrBuf;

    TBuf<KMaxStrLen>  tmpBuf;

    dnsQryBuf().SetType(KDnsRRTypeMX);

    dnsQryBuf().SetData(aHostName);

    tmpBuf.Copy(aHostName);

    addrBuf.Copy(_L("* Listing 'MX' RRs for the host: "));

    addrBuf.Append(tmpBuf);

    Logger().WriteFormat(addrBuf);

    for(TInt recCnt=0; ;++recCnt)

        {

        //-- make an 'MX' query. 

        if(recCnt == 0) 

            ret = iHostRslv.Query(dnsQryBuf, dnsRespMXBuf);  //-- make a query and get the result

        else

            ret = iHostRslv.QueryGetNext(dnsRespMXBuf);      //-- get the rest of the RRs

        const TDnsRespMX& dnsRespMX = dnsRespMXBuf();

        if(ret == KErrNone)

            {//-- everything is all right, print record data out

            tmpBuf.Format(_L("RR Type=%d, Class=%d, TTL=%d, Pref=%d, HostName="),dnsRespMX.RRType(), dnsRespMX.RRClass(), dnsRespMX.RRTtl(), dnsRespMX.Pref());

            addrBuf.Copy(dnsRespMX.HostName());

            tmpBuf.Append(addrBuf);

            Logger().WriteFormat(tmpBuf);

            }

        else //-- real error

            {

			ret = ProcessDndError(ret, recCnt);

			break;

            }

        }// for

    Logger().WriteFormat(_L(""));

    return ret;

    }

	/**

	*   Requests all RR of type 'AAAA' for the given host and prints them out

	*

	*   @param      aHostName name of the nost

	*

	*   @return     standard error code

*/

TInt    CTestRHostRslvQuery_27::ListDnsRecordsAAAA(const TDesC8& aHostName)

    {

    TInt    ret = KErrNone;

    TDnsQueryBuf      dnsQryBuf;

    TDnsRespAAAABuf   dnsRespAAAABuf;

    TBuf<KMaxStrLen>  addrBuf;

    TBuf<KMaxStrLen>  tmpBuf;

    dnsQryBuf().SetType(KDnsRRTypeAAAA);

    dnsQryBuf().SetData(aHostName);

    tmpBuf.Copy(aHostName);

    addrBuf.Copy(_L("* Listing 'AAAA' RRs for the host: "));

    addrBuf.Append(tmpBuf);

    Logger().WriteFormat(addrBuf);

    for(TInt recCnt =0; ;++recCnt)

        {

        //-- make an 'AAAA' query. 

        if(recCnt == 0) 

            ret = iHostRslv.Query(dnsQryBuf, dnsRespAAAABuf);  //-- make a query and get the result

        else

            ret = iHostRslv.QueryGetNext(dnsRespAAAABuf);      //-- get the rest of the RRs

        const TDnsRespAAAA& dnsRespAAAA = dnsRespAAAABuf();

        if(ret == KErrNone)

            {//-- everything is all right, print record data out

            tmpBuf.Format(_L("RR Type=%d, Class=%d, TTL=%d, Address="),dnsRespAAAA.RRType(), dnsRespAAAA.RRClass(), dnsRespAAAA.RRTtl());

            dnsRespAAAA.HostAddress().Output(addrBuf);

            //-- remove scope modifier from the end of address representation, it may look like "%1" and confuses 'Log'

            TInt nPos = addrBuf.Locate('%');

            if(nPos >= 0)

                addrBuf.SetLength(nPos);

            tmpBuf.Append(addrBuf);

            Logger().WriteFormat(tmpBuf);

            }

        else //-- real error

            {

			ret = ProcessDndError(ret, recCnt);

			break;

            }

        }// for

    Logger().WriteFormat(_L(""));

    return ret;

    }

	/**

	* Internal helper function for calling appropriate method of listing a certain type of RR

	*

	*@param     apFunct pointer to the one of the ListDnsRecords* methods to be called. 

	*@return    a number of test substeps performed and passed.

	*@leave     KErrNotFound if some error occured

*/

TInt    CTestRHostRslvQuery_27::ListDnsRecordsL(TpListRRFunct apFunct)