PyOGP

From Second Life Wiki
Jump to navigation Jump to search

Overview

AWG (in-world discussion group page) and Linden Lab plan to share the effort in writing a test harness which executes tests against implementations of the Open Grid Protocol (OGP). The intent is not to test SL or OpenSim (or gridX) themselves. Rather, the desire is to create a framework where the implementations of the protocols can be tested in any virtual environment implemented per the Open Grid Protocols as documented. We plan to be able to test at the smallest functional level possible, akin to unit testing, and to have the ability to use the framework to sequence steps to enable state specific tests to be run.

The longer term vision is essentially a client library, capable of navigating the grid and interacting with the various hosts, sitting next to a testing framework, happily running along telling us what works where, and where something needs a little attention to work according to specification...

For a smidge more detail on OGP, see a visual representation of the upcoming projects and a general introduction.

Status


We have a few decisions to make:

  • ZCA or no ZCA - ZCA enables flexibility via modularity with a component based framework. The intent would be to incorporate this into the library, while the test harness bits would remain 'stock' python. Tao Takashi will extend his initial attempt at this one for AWG and LL to review early next week.
  • Incorporate buildout?
  • Test framework: To doctest or not to doctest? We are certainly planning to use unittest
  • Determine how to handle test data. I imagine we'll build a template and interface to an implementation of the template, and leave contents up to the developer.

Roadmap

For reference, the high level protocol docs can be viewed at:

At a high level, the roadmap to the buildout of the client and domain specific libraries and test harness look something like this (details below):

  1. Milestone 1
    1. Identify basic library structure and test harness frameworks
    2. Develop coding conventions and standards to the extent this makes sense (group concensus rules)
    3. Build out basic lib (common), agent, login (ogp and legacy), capabilities client classes
      • Establish and maintain presence on a simulator
      • Test agent domain login (Infinity is taking a first stab at test cases, link here when available)
  2. Milestone 2
    1. Extend the client library, as well as agent domain and simulator libraries (region domain exists only as simulators at this point)
      • Start properly handling communication with simulator
    2. Test agent domain and simulator changes for OGP
    3. Test OGP teleport

Roadmap Expanded

Details with links and the link to support the work we will do. Enus needs to coordinate surfacing some docs to the public as soon as possible

  1. Milestone 1
    1. Identify basic library and test harness frameworks
    2. Develop coding conventions and standards to the extent this makes sense (group concensus rules) - Enus will make this an agenda item for the AWG meeting Tuesday June 25
    3. Build the first components
  2. Milestone 2
    1. Extend the client library, as well as agent domain and simulator libraries (region domain exists only as simulators at this point)
    2. Test agent domain and simulator specific calls that are changed for OGP
    3. Test OGP teleport

Technical Detail

Not much here yet... As the library grows, so does the need for documentation.

  1. The beta grid has an agent domain login accessible at https://login1.aditi.lindenlab.com/cgi-bin/auth.cgi
  2. Currently available Regionuri list (log into the agent domain running on aditi, show up on vaak!). Use the regionuri parameter in viewers built from http://svn.secondlife.com/trac/linden/browser/branches/interop-2, or better yet for this effort, use a pyogp script!

Open Topics

  1. Repository - So Mercurial, aka hg, was looking promising, but we decided internally that we aren't quite ready for that. There is a move toward Mercurial internally, but we need to work this out before moving forward with it on this effort. It is quite possible that this library and test harness work will become a guinea pig for hg with Linden Lab in the open source arena. Until then, I bring you pyogp on SVN: http://svn.secondlife.com/trac/linden/browser/projects/2008/pyogp.
  2. Contributions - As we are going to be hosting the source code for this, contributions will be subject to Linden Lab's standard contributor's agreement. I hope this doesn't prevent good work here...
  3. License - The Apache V2 License has been selected as the license of choice for pyogp (or whatever name we agree upon, see next point).
  4. Naming (I'd like to not debate for an hour on these. Tao had suggestions, I like em. Please speak up if you have strong reservations about the suggested naming).
    • Python client library name - pyogp
    • Python test framework (unittest/doctest) - ogptest
  5. Discussion Times - Despite Enus heading out for a 3 week vaca on the right coast of the usa, I'll set up an office hours time of sorts to meet with AWG and Lindens to chat about progress and next steps. Coming soon to a gcal near you.

Components (and supporting environmental details)

Initial stubs at a library codebase and directory structure can be found here using your favorite Subversion client:

Disclaimer*: Everything in the repo now will change dramatically in the next few weeks as things firm up structure wise. My desires for the work include: a simple, well defined library, a separate test framework (unittest, the initial high level code to be added this week), an samples/examples sandbox, and clean well commented code. That said, none of the above are in place now. They will be. More sophisticated implementations can evolve over time, or can be included on the side of the library...

These are the currently envisioned components.

  1. Login
  2. Caps (and while it's around the UDP pipe)
  3. Message Handlers (see chttp)
  4. Basic web server parts for the Agent, Region and grid bits (ideally a snap in framework)
  5. Test framework - unittest, doctest
  6. Test data (I put this here, not really as a component of the harness, more as a "i'm not telling you my test account's password and what are we gonna do about it" thing)


Tao Takashi has hit the ground running with an experimental framework which has been made available here. Read more at his blogpost describing the start of his work at his very long url. Once a repository is available, I'd plan to pull this in.

Links and Juicy Tidbits

  • Internal jira tracking Linden Lb's involvement with the work: uh, I'll get back to you.
  • Naming - Python client library name - pyogp
  • Repository - http://svn.secondlife.com/trac/linden/browser/projects/2008/pyogp.
  • Contributions - Enus, Infinity, and Locklainn will be working this internally, as well as AWG contributors (subject to the contributor's agreement). Tao Takashi and Saijanai Kuhn will be more engaged than most on this work.
  • License - The Apache V2 License has been selected as the license of choice for pyogp.
  • Communication

Links and the Like

Please add to the list as you see fit. The more we throw in here, the better off we are in the long run.

OGP documentation

A request has been made to keep docs more current

AWG Test Harness

Related scripting efforts

Related Chat Logs

irc

AWG In-world discussion group

Licensing

  1. The code written as part of this effort is subject to the Apache v2 license. Read more at http://opensource.org/licenses/apache2.0.php.
 <excerpt>
 Copyright 2008, Linden Research, Inc.
 

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
 

 http://www.apache.org/licenses/LICENSE-2.0
 

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 </excerpt>

Picture of the Moment

  1. 05/29/08: Using quite nasty code, a first contact of sorts via python into the agent domain and onto a simulator:
    pyogp and ad enabled sl viewer on a vaak sim via aditi's agent domain
Retrieved from "https://wiki.secondlife.com/w/index.php?title=PyOGP&oldid=74744"