Implement system design for layer conn and dev

[erikbgithub]

Situation

In my thesis a system design was suggested for a revision of MONK's architecture.

Task

As far as the design is reviewed by the Stammtisch and team members it should be implemented in MONK.

Notes

• Code in branch f-conn-dev

• Review:

  1. Read the code of conn.py and dev.py carefully. It's a lot, take your time. Does it make sense? How about the documentation?
  2. Read the unit tests in test_conn.py and test_dev.py. Do they make sense? Something missing?
  3. Execute the test suite and see if it works. Did they all run without errors and fails?

  (activate virtualenv)
  $ python setup.py nosetests
  ...
  Ran 16 tests in 0.xxxxs
  
  OK

  1. Is there anything left that you don't understand or that you think is missing?
  2. If everything's fine give your ACK. Thanks!

[erikbgithub]

review Python logging before closing! - done

[DfePeterWinkler]

File: conn.py

• [x] The class AState contains constants CONNECT, LOGIN, etc. It would be better to hide them as _CONNECT, _LOGIN, etc.
• [x] in a lot of methods (AState, Disconnected, etc.) the docstring is missing.

File: dev.py

• [x] The package docstring is missing on top of file.
• [x] line 52 ff.: a single char mismatches the style guide for variable names. conn would be better.

Documentation

• [ ] Building doc contains warnings.
• [ ] A description of the new connection concept including the internal state machine is missing.

[erikbgithub]

@DfePeterWinkler I have reviewed your feedback and implemented most of it. The documentation stuff will be discussed in another issue, because there are a lot of other problems. Before I write separate docstrings for the same methods in all State classes I want to look for a way to write them once and let the documentation tooling figure out how to copy&paste it to the other states. Because the same method in 2 different State classes should have the same documentation actually.

[erikbgithub]

Review with @binschek (plus own notes):

• [x] module doc should give overview of containing classes
• [x] AState methods API Doc
• [x] AState/AConnection doc should explain what is the A in the name
• [x] Authenticated doc is a copy&paste error
• [x] there is no conn.Connection
• [x] What does "Test Connections" mean?
• [x] Test Connection: each with example usecase would be good
• [x] test_fsm(): which state after login?
• [x] test_conn.py: provoke error case, e.g., invalid state transition

[erikbgithub]

@binschek , @DfePeterWinkler I have implemented everything from your feedback beside the documentation building things which should be resolved in another Issue. Now ACK?

[erikbgithub]

ACKed by @DfePeterWinkler and @binschek at today's Stammtisch.