Privacy/Reviews/CaseConductor
Document Overview
| Feature/Product: | Case Conductor |
| Projected Feature Freeze Date: | 3/30/2012 |
| Product Champions: | Cameron Dawson, Rebecca Billings, Carl Meyer |
| Privacy Champions: | (the privacy Friend you're working with) |
| Security Contact: | Adam Muntner |
| Document State: | [NEW] |
Timeline:
| Architectural Overview: | (date TBD) |
| Recommendation Meeting: | (date TBD) |
| Review Complete ETA: | tbd |
Architecture
In this section, the product's architecture is described. Any individual components or actors are identified, their "knowledge" or what data they store is identified, and data flow between components and external entities is described.
The main objective of this feature/product is: This is a test case management system. It is Free and open-source. This is our upcoming replacement for Litmus. The system is designed to provide test case management, and status on test execution. Test managers can write tests for testers to execute, and they can see the results of the tests in real-time.
We will host an instance of this product as our own test case management system. However, the source is checked into github here and other organizations will deploy their own instances.
History: Originally this product was designed to be in two parts. A "Platform" written in Java providing REST endpoint APIs and a "User Interface" written in Django. Despite some people's investment in this relationship with uTest and the separation of the two parts, eventually it was determined that this architecture was untenable. At this point (Nov 2011) we decided to re-architect as pure Django.
One result of this change, is that the product is no longer a joint project with uTest, however they own the name "Case Conductor." So we will be changing the name. The branding search is underway.
Documentation: http://readthedocs.org/docs/case-conductor/en/latest/index.html
Project Plan:Pivotal Tracker
Components
Describe any major components in the system and how they interact. Also include any third-party APIs (those Mozilla does not control) and what type of data is sent or received via those APIs.
Deployment Considerations: readthedocs
The main components of the product are:
- Web App
- BrowserID (external component)
- File Store / Attachments (external component)
Web App
This component manages:
- Products & Versions
- Environments
- Test Runs, Suites & Cases
- Test Results
- Authentication
The tables below simply summarize the data encountered by this component.
Stored Data:
| What | Where |
|---|---|
| Products | database |
| Product Versions | database |
| Environments | database |
| Test Runs | database |
| Test Suites | database |
| Test Cases | database |
| Authentication | database |
Communication with File-Store / Attachments Attachments are files stored in a file store. In our deployment, it's just the local file system. Full documentation on the Django file store API can be found here: Django File Store API
| Direction | Message | Data | Notes |
|---|---|---|---|
| In: | url(name) | hyperlink pointing to the file in question | attachments are referenced by hyperlinks. when the user clicks a link for this file, it opens the hyperlink in the browser. |
| Out: | get_available_name(name) | text | an available name in the file store to save this file |
| Out: | save(name, content) | text, binary | the name of the file, and the binary content of that file |
Communication with BrowserID
Documentation on using BrowserID with a web app can be found here: BrowserID Dev Guide
| Direction | Message | Data | Notes |
|---|---|---|---|
| In: | assertion | string | this is a signed claim that proves the user is who they say they are |
| Out: | https://browserid.org/verify | assertion | an encoded assertion |
| Out: | https://browserid.org/verify | audience | the host and port of this web app |
BrowserID / Persona
This is an external component described here: BrowserID Privacy Review
User Data Risk Minimization
In this section, the privacy champion will identify areas of user data risk and recommendations for minimizing the risk.
Alignment with Privacy Operating Principles
In this section, the privacy champion will identify how the feature lines up with Mozilla's privacy operating principles.
See Also: Privacy/Roadmap_2011#Operating_Principles:
Principle: Transparency / No Surprises
(How the feature addresses this)
Recommendations: (what can be improved)
Principle: Real Choice
Recommendations:
Principle: Sensible Defaults
Recommendations:
Principle: Limited Data
Recommendations:
Follow-up Tasks and tracking
| What | Who | Bug | Details |
|---|---|---|---|
| [NEW] Initial Overview Discussion | ? | Meeting time TBD |