simulations/dhtpir_simulation/library/base_client.py

from dht_common import compute_document_ID, SIZE_OF_HASH, SIZE_OF_IP_ADDRESS

class Base_Client(object):
    def __init__(self, DHT, knownNode, documentSize, numNodes=1):
        self.DHT = DHT
        self.knownNode = knownNode
        self.actualNodeEntry = self.DHT.access_node(self.knownNode)
        self.documentSize = documentSize

        self.numRounds = 0
        self.numMessagesSent = 0
        self.numMessagesRecv = 0
        self.numBytesSent = 0
        self.numBytesRecv = 0

        self.lastNumRounds = 0
        self.lastNumMessagesSent = 0
        self.lastNumMessagesRecv = 0
        self.lastNumBytesSent = 0
        self.lastNumBytesRecv = 0

    def test_iterative_search(self):
        if self.DHT.get_num_nodes() == 10:
            return self.__iterative_search__(b'\xb5\xe0\xf4\xd8\xe9\x1e\xf6i\xc4=^\xc2Y\xac\xdc\x88p\x8a+\x10t\x90\xa5\xc9\x1f\x98\xc61\xda\x7fH\x92') == 7
        else:
            print("Assumed testing conditions not met; no tests run.")
            return False

    # implements a simulation of iteratively searching the DHT
    # (captured as the dht_simulator, or here "DHT")
    def __iterative_search__(self, documentID):
        whichNode = self.knownNode
        flagFound = False
        while not flagFound:
            recv = self.DHT.access_node(whichNode).get_finger_table_val(documentID)
            self.numRounds += 1
            self.numMessagesSent += 1
            self.numMessagesRecv += 1
            self.numBytesSent += SIZE_OF_HASH
            self.numBytesRecv += SIZE_OF_HASH + SIZE_OF_IP_ADDRESS
            _, nextFind = recv
            if nextFind == -1:
                flagFound = True
            else:
                whichNode = nextFind

        return whichNode

    # Searches the DHT appropriately until it finds the correct node,
    # and inserts the document there
    def insert_file(self, document):
        documentID = compute_document_ID(document)
        whichNode = self.__iterative_search__(documentID)

        self.DHT.access_node(whichNode).insert()

        self.numRounds += 1
        self.numMessagesSent += 1
        self.numMessagesRecv += 1
        self.numBytesSent += self.documentSize
        self.numBytesRecv += SIZE_OF_HASH

        return documentID

    # Searches the DHT appropriately until it finds the correct node,
    # and retrieves the document there
    def retrieve_file(self, documentID):
        whichNode = self.__iterative_search__(documentID)

        self.DHT.access_node(whichNode).retrieve()
        self.numRounds += 1
        self.numMessagesSent += 1
        self.numMessagesRecv += 1
        self.numBytesSent += SIZE_OF_HASH
        self.numBytesRecv += self.documentSize

    def get_num_rounds(self):
        self.lastNumRounds = self.numRounds
        return self.numRounds

    def get_recent_num_rounds(self):
        retval = self.numRounds - self.lastNumRounds
        self.lastNumRounds = self.numRounds
        return retval

    def get_num_messages_sent(self):
        self.lastNumMessagesSent = self.numMessagesSent
        return self.numMessagesSent

    def get_recent_num_messages_sent(self):
        retval = self.numMessagesSent - self.lastNumMessagesSent
        self.lastNumMessagesSent = self.numMessagesSent
        return retval

    def get_num_messages_recv(self):
        self.lastNumMessagesRecv = self.numMessagesRecv
        return self.numMessagesRecv

    def get_recent_num_messages_recv(self):
        retval = self.numMessagesRecv - self.lastNumMessagesRecv
        self.lastNumMessagesRecv = self.numMessagesRecv
        return retval

    def get_num_bytes_sent(self):
        self.lastNumBytesSent = self.numBytesSent
        return self.numBytesSent

    def get_recent_num_bytes_sent(self):
        retval = self.numBytesSent - self.lastNumBytesSent
        self.lastNumBytesSent = self.numBytesSent
        return retval

    def get_num_bytes_recv(self):
        self.lastNumBytesRecv = self.numBytesRecv
        return self.numBytesRecv

    def get_recent_num_bytes_recv(self):
        retval = self.numBytesRecv - self.lastNumBytesRecv
        self.lastNumBytesRecv = self.numBytesRecv
        return retval


# Normally this file is a class to be used elsewhere,
# but if you run it directly it performs some rudimentary unit tests
# TODO: Add unit tests for size calculations
if __name__ == "__main__":
    from dht_simulator import DHT_Simulator
    from base_node import Base_Node
    
    NUM_NODES_IN_TEST = 10
    SIZE_OF_DOCUMENTS_IN_TEST = 1024

    # The 1 here isn't used at all within the simulator,
    # but it is customary to invoke DHT_Simulator with that value there for Base_Node
    testbed = DHT_Simulator(Base_Node, NUM_NODES_IN_TEST, SIZE_OF_DOCUMENTS_IN_TEST, 1)
    client = Base_Client(testbed, 0, SIZE_OF_DOCUMENTS_IN_TEST)
    assert client.test_iterative_search()
    print("Iterative search functioning correctly.")

    # A random file (not actually 1024 bytes, but that's not really a major concern;
    # the file size is a relic of an older, buggy implementation of generate_file())
    file = b'\xc3\xa7\x0c\xc3\x97!\xc3\xb2offy\x13\xc2\x81~\xc2\x9f\xc3\xb5\xc3\xa1\xc3\xb9C\xc2\x92f\xc2\x968\x01\xc2\x9183D\xc3\x84\xc3\xa9\xc3\x8e\t\x0f\xc2\xa1<\xc2\xad%G\xc3\x9dq\xc2\xb7\x1b\x7f\xc2\x82\xc3\x84\xc3\xb4\xc3\x81\x1c\xc3\x8dqgH(H\\C&\x14\xc2\x98\xc3\x93`\xc3\xbe\xc3\x95\xc3\xad\xc3\x8d\xc3\xb5\xc2\x8d.\xc2\x94D\x13IK\xc3\x9a\xc2\x8dS\xc3\x8b\xc2\xa7\xc2\xb6\xc2\x9d\x1fY\xc3\xbe\xc3\x85[\r\xc2\x85\x0e#\xc2\xb85B4\x15\xc3\xaf\xc2\x81_g\xc3\xb3;!|\xc3\xbc\xc3\xaa;\xc3\xbd(m\xc2\xbd\xc3\x96b\xc2\x88\xc3\x9d\xc2\x87N\xc3\xb9\xc3\xb5\xc3\xa54\xc2\xb6(\xc2\xa7\xc3\x950\xc3\x82\x1c\xc3\x95\xc2\x85\xc2\x983\xc3\xbfy\xc2\x89lQ\xc2\x8aN\xc2\xb0\x05\xc2\x9f\xc2\xac\xc2\xa3T+z.D1\xc2\xae\xc2\xae+\xc3\x86\xc2\xb3\xc2\xb0\xc3\x8d,\x04\xc2\x96\xc2\xa7\xc3\xba\xc2\xb4A\xc2\x95P"*\x1d\x0b\xc3\xbd!e\xc2\xaa\xc2\xa4UL\xc3\x84j\xc2\xb9>h\x01\x08\xc3\xb1\xc2\x85\xc3\x81\xc2\xb0b\xc2\x9b\x0fY\xc3\xb7V ^\xc3\xb0Z~r%\xc2\x9c\xc2\x91Q\x03+9(\x14\xc2\xa1`\x17\xc3\x8c\x18+\xc3\xb4\xc2\xb4Z&l9L\xc2\x94\xc2\xae\xc2\x83\x7fJt\xc2\xbbt\xc2\x89\n\xc2\xab\xc2\x94\xc2\x90I3\xc3\xa8\xc2\xbb\x14\xc3\x9ekM\x170}r\xc2\x9c>\xc3\xa2!\xc2\x8d\xc2\x91f\xc3\xb2\xc3\xae<v\x07\xc3\xa5V\xc2\x81\xc2\x9a\xc2\xbe\xc2\xb9\xc3\x91\xc3\x97\xc3\xb01\xc2\x82b\xc3\x82\xc3\x93\x04\xc2\xb3\xc2\xb3\x0bdtR\xc2\x80\x0e\xc2\x96\xc3\x8c\xc2\x82\xc2\xba\x15\xc3\x8aO\xc2\xae\xc2\x8a\xc2\x9b\xc2\x9d\xc3\xb4\xc2\xbc\xc2\x8d\xc2\xad\xc3\x94\xc3\xab\x1b]\xc2\xaf\xc3\xadd\xc2\xb2[\xc3\x83]\xc2\x9d\xc3\x91\x1b\xc2\x82\'\x15\xc2\xbe\xc2\xad\xc3\xaf\xc3\x80\xc2\x90\xc2\x9c<xOh;\xc2\xb3\xc3\xae\x05m5\x14\xc2\xacm\xc3\xba\xc3\xbd;R*\xc3\xae$\xc2\x9d\xc2\x8ff\x178mU\xc3\xba?\\o{\xc2\xa6\xc2\xa3+\xc3\x9c\xc2\xa5\xc2\xa4\xc2\xabFv\t\xc3\x9b>h\xc3\x82\xc2\x94\x11*\xc2\x97D`\xc3\xba\xc3\xa0\x17\xc3\xab!An\x7f\xc2\x89Rrh\xc3\x80\xc2\xaf\x1f*}j\xc2\xaf\xc2\x84\xc2\xa4\xc2\x92\xc2\x97\xc2\x83\xc2\x8cf\xc3\xb6\x1f\xc3\xadfb\xc2\xb1\xc2\xa3\xc3\x8f7\xc3\x82 \xc3\xbb\xc2\x84\xc3\xb0sh\xc2\x9d|\x7f\xc3\xbda\xc3\x84\xc2\x80\x08\xc3\x88\xc2\xa8mBi\xc2\xae)\x02}K\xc3\x9f\xc2\xa7\xc3\x95\xc3\x94[[D\n\xc2\x98AQH\xc2\xb9\xc2\xb3\xc3\xb3"\x08\xc2\x9f\xc3\x98\xc3\x91B[\xc2\x8b\xc2\x86xhMK\xc3\xbb\xc2\x83`\xc2\xa7\x02\xc3\x8a\xc3\x89\xc3\x8f\xc3\xb0\xc2\xa9\xc3\x99\xc3\x9b\xc2\xb2\xc3\x9a\xc3\xaa5\xc2\xb7T\xc2\x81\x0f\xc3\x90\x0c\xc3\xb3\x05\xc3\x8d\xc3\x85S\xc2\xbb\x17\xc3\x86\xc3\xb2\xc3\xa3\xc3\xb0V\x07\x0e\xc2\xb0y\xc2\x8e\xc2\xb1\xc3\x8f;\xc2\xb9Tc\xc3\xadM\xc2\xad\xc2\x98#\xc2\xb0\x01`\x1c\xc2\x84d'
    fileID = b'\xb5\xe0\xf4\xd8\xe9\x1e\xf6i\xc4=^\xc2Y\xac\xdc\x88p\x8a+\x10t\x90\xa5\xc9\x1f\x98\xc61\xda\x7fH\x92'
    client.insert_file(file)
    client.retrieve_file(fileID)
    print("Basic insertion/retrieval fires correctly.")