Changeset 35571fb for protocols

Timestamp:

2013-01-13T12:06:01Z (12 years ago)

Author:

Wilmer van der Gaast <wilmer@…>

Branches:

master

Children:

75bda8b

Parents:

4cb21b7 (diff), 650d2b4 (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.

Message:

Merge from vmiklos.

Location:

protocols/skype

Files:

• .mailmap (deleted)
• HACKING (modified) (1 diff)
• Makefile (modified) (1 diff)
• skype.c (modified) (1 diff)
• skyped.py (modified) (7 diffs)
• skyped.txt (modified) (2 diffs)
• t/Makefile (deleted)
• t/bitlbee.conf (deleted)
• t/call-bitlbee.mock (added)
• t/call-skyped.mock (added)
• t/info-bitlbee.mock (added)
• t/info-skyped.mock (added)
• t/irssi/livetest-irssi.sh (deleted)
• t/irssi/skype-call.test (deleted)
• t/irssi/skype-info.test (deleted)
• t/irssi/skype-login.test (deleted)
• t/irssi/skype-msg.test (deleted)
• t/irssi/trigger.pl (deleted)
• t/livetest-bitlbee.sh (deleted)
• t/login-bitlbee.mock (added)
• t/login-skyped.mock (added)
• t/msg-bitlbee.mock (added)
• t/msg-skyped.mock (added)
• test.py (added)

protocols/skype/HACKING

@@ -17 +17 @@
 
 4) irssi
+
+== Tests
+
+The plugin is tested with a mocked IRC client and a mocked skyped. To add a new
+test, the following steps are necessary:
+
+1) Add a new -skyped.mock file: just do the test manually, copy&paste the
+skyped output and clean it up, so Alice talks to Bob.  You can test the created
+mock file by starting skyped with the -m option, and testing it from an IRC
+client manually.
+
+2) Add a new -bitlbee.mock file: do the test manually from irssi, and use:
+
+/connect -rawlog rawlog localhost
+
+Then clean up the rawlog: the input lines are parsed as matching patterns, so
+boring prefix/suffix text can be left out, non-interesting lines can be
+deleted. The output lines still have to be strict IRC commands, as usual.
+
+3) Add the new test to test.py and run it!
+
+// vim: ft=asciidoc

protocols/skype/Makefile

@@ -24 +24 @@
 
 test: all
-        $(MAKE) -C t/ all
+        ./test.py
 
 doc: $(MANPAGES)

protocols/skype/skype.c

@@ -2 +2 @@
  *  skype.c - Skype plugin for BitlBee
  *
- *  Copyright (c) 2007-2013 by Miklos Vajna <vmiklos@frugalware.org>
+ *  Copyright (c) 2007-2013 by Miklos Vajna <vmiklos@vmiklos.hu>
  *
  *  This program is free software; you can redistribute it and/or modify

protocols/skype/skyped.py

@@ -3 +3 @@
 #   skyped.py
 #  
-#   Copyright (c) 2007, 2008, 2009, 2010, 2011 by Miklos Vajna <vmiklos@frugalware.org>
+#   Copyright (c) 2007-2013 by Miklos Vajna <vmiklos@vmiklos.hu>
 #
 #   This program is free software; you can redistribute it and/or modify
@@ -276 +276 @@
                 sock.close()
 
+class MockedSkype:
+        """Mock class for Skype4Py.Skype(), in case the -m option is used."""
+        def __init__(self, mock):
+                sock = open(mock)
+                self.lines = sock.readlines()
+        
+        def SendCommand(self, c):
+                pass
+
+        def Command(self, msg, Block):
+                if msg == "PING":
+                        return ["PONG"]
+                line = self.lines[0].strip()
+                if not line.startswith(">> "):
+                        raise Exception("Corrupted mock input")
+                line = line[3:]
+                if line != msg:
+                        raise Exception("'%s' != '%s'" % (line, msg))
+                self.lines = self.lines[1:] # drop the expected incoming line
+                ret = []
+                while True:
+                        # and now send back all the following lines, up to the next expected incoming line
+                        if len(self.lines) == 0:
+                                break
+                        if self.lines[0].startswith(">> "):
+                                break
+                        if not self.lines[0].startswith("<< "):
+                                raise Exception("Corrupted mock input")
+                        ret.append(self.lines[0][3:].strip())
+                        self.lines = self.lines[1:]
+                return ret
+
 class SkypeApi:
-        def __init__(self):
-                self.skype = Skype4Py.Skype()
-                self.skype.OnNotify = self.recv
-                self.skype.Client.Start()
+        def __init__(self, mock):
+                if not mock:
+                        self.skype = Skype4Py.Skype()
+                        self.skype.OnNotify = self.recv
+                        self.skype.Client.Start()
+                else:
+                        self.skype = MockedSkype(mock)
 
         def recv(self, msg_text):
@@ -335 +370 @@
                         c = self.skype.Command(e, Block=True)
                         self.skype.SendCommand(c)
-                        self.recv(c.Reply)
+                        if hasattr(c, "Reply"):
+                                self.recv(c.Reply) # Skype4Py answer
+                        else:
+                                for i in c: # mock may return multiple iterable answers
+                                        self.recv(i)
                 except Skype4Py.SkypeError:
                         pass
@@ -360 +399 @@
                 # this will be read first by the input handler
                 self.buf = None
+                self.mock = None
 
 
@@ -422 +462 @@
         options = Options()
         try:
-                opts, args = getopt.getopt(sys.argv[1:], "c:dhH:l:np:v", ["config=", "debug", "help", "host=", "log=", "nofork", "port=", "version"])
+                opts, args = getopt.getopt(sys.argv[1:], "c:dhH:l:m:np:v", ["config=", "debug", "help", "host=", "log=", "mock=", "nofork", "port=", "version"])
         except getopt.GetoptError:
                 options.usage(1)
@@ -436 +476 @@
                 elif opt in ("-l", "--log"):
                         options.log = arg
+                elif opt in ("-m", "--mock"):
+                        options.mock = arg
                 elif opt in ("-n", "--nofork"):
                         options.daemon = False
@@ -486 +528 @@
                 server(options.host, options.port)
         try:
-                skype = SkypeApi()
+                skype = SkypeApi(options.mock)
         except Skype4Py.SkypeAPIError, s:
                 sys.exit("%s. Are you sure you have started Skype?" % s)

protocols/skype/skyped.txt

@@ -39 +39 @@
         Set the log file in background mode (default: none)
 
+-m, --mock=<file>::
+        Mock mode: replay session from file, instead of connecting to Skype.
+
 -n, --nofork::
         Don't run as daemon in the background
@@ -50 +53 @@
 == AUTHOR
 
-Written by Miklos Vajna <vmiklos@frugalware.org>
+Written by Miklos Vajna <vmiklos@vmiklos.hu>