def testLookupFromStatusObject(self):
"""Test that the code from an actual status object works properly"""
with patch.object(requests, 'get') as mockMethod:
mockMethod.return_value.status_code = 200
mockMethod.return_value.text = """
<nutcstatus>
<!--all temperatures are displayed in tenths F, regardless of setting of unit-->
<!--all temperatures sent by browser to unit should be in F. you can send-->
<!--tenths F with a decimal place, ex: 123.5-->
<OUTPUT_PERCENT>100</OUTPUT_PERCENT>
<TIMER_CURR>00:00:00</TIMER_CURR>
<COOK_TEMP>3343</COOK_TEMP>
<FOOD1_TEMP>823</FOOD1_TEMP>
<FOOD2_TEMP>OPEN</FOOD2_TEMP>
<FOOD3_TEMP>OPEN</FOOD3_TEMP>
<COOK_STATUS>0</COOK_STATUS>
<FOOD1_STATUS>0</FOOD1_STATUS>
<FOOD2_STATUS>4</FOOD2_STATUS>
<FOOD3_STATUS>4</FOOD3_STATUS>
<TIMER_STATUS>0</TIMER_STATUS>
<DEG_UNITS>1</DEG_UNITS>
<COOK_CYCTIME>6</COOK_CYCTIME>
<COOK_PROPBAND>500</COOK_PROPBAND>
<COOK_RAMP>0</COOK_RAMP>
</nutcstatus>"""
cqi = CyberQInterface("127.0.0.1")
status = cqi.getStatus()
self.assertEqual(cqi.statusLookup(status.FOOD1_STATUS), "OK")
def testBadParameters(self):
"""Test parameters with 3 bad parameters"""
cqi = CyberQInterface("127.0.0.1")
assert len(
cqi._validateParameters({
"COK_NAME": 1,
"COOK_SET": 1,
"FOOD1_NAME": 1,
"FOOD1_SET": 1,
"FOOD2_NAME": 1,
"FOOD2_SET": 1,
"FOOD3_NAME": 1,
"FOOD3_SET": 1,
"_COOK_TIMER": 1,
"COOK_TIMER": 1,
"COOKHOLD": 1,
"TIEOUT_ACTION": 1,
"ALARMDEV": 1,
"COOK_RAMP": 1,
"OPENDETECT": 1,
"CYCTIME": 1,
"PROPBAND": 1,
"MNU_SCROLLING": 1,
"LCD_BACKLIGHT": 1,
"LCD_CONTRAST": 1,
"DEG_UNITS": 1,
"ALARM_BEEPS": 1,
"KEY_BEEPS": 1
})) == 3
def testTemperatureLookups(self):
"""Test that all known temperature codes work"""
cqi = CyberQInterface("127.0.0.1")
temperatureCodes = ["CELSIUS", "FAHRENHEIT"]
for code in range(0, len(temperatureCodes) - 1):
self.assertEqual(cqi.temperatureLookup(code),
temperatureCodes[code])
def testStatusLookups(self):
"""Test that all known status codes work"""
cqi = CyberQInterface("127.0.0.1")
statusCodes = ["OK", "HIGH", "LOW", "DONE", "ERROR", "HOLD", "ALARM",
"SHUTDOWN"]
for code in range (0, len(statusCodes)-1):
self.assertEqual(cqi.statusLookup(code), statusCodes[code])
def testTemperatureLookups(self):
"""Test that all known temperature codes work"""
cqi = CyberQInterface("127.0.0.1")
temperatureCodes = ["CELSIUS", "FAHRENHEIT"]
for code in range (0, len(temperatureCodes)-1):
self.assertEqual(cqi.temperatureLookup(code),
temperatureCodes[code])
def testLookupFromStatusObject(self):
"""Test that the code from an actual status object works properly"""
with patch.object(requests, 'get') as mockMethod:
mockMethod.return_value.status_code = 200
mockMethod.return_value.text = """
<nutcstatus>
<!--all temperatures are displayed in tenths F, regardless of setting of unit-->
<!--all temperatures sent by browser to unit should be in F. you can send-->
<!--tenths F with a decimal place, ex: 123.5-->
<OUTPUT_PERCENT>100</OUTPUT_PERCENT>
<TIMER_CURR>00:00:00</TIMER_CURR>
<COOK_TEMP>3343</COOK_TEMP>
<FOOD1_TEMP>823</FOOD1_TEMP>
<FOOD2_TEMP>OPEN</FOOD2_TEMP>
<FOOD3_TEMP>OPEN</FOOD3_TEMP>
<COOK_STATUS>0</COOK_STATUS>
<FOOD1_STATUS>0</FOOD1_STATUS>
<FOOD2_STATUS>4</FOOD2_STATUS>
<FOOD3_STATUS>4</FOOD3_STATUS>
<TIMER_STATUS>0</TIMER_STATUS>
<DEG_UNITS>1</DEG_UNITS>
<COOK_CYCTIME>6</COOK_CYCTIME>
<COOK_PROPBAND>500</COOK_PROPBAND>
<COOK_RAMP>0</COOK_RAMP>
</nutcstatus>"""
cqi = CyberQInterface("127.0.0.1")
status = cqi.getStatus()
self.assertEqual(cqi.statusLookup(status.FOOD1_STATUS),"OK")
def testAllParameters(self):
"""Test the full set of parameters are correct"""
cqi = CyberQInterface("127.0.0.1")
assert cqi._validateParameters({
"COOK_NAME": 1,
"COOK_SET": 1,
"FOOD1_NAME": 1,
"FOOD1_SET": 1,
"FOOD2_NAME": 1,
"FOOD2_SET": 1,
"FOOD3_NAME": 1,
"FOOD3_SET": 1,
"_COOK_TIMER": 1,
"COOK_TIMER": 1,
"COOKHOLD": 1,
"TIMEOUT_ACTION": 1,
"ALARMDEV": 1,
"COOK_RAMP": 1,
"OPENDETECT": 1,
"CYCTIME": 1,
"PROPBAND": 1,
"MENU_SCROLLING": 1,
"LCD_BACKLIGHT": 1,
"LCD_CONTRAST": 1,
"DEG_UNITS": 1,
"ALARM_BEEPS": 1,
"KEY_BEEPS": 1
}) == {}
def testStatusLookups(self):
"""Test that all known status codes work"""
cqi = CyberQInterface("127.0.0.1")
statusCodes = [
"OK", "HIGH", "LOW", "DONE", "ERROR", "HOLD", "ALARM", "SHUTDOWN"
]
for code in range(0, len(statusCodes) - 1):
self.assertEqual(cqi.statusLookup(code), statusCodes[code])
def testInvalidReturnCode(self):
"""
Test that the proper exception is thrown if the server returns bad
status code
"""
with patch.object(requests, 'get') as mockMethod:
with self.assertRaises(ResponseHTTPException):
cqi = CyberQInterface("127.0.0.1")
mockMethod.return_value.status_code = 500
cqi.getConfigXML()
def testSendUpdate(self):
"""
Test the ability to send a message to the CyberQ with good parameters
"""
with patch.object(requests, 'post') as mockMethod:
mockMethod.return_value.status_code = 200
cqi = CyberQInterface("127.0.0.1")
self.assertEqual(cqi.sendUpdate({'FOOD1_NAME' : "Tri-Tip Roast",
'FOOD1_SET': '140',
'COOK_SET' : '300'}),True)
def testSendUpdateWithBadParameters(self):
"""
Test the ability to send a message to the CyberQ with bad parameters
"""
with patch.object(requests, 'post') as mockMethod:
with self.assertRaises(ParameterValidationException):
mockMethod.return_value.status_code = 200
cqi = CyberQInterface("127.0.0.1")
cqi.sendUpdate({'FOOD1_NME' : "Tri-Tip Roast",
'FOOD1_SET': '140', 'COOK_SET' : '300'})
def testInvalidReturnCode(self):
"""
Test that the proper exception is thrown if the server returns bad
status code
"""
with patch.object(requests, 'get') as mockMethod:
with self.assertRaises(ResponseHTTPException):
cqi = CyberQInterface("127.0.0.1")
mockMethod.return_value.status_code = 500
cqi.getConfigXML()
def testSendUpdateWithBadResponse(self):
"""
Test the ability to send a message to the CyberQ with good parameters
but a bad response
"""
with patch.object(requests, 'post') as mockMethod:
with self.assertRaises(ResponseHTTPException):
mockMethod.return_value.status_code = 500
cqi = CyberQInterface("127.0.0.1")
cqi.sendUpdate({'FOOD1_NAME' : "Tri-Tip Roast",
'FOOD1_SET': '140', 'COOK_SET' : '300'})
def testSendUpdateWithBadParameters(self):
"""
Test the ability to send a message to the CyberQ with bad parameters
"""
with patch.object(requests, 'post') as mockMethod:
with self.assertRaises(ParameterValidationException):
mockMethod.return_value.status_code = 200
cqi = CyberQInterface("127.0.0.1")
cqi.sendUpdate({
'FOOD1_NME': "Tri-Tip Roast",
'FOOD1_SET': '140',
'COOK_SET': '300'
})
def testSendUpdate(self):
"""
Test the ability to send a message to the CyberQ with good parameters
"""
with patch.object(requests, 'post') as mockMethod:
mockMethod.return_value.status_code = 200
cqi = CyberQInterface("127.0.0.1")
self.assertEqual(
cqi.sendUpdate({
'FOOD1_NAME': "Tri-Tip Roast",
'FOOD1_SET': '140',
'COOK_SET': '300'
}), True)
def testSendUpdateWithBadResponse(self):
"""
Test the ability to send a message to the CyberQ with good parameters
but a bad response
"""
with patch.object(requests, 'post') as mockMethod:
with self.assertRaises(ResponseHTTPException):
mockMethod.return_value.status_code = 500
cqi = CyberQInterface("127.0.0.1")
cqi.sendUpdate({
'FOOD1_NAME': "Tri-Tip Roast",
'FOOD1_SET': '140',
'COOK_SET': '300'
})
def testAllParameters(self):
"""Test the full set of parameters are correct"""
cqi = CyberQInterface("127.0.0.1")
assert cqi._validateParameters( {"COOK_NAME": 1, "COOK_SET": 1,
"FOOD1_NAME": 1, "FOOD1_SET": 1,
"FOOD2_NAME": 1, "FOOD2_SET": 1,
"FOOD3_NAME": 1, "FOOD3_SET": 1,
"_COOK_TIMER": 1, "COOK_TIMER": 1,
"COOKHOLD": 1, "TIMEOUT_ACTION": 1,
"ALARMDEV": 1, "COOK_RAMP": 1,
"OPENDETECT": 1, "CYCTIME": 1,
"PROPBAND": 1, "MENU_SCROLLING": 1,
"LCD_BACKLIGHT": 1, "LCD_CONTRAST": 1,
"DEG_UNITS": 1, "ALARM_BEEPS": 1,
"KEY_BEEPS": 1}) == {}
def testValidReturnCode(self):
"""Test that a 200 code returns a string"""
with patch.object(requests, 'get') as mockMethod:
mockMethod.return_value.status_code = 200
mockMethod.return_value.text = "testcase"
xml = CyberQInterface("127.0.0.1").getConfigXML()
self.assertEqual(xml, "testcase")
def testBadParameters(self):
"""Test parameters with 3 bad parameters"""
cqi = CyberQInterface("127.0.0.1")
assert len(cqi._validateParameters( {"COK_NAME": 1, "COOK_SET": 1,
"FOOD1_NAME": 1, "FOOD1_SET": 1,
"FOOD2_NAME": 1, "FOOD2_SET": 1,
"FOOD3_NAME": 1, "FOOD3_SET": 1,
"_COOK_TIMER": 1, "COOK_TIMER": 1,
"COOKHOLD": 1, "TIEOUT_ACTION": 1,
"ALARMDEV": 1, "COOK_RAMP": 1,
"OPENDETECT": 1, "CYCTIME": 1,
"PROPBAND": 1, "MNU_SCROLLING": 1,
"LCD_BACKLIGHT": 1,
"LCD_CONTRAST": 1, "DEG_UNITS": 1,
"ALARM_BEEPS": 1,
"KEY_BEEPS": 1})) == 3
def testGetStatusWithBadXML(self):
"""Test that the correct Object is returned"""
with patch.object(requests, 'get') as mockMethod:
with self.assertRaises(ResponseValidationException):
mockMethod.return_value.status_code = 200
mockMethod.return_value.text = """
<nutcstatus>
<!--all temperatures are displayed in tenths F, regardless of setting of unit-->
<!--all temperatures sent by browser to unit should be in F. you can send-->
<!--tenths F with a decimal place, ex: 123.5-->
<OUTPUT_PERCENT>100</OUTPUT_PERCENT>
<TIMER_CURR>00:00:00</TIMER_CURR>
<COOK_TEMP>3343</COOK_TEMP>
<FOOD1_TEMP>823</FOOD1_TEMP>
<FOOD2_TEM2_TEMP>
<FOOD3_TEMP>OPEN</FOOD3_TEMP>
<COOK_STATUS>0</COOKTUS>
<FOOD1_STATUS>0</FOOD1_STATUS>
<FOOD2_STATUS>4</FOOD2_STATUS>
<FOOD3_STATUS>4</FOOD3_STATUS>
<TIMER_STATUS>0</TIMER_STATUS>
<DEG_UNITS>1</DEG_UNITS>
<COOK_CYCTIME>6</COOK_CYCTIME>
<COOK_PROPBAND>500</COOK_PROPBAND>
<COOK_RAMP>0</COOK_RAMP>
</nutcstatus>"""
CyberQInterface("127.0.0.1").getStatus()
def testGetAll(self):
"""Test that the All Object is returned"""
with patch.object(requests, 'get') as mockMethod:
with self.assertRaises(AttributeError):
mockMethod.return_value.status_code = 200
mockMethod.return_value.text = """
<nutcallstatus>
<!--this is similar to status.xml, but with more values-->
<!--all temperatures are displayed in tenths F, regardless of setting of unit-->
<!--all temperatures sent by browser to unit should be in F. you can send-->
<!--tenths F with a decimal place, ex: 123.5-->
<COOK>
<COOK_NAME>Big Green Egg</COOK_NAME>
<COOK_TEMP>3216</COOK_TEMP>
<COOK_SET>4000</COOK_SET>
<COOK_STATUS>0</COOK_STATUS>
</COOK>
<FOOD1>
<FOOD1_NAME>Chicken Quarters</FOOD1_NAME>
<FOOD1_TEMP>1482</FOOD1_TEMP>
<FOOD1_SET>1750</FOOD1_SET>
<FOOD1_STATUS>0</FOOD1_STATUS>
</FOOD1>
<FOOD2>
<FOOD2_NAME>Food2</FOOD2_NAME>
<FOOD2_TEMP>OPEN</FOOD2_TEMP>
<FOOD2_SET>1000</FOOD2_SET>
<FOOD2_STATUS>4</FOOD2_STATUS>
</FOOD2>
<FOOD3>
<FOOD3_NAME>Food3</FOOD3_NAME>
<FOOD3_TEMP>OPEN</FOOD3_TEMP>
<FOOD3_SET>1000</FOOD3_SET>
<FOOD3_STATUS>4</FOOD3_STATUS>
</FOOD3>
<OUTPUT_PERCENT>100</OUTPUT_PERCENT>
<TIMER_CURR>00:00:00</TIMER_CURR>
<TIMER_STATUS>0</TIMER_STATUS>
<DEG_UNITS>1</DEG_UNITS>
<COOK_CYCTIME>6</COOK_CYCTIME>
<COOK_PROPBAND>500</COOK_PROPBAND>
<COOK_RAMP>0</COOK_RAMP>
</nutcallstatus>
"""
allObj = CyberQInterface("127.0.0.1").getAll()
self.assertNotEqual(allObj.CONTROL.OPENDETECT, 1)
def testInvalidCodeNumber(self):
"""Test that an index out of range is handled"""
with self.assertRaises(LookupException):
cqi = CyberQInterface("127.0.0.1")
cqi._lookup("temperature", 4)
def testBadTableName(self):
"""Test that an unknown table produces a known exception"""
with self.assertRaises(LookupException):
cqi = CyberQInterface("127.0.0.1")
cqi._lookup("badtable", 0)
def testGetConfig(self):
"""Test that the config Object is returned"""
with patch.object(requests, 'get') as mockMethod:
mockMethod.return_value.status_code = 200
mockMethod.return_value.text = """
<nutcallstatus>
<!--this is similar to all.xml, but with more values-->
<!--all temperatures are displayed in tenths F, regardless of setting of unit-->
<!--all temperatures sent by browser to unit should be in F. you can send-->
<!--tenths F with a decimal place, ex: 123.5-->
<COOK>
<COOK_NAME>Big Green Egg</COOK_NAME>
<COOK_TEMP>3220</COOK_TEMP>
<COOK_SET>4000</COOK_SET>
<COOK_STATUS>0</COOK_STATUS>
</COOK>
<FOOD1>
<FOOD1_NAME>Chicken Quarters</FOOD1_NAME>
<FOOD1_TEMP>1493</FOOD1_TEMP>
<FOOD1_SET>1750</FOOD1_SET>
<FOOD1_STATUS>0</FOOD1_STATUS>
</FOOD1>
<FOOD2>
<FOOD2_NAME>Food2</FOOD2_NAME>
<FOOD2_TEMP>OPEN</FOOD2_TEMP>
<FOOD2_SET>1000</FOOD2_SET>
<FOOD2_STATUS>4</FOOD2_STATUS>
</FOOD2>
<FOOD3>
<FOOD3_NAME>Food3</FOOD3_NAME>
<FOOD3_TEMP>OPEN</FOOD3_TEMP>
<FOOD3_SET>1000</FOOD3_SET>
<FOOD3_STATUS>4</FOOD3_STATUS>
</FOOD3>
<OUTPUT_PERCENT>100</OUTPUT_PERCENT>
<TIMER_CURR>00:00:00</TIMER_CURR>
<TIMER_STATUS>0</TIMER_STATUS>
<SYSTEM>
<MENU_SCROLLING>1</MENU_SCROLLING>
<LCD_BACKLIGHT>47</LCD_BACKLIGHT>
<LCD_CONTRAST>10</LCD_CONTRAST>
<DEG_UNITS>1</DEG_UNITS>
<ALARM_BEEPS>0</ALARM_BEEPS>
<KEY_BEEPS>0</KEY_BEEPS>
</SYSTEM>
<CONTROL>
<TIMEOUT_ACTION>0</TIMEOUT_ACTION>
<COOKHOLD>2000</COOKHOLD>
<ALARMDEV>500</ALARMDEV>
<COOK_RAMP>0</COOK_RAMP>
<OPENDETECT>1</OPENDETECT>
<CYCTIME>6</CYCTIME>
<PROPBAND>500</PROPBAND>
</CONTROL>
<WIFI>
<IP>10.0.1.30</IP>
<NM>255.255.255.0</NM>
<GW>10.0.1.1</GW>
<DNS>10.0.1.1</DNS>
<WIFIMODE>0</WIFIMODE>
<DHCP>0</DHCP>
<SSID>Wireless Network</SSID>
<WIFI_ENC>6</WIFI_ENC>
<WIFI_KEY>SsecretKey</WIFI_KEY>
<HTTP_PORT>80</HTTP_PORT>
</WIFI>
<SMTP>
<SMTP_HOST>smtp.hostname.com</SMTP_HOST>
<SMTP_PORT>0</SMTP_PORT>
<SMTP_USER></SMTP_USER>
<SMTP_PWD></SMTP_PWD>
<SMTP_TO>[email protected]</SMTP_TO>
<SMTP_FROM>[email protected]</SMTP_FROM>
<SMTP_SUBJ>Temperature Controller Status E-Mail</SMTP_SUBJ>
<SMTP_ALERT>0</SMTP_ALERT>
</SMTP>
</nutcallstatus>
"""
configObj = CyberQInterface("127.0.0.1").getConfig()
self.assertEqual(configObj.CONTROL.OPENDETECT, 1)
def testRampLookups(self):
"""Test that all known ramp codes work"""
cqi = CyberQInterface("127.0.0.1")
rampCodes = ["OFF", "FOOD1", "FOOD2", "FOOD3"]
for code in range(0, len(rampCodes) - 1):
self.assertEqual(cqi.rampLookup(code), rampCodes[code])
def testRampLookups(self):
"""Test that all known ramp codes work"""
cqi = CyberQInterface("127.0.0.1")
rampCodes = ["OFF", "FOOD1", "FOOD2", "FOOD3"]
for code in range (0, len(rampCodes)-1):
self.assertEqual(cqi.rampLookup(code), rampCodes[code])
def testBadTableName(self):
"""Test that an unknown table produces a known exception"""
with self.assertRaises(LookupException):
cqi = CyberQInterface("127.0.0.1")
cqi._lookup("badtable", 0)
def testInvalidCodeNumber(self):
"""Test that an index out of range is handled"""
with self.assertRaises(LookupException):
cqi = CyberQInterface("127.0.0.1")
cqi._lookup("temperature", 4)
def testInitWithHeaders(self):
"""Test supplying custom headers"""
cqi = CyberQInterface("localhost", {"Test-Header": "Test"})
self.assertEqual(cqi.headers["Test-Header"], "Test")
#!/usr/bin/env python2.7
# Verify CyberQInterface is installed correctly and can talk
# the CyberQ protocol
#
# This requires the pitmon server to be running and uses the
# sample files from the /static directory. This allows development
# without needing a live CyberQ device.
#
# From git project root run:
#
# $ PYTHONPATH=. python test/test.py
from cyberqinterface.cyberqinterface import CyberQInterface
cyberq = CyberQInterface('192.168.142.155')
print "== status.xml =="
result = cyberq.getStatus()
print "Output percent:", result.OUTPUT_PERCENT
print "Cook temp:", float(result.COOK_TEMP)/10
print "Food1 temp:", float(result.FOOD1_TEMP)/10
print "\n== all.xml =="
result = cyberq.getAll()
print "Output percent:", result.OUTPUT_PERCENT
print "Cook temp:", float(result.COOK.COOK_TEMP)/10
print "Food1 temp:", float(result.FOOD1.FOOD1_TEMP)/10
print "Food1 status:", cyberq.statusLookup(result.FOOD1.FOOD1_STATUS)
def testProperInit(self):
"""Test host property is set to proper value"""
cqi = CyberQInterface("localhost")
self.assertEqual(cqi.host, "localhost")