375a68823a5ae31166a3616478037556b9a03a04
[smartthings-infrastructure.git] / Extractor / ExtractorScript.py
1 import os
2 readyToReturn = 0
3 ToReturn = ""
4 eventList = []
5 eventVarMap = {}
6 capabilityMap = {}
7 app1Capabilities = []
8 app2Capabilities = []
9 app1Subscribe = False
10 app2Subscribe = False
11
12 def GetToken(f):
13         global readyToReturn
14         global ToReturn
15         Skip = ['\n', '\t', ' ']
16         Special = ["(", "\"", ":", ",", "{", "}", ")", "/", "*"]
17         S = ""
18         if (readyToReturn):
19                 readyToReturn = 0
20                 return ToReturn
21         ToReturn = ""
22         c = f.read(1)
23         while(True):
24                 if (c in Special):
25                         if (S != ""):
26                                 readyToReturn = 1
27                                 ToReturn = c
28                                 return S
29                         else:
30                                 return c
31                 elif (c in Skip):
32                         if (S != ""):
33                                 return S        
34                         else:
35                                 c = f.read(1)
36                                 continue
37                 S += c
38                 c = f.read(1)
39                 if not c:
40                         return "EOF"
41
42 def ExtractFunctions(F, appName):
43         global eventList
44         global app1Subscribe
45         global app2Subscribe
46         Temp = GetToken(F)
47         while (Temp != "EOF"):
48                 if (Temp == "def" or Temp == "private"):
49                         Temp = GetToken(F)
50                         NameofFunc = Temp
51                         if (GetToken(F) != "="): #We have a function to create object for
52                                 if (appName == "App1"):
53                                         extractedFunctionsApp1.write("//Global Object for functions in subscribe method!\n")    
54                                         extractedFunctionsApp1.write("def %s = this.&" % NameofFunc)
55                                         extractedFunctionsApp1.write("%s\n" % NameofFunc)
56                                 else:
57                                         extractedFunctionsApp2.write("//Global Object for functions in subscribe method!\n")    
58                                         extractedFunctionsApp2.write("def %s = this.&" % NameofFunc)
59                                         extractedFunctionsApp2.write("%s\n" % NameofFunc)
60                 
61                 #Check input capability
62                 if (Temp == "input"):
63                         Temp = GetToken(F) #Get '"'
64                         variable = GetToken(F)
65                         Temp = GetToken(F) #Get '"'
66                         Temp = GetToken(F) #Get ','
67                         Temp = GetToken(F) #Get '"'
68                         Temp = GetToken(F) #Get capability...
69                         capability = Temp
70                         capabilityMap[variable] = capability
71                 
72                 #Check subscribed events
73                 if (Temp == "subscribe"):
74                         if (appName == "App1"):
75                                 app1Subscribe = True
76                         else:
77                                 app2Subscribe = True
78                         Temp = GetToken(F)
79                         variable = Temp
80                         while (Temp != "\"" and Temp != "app" and Temp != "location"):
81                                 Temp = GetToken(F)
82                         if Temp == "\"":
83                                 Temp = GetToken(F)
84                         if Temp not in eventList:
85                                 eventList.append(Temp)
86                                 eventVarMap[Temp] = variable
87
88                 #Check and analyze capabilities for physical interaction
89                 AnalyzeCapabilities(Temp, appName)
90
91                 Temp = GetToken(F)
92         
93         #Warn if there is a potential for physical interaction
94         AnalyzePhysicalInteraction(app1Capabilities, app2Capabilities)
95         AnalyzePhysicalInteraction(app2Capabilities, app1Capabilities)
96
97                 
98
99 def AnalyzeCapabilities(Temp, appName):
100                         #Illuminance related
101         if (Temp == "capability.switch" or
102                         Temp == "capability.switchLevel" or
103                         Temp == "capability.illuminanceMeasurement" or
104                         #Motion related
105                         Temp == "capability.motionSensor" or
106                         #Water related
107                         Temp == "capability.valve" or
108                         Temp == "capability.waterSensor" or
109                         #Sound related
110                         Temp == "capability.musicPlayer" or
111                         Temp == "capability.alarm" or
112                         Temp == "capability.speechSynthesis" or
113                         Temp == "capability.soundSensor"):
114                 if (appName == "App1"):
115                         app1Capabilities.append(Temp)
116                 else:
117                         app2Capabilities.append(Temp)
118                         
119 def AnalyzePhysicalInteraction(app1Capab, app2Capab):
120         #Light
121         if ("capability.illuminanceMeasurement" in app1Capab) and ("capability.switch" in app2Capab or 
122                         "capability.switchLevel" in app2Capab):
123                 print ("\nWARNING: Potential PHYSICAL CONFLICT (light) detected between App1 and App2!\n")
124         #Motion
125         if ("capability.motionSensor" in app1Capab):
126                 print ("\nWARNING: Potential PHYSICAL CONFLICT (motion) detected between App1 and App2!\n")             
127         #Water
128         if ("capability.waterSensor" in app1Capab) and ("capability.valve" in app2Capab or 
129                         "capability.switch" in app2Capab):
130                 print ("\nWARNING: Potential PHYSICAL CONFLICT (water) detected between App1 and App2!\n")
131         #Sound
132         if ("capability.soundSensor" in app1Capab) and ("capability.musicPlayer" in app2Capab or 
133                         "capability.alarm" in app2Capab or "capability.speechSynthesis" in app2Capab):
134                 print ("\nWARNING: Potential PHYSICAL CONFLICT (sound) detected between App1 and App2!\n")
135
136 def ExtractEvents(extractedEvents):
137         global eventList
138         global eventVarMap
139         global capabilityMap
140         extractedEvents.write("while(true) {\n")
141         extractedEvents.write("\tdef eventNumber = Verify.getInt(0,%d)\n" % (len(eventList) - 1))
142         extractedEvents.write("\tswitch(eventNumber) {\n")
143         for i in range(len(eventList)):
144                 extractedEvents.write("\t\tcase %d:\n" % i)
145                 if eventList[i] == "lock":
146                         event = open("eventSimulator/lockEvent.groovy", "r")
147                         for line in event:
148                                 extractedEvents.write(line)
149                         event.close()
150                 elif eventList[i] == "unlock":
151                         event = open("eventSimulator/unlockEvent.groovy", "r")
152                         for line in event:
153                                 extractedEvents.write(line)
154                         event.close()
155                 elif eventList[i] == "contact.open":
156                         event = open("eventSimulator/contactOpenEvent.groovy", "r")
157                         for line in event:
158                                 extractedEvents.write(line)
159                         event.close()
160                 elif eventList[i] == "contact.closed":
161                         event = open("eventSimulator/contactClosedEvent.groovy", "r")
162                         for line in event:
163                                 extractedEvents.write(line)
164                         event.close()
165                 elif eventList[i] == "nfcTouch":
166                         event = open("eventSimulator/nfcTouchEvent.groovy", "r")
167                         for line in event:
168                                 extractedEvents.write(line)
169                         event.close()
170                 elif eventList[i] == "app": #Case for Touched event
171                         event = open("eventSimulator/appTouchEvent.groovy", "r")
172                         for line in event:
173                                 extractedEvents.write(line)
174                         event.close()
175                 elif eventList[i] == "button":
176                         #Write two events subsequently
177                         extractedEvents.write("\t\t\tdef event = Verify.getInt(0,1)\n")
178                         extractedEvents.write("\t\t\tif (event == 0) {\n")
179                         event = open("eventSimulator/buttonPushedEvent.groovy", "r")                    
180                         for line in event:
181                                 extractedEvents.write("\t\t" + line)
182                         event.close()
183                         extractedEvents.write("\t\t\t} else {\n")
184                         event = open("eventSimulator/buttonHeldEvent.groovy", "r")
185                         for line in event:
186                                 extractedEvents.write("\t\t" + line)
187                         event.close()
188                         extractedEvents.write("\t\t\t}\n")
189                 elif eventList[i] == "presence":
190                         #Write two events subsequently
191                         extractedEvents.write("\t\t\tdef event = Verify.getInt(0,1)\n")
192                         extractedEvents.write("\t\t\tif (event == 0) {\n")
193                         event = open("eventSimulator/presencePresentEvent.groovy", "r")                 
194                         for line in event:
195                                 extractedEvents.write("\t\t" + line)
196                         event.close()
197                         extractedEvents.write("\t\t\t} else {\n")
198                         event = open("eventSimulator/presenceLeftEvent.groovy", "r")
199                         for line in event:
200                                 extractedEvents.write("\t\t" + line)
201                         event.close()
202                         extractedEvents.write("\t\t\t}\n")
203                 elif eventList[i] == "doorState":
204                         #Write two events subsequently
205                         extractedEvents.write("\t\t\tdef event = Verify.getInt(0,1)\n")
206                         extractedEvents.write("\t\t\tif (event == 0) {\n")
207                         event = open("eventSimulator/doorOpenEvent.groovy", "r")                        
208                         for line in event:
209                                 extractedEvents.write("\t\t" + line)
210                         event.close()
211                         extractedEvents.write("\t\t\t} else {\n")
212                         event = open("eventSimulator/doorClosedEvent.groovy", "r")
213                         for line in event:
214                                 extractedEvents.write("\t\t" + line)
215                         event.close()
216                         extractedEvents.write("\t\t\t}\n")
217                 elif eventList[i] == "motion":
218                         #Write two events subsequently
219                         extractedEvents.write("\t\t\tdef event = Verify.getInt(0,1)\n")
220                         extractedEvents.write("\t\t\tif (event == 0) {\n")
221                         event = open("eventSimulator/motionActiveEvent.groovy", "r")                    
222                         for line in event:
223                                 extractedEvents.write("\t\t" + line)
224                         event.close()
225                         extractedEvents.write("\t\t\t} else {\n")
226                         event = open("eventSimulator/motionInactiveEvent.groovy", "r")
227                         for line in event:
228                                 extractedEvents.write("\t\t" + line)
229                         event.close()
230                         extractedEvents.write("\t\t\t}\n")
231                 elif eventList[i] == "smoke":
232                         #Write three events subsequently
233                         extractedEvents.write("\t\t\tdef event = Verify.getInt(0,2)\n")
234                         extractedEvents.write("\t\t\tif (event == 0) {\n")
235                         event = open("eventSimulator/smokeClearEvent.groovy", "r")                      
236                         for line in event:
237                                 extractedEvents.write("\t\t" + line)
238                         event.close()
239                         extractedEvents.write("\t\t\t} else if (event == 1) {\n")
240                         event = open("eventSimulator/smokeDetectedEvent.groovy", "r")
241                         for line in event:
242                                 extractedEvents.write("\t\t" + line)
243                         event.close()
244                         extractedEvents.write("\t\t\t} else {\n")
245                         event = open("eventSimulator/smokeTestedEvent.groovy", "r")
246                         for line in event:
247                                 extractedEvents.write("\t\t" + line)
248                         event.close()
249                         extractedEvents.write("\t\t\t}\n")
250                 elif eventList[i] == "carbonMonoxide":
251                         #Check which capability
252                         variable = eventVarMap[eventList[i]]
253                         capability = capabilityMap[variable]
254         
255                         #Write three events subsequently
256                         extractedEvents.write("\t\t\tdef event = Verify.getInt(0,2)\n")
257                         extractedEvents.write("\t\t\tif (event == 0) {\n")                      
258                         if capability == "capability.smokeDetector":
259                                 event = open("eventSimulator/smokeCarbonMonoxideClearEvent.groovy", "r")
260                         elif capability == "capability.carbonMonoxideDetector":
261                                 event = open("eventSimulator/carbonMonoxideClearEvent.groovy", "r")
262                         for line in event:
263                                 extractedEvents.write("\t\t" + line)
264                         event.close()
265                         extractedEvents.write("\t\t\t} else if (event == 1) {\n")
266                         if capability == "capability.smokeDetector":
267                                 event = open("eventSimulator/smokeCarbonMonoxideDetectedEvent.groovy", "r")
268                         elif capability == "capability.carbonMonoxideDetector":
269                                 event = open("eventSimulator/carbonMonoxideDetectedEvent.groovy", "r")
270                         for line in event:
271                                 extractedEvents.write("\t\t" + line)
272                         event.close()
273                         extractedEvents.write("\t\t\t} else {\n")
274                         if capability == "capability.smokeDetector":
275                                 event = open("eventSimulator/smokeCarbonMonoxideTestedEvent.groovy", "r")
276                         elif capability == "capability.carbonMonoxideDetector":
277                                 event = open("eventSimulator/carbonMonoxideTestedEvent.groovy", "r")
278                         for line in event:
279                                 extractedEvents.write("\t\t" + line)
280                         event.close()
281                         extractedEvents.write("\t\t\t}\n")
282                 elif eventList[i] == "battery":
283                         event = open("eventSimulator/batteryChargeEvent.groovy", "r")
284                         for line in event:
285                                 extractedEvents.write(line)
286                         event.close()
287                 elif eventList[i] == "thermostatMode":
288                         #Write five events subsequently
289                         extractedEvents.write("\t\t\tdef event = Verify.getInt(0,4)\n")
290                         extractedEvents.write("\t\t\tif (event == 0) {\n")
291                         event = open("eventSimulator/thermostatAutoModeEvent.groovy", "r")                      
292                         for line in event:
293                                 extractedEvents.write("\t\t" + line)
294                         event.close()
295                         extractedEvents.write("\t\t\t} else if (event == 1) {\n")
296                         event = open("eventSimulator/thermostatCoolModeEvent.groovy", "r")
297                         for line in event:
298                                 extractedEvents.write("\t\t" + line)
299                         event.close()
300                         extractedEvents.write("\t\t\t} else if (event == 2) {\n")
301                         event = open("eventSimulator/thermostatEmergencyHeatModeEvent.groovy", "r")
302                         for line in event:
303                                 extractedEvents.write("\t\t" + line)
304                         event.close()
305                         extractedEvents.write("\t\t\t} else if (event == 3) {\n")
306                         event = open("eventSimulator/thermostatHeatModeEvent.groovy", "r")
307                         for line in event:
308                                 extractedEvents.write("\t\t" + line)
309                         event.close()
310                         extractedEvents.write("\t\t\t} else {\n")
311                         event = open("eventSimulator/thermostatOffModeEvent.groovy", "r")
312                         for line in event:
313                                 extractedEvents.write("\t\t" + line)
314                         event.close()
315                         extractedEvents.write("\t\t\t}\n")
316                 elif eventList[i] == "switch":
317                         #Write two events subsequently
318                         extractedEvents.write("\t\t\tdef event = Verify.getInt(0,1)\n")
319                         extractedEvents.write("\t\t\tif (event == 0) {\n")
320                         event = open("eventSimulator/switchOnEvent.groovy", "r")                        
321                         for line in event:
322                                 extractedEvents.write("\t\t" + line)
323                         event.close()
324                         extractedEvents.write("\t\t\t} else {\n")
325                         event = open("eventSimulator/switchOffEvent.groovy", "r")
326                         for line in event:
327                                 extractedEvents.write("\t\t" + line)
328                         event.close()
329                         extractedEvents.write("\t\t\t}\n")
330                 elif eventList[i] == "location": #Case for Location event
331                         #Write three events subsequently
332                         extractedEvents.write("\t\t\tdef event = Verify.getInt(0,2)\n")
333                         extractedEvents.write("\t\t\tif (event == 0) {\n")
334                         event = open("eventSimulator/locationHomeEvent.groovy", "r")                    
335                         for line in event:
336                                 extractedEvents.write("\t\t" + line)
337                         event.close()
338                         extractedEvents.write("\t\t\t} else if (event == 1) {\n")
339                         event = open("eventSimulator/locationAwayEvent.groovy", "r")
340                         for line in event:
341                                 extractedEvents.write("\t\t" + line)
342                         event.close()
343                         extractedEvents.write("\t\t\t} else {\n")
344                         event = open("eventSimulator/locationNightEvent.groovy", "r")
345                         for line in event:
346                                 extractedEvents.write("\t\t" + line)
347                         event.close()
348                         extractedEvents.write("\t\t\t}\n")
349                 elif eventList[i] == "acceleration":
350                         #Write two events subsequently
351                         extractedEvents.write("\t\t\tdef event = Verify.getInt(0,1)\n")
352                         extractedEvents.write("\t\t\tif (event == 0) {\n")
353                         event = open("eventSimulator/accelerationActiveEvent.groovy", "r")                      
354                         for line in event:
355                                 extractedEvents.write("\t\t" + line)
356                         event.close()
357                         extractedEvents.write("\t\t\t} else {\n")
358                         event = open("eventSimulator/accelerationInactiveEvent.groovy", "r")
359                         for line in event:
360                                 extractedEvents.write("\t\t" + line)
361                         event.close()
362                         extractedEvents.write("\t\t\t}\n")
363                 elif eventList[i] == "beacon":
364                         #Write two events subsequently
365                         extractedEvents.write("\t\t\tdef event = Verify.getInt(0,1)\n")
366                         extractedEvents.write("\t\t\tif (event == 0) {\n")
367                         event = open("eventSimulator/beaconPresenceEvent.groovy", "r")                  
368                         for line in event:
369                                 extractedEvents.write("\t\t" + line)
370                         event.close()
371                         extractedEvents.write("\t\t\t} else {\n")
372                         event = open("eventSimulator/beaconLeftEvent.groovy", "r")
373                         for line in event:
374                                 extractedEvents.write("\t\t" + line)
375                         event.close()
376                         extractedEvents.write("\t\t\t}\n")
377                 elif eventList[i] == "color":
378                         event = open("eventSimulator/colorChangeEvent.groovy", "r")
379                         for line in event:
380                                 extractedEvents.write(line)
381                         event.close()
382                 elif eventList[i] == "hue":
383                         event = open("eventSimulator/hueChangeEvent.groovy", "r")
384                         for line in event:
385                                 extractedEvents.write(line)
386                         event.close()
387                 elif eventList[i] == "saturation":
388                         event = open("eventSimulator/saturationChangeEvent.groovy", "r")
389                         for line in event:
390                                 extractedEvents.write(line)
391                         event.close()
392
393                 ###TODO: Add more events later
394                 extractedEvents.write("\t\t\tbreak\n")
395         extractedEvents.write("\t}\n")
396         extractedEvents.write("}\n")
397         
398 def CheckIfOnlyTouchEvents():
399         #Check and throw an error if it is all touch events
400         #This is called Direct-Direct interaction and we do not model-check for this case
401         onlyTouchEvents = True
402         for item in eventList:
403                 if item != "nfcTouch" and item != "app":
404                         onlyTouchEvents = False
405         if onlyTouchEvents is True and app1Subscribe is True and app2Subscribe is True:
406                 raise Exception("\n\nDirect-Direct Interaction detected: we are skipping this pair...\n\n")
407                 
408 #Extract objects to call functions from App1
409 F1 = open("Extractor/App1/App1.groovy", "r")
410 extractedFunctionsApp1 = open("Extractor/App1/extractedFunctionsApp1.groovy", "w+")
411 ExtractFunctions(F1, "App1")
412 F1.close()
413
414 #Extract objects to call functions from App2
415 F2 = open("Extractor/App2/App2.groovy", "r")
416 extractedFunctionsApp2 = open("Extractor/App2/extractedFunctionsApp2.groovy", "w+")
417 ExtractFunctions(F2, "App2")
418 F2.close()
419
420 #Prepare eventSimulator file while parsing the App1 and App2 files
421 extractedEvents = open("eventSimulator/eventSimulator.groovy", "w+")
422 CheckIfOnlyTouchEvents()
423 ExtractEvents(extractedEvents)
424 extractedEvents.close()
425
426 #Save the extracted methods and app1 in a same file to extract information
427 extractorFile = open("Extractor/extractorFile.groovy", "w+")
428 Extractor = open("Extractor/Extractor.groovy", "r")
429 F1 = open("Extractor/App1/App1.groovy", "r")
430
431 extractorFile.write("////////////////////\n")
432 extractorFile.write("@Field App\n")
433 extractorFile.write("App = \"App1\"")
434 extractorFile.write("\n")
435 for line in Extractor:
436         extractorFile.write(line)
437 extractorFile.write("\n\n")
438 for line in F1:
439         extractorFile.write(line)
440 extractorFile.close()
441 Extractor.close()
442 F1.close()
443 #Run the file to extract the objects
444 os.system("groovy -classpath lib/jpf.jar Extractor/extractorFile.groovy")
445
446
447 #Save the extracted methods and app2 in a same file to extract information
448 extractorFile = open("Extractor/extractorFile.groovy", "w+")
449 Extractor = open("Extractor/Extractor.groovy", "r")
450 F2 = open("Extractor/App2/App2.groovy", "r")
451
452 extractorFile.write("////////////////////\n")
453 extractorFile.write("@Field App\n")
454 extractorFile.write("App = \"App2\"")
455 extractorFile.write("\n")
456 for line in Extractor:
457         extractorFile.write(line)
458 extractorFile.write("\n\n")
459 for line in F2:
460         extractorFile.write(line)
461 #Run the file to extract the objects
462 extractorFile.close()
463 Extractor.close()
464 F2.close()
465 os.system("groovy -classpath lib/jpf.jar Extractor/extractorFile.groovy")
466
467
468
469