Job and Test Developers

This chapter organizes information useful for developers creating and maintaining jobs and test scripts but not directly involved in changing the core.

• Introduction to Plainbox
  • What is Plainbox?
  • Goal
  • Terminology
  • Getting Started
  • Looking Deeper
    • Providers
  • Other Questions
  • References
• QML-native Jobs Tutorial
  • What is a qml-native job
  • Software requirements
    • Ubuntu-SDK installation
    • Plainbox installation
  • First qml-native job - Smoke test
  • How to run jobs
  • Multi-page tests
    • Flat page hierarchy
    • Using page stack
  • Migrating QtQuick app to a qml-native test
    • Plainbox job definition for the test
    • Testing qml job in Checkbox Touch on Ubuntu device
  • Confined Qml jobs
• Providers
  • Provider Template
    • Provider Template Layout
    • Generated Content
      • README.md
      • manage.py
      • bin/README.md
      • bin/custom-executable
      • data/README.md
      • data/example.dat
      • examples-trivial.txt
      • jobs/examples-normal.txt
      • jobs/examples-intermediate.txt
      • po/POTFILES.in
  • Provider Name-Spaces
    • Theoretical Considerations
      • About name-spaces
      • Rationale
      • Name-Space Organization Guide
        • Provider Name Spaces and IQN
        • Sole Developers
        • Organizations and Companies
        • Important Notes
    • Technical Details
      • Implicit Provider Name-Space
      • Using Explicit Name-Spaces
      • Custom Executables & Execution Environment
    • Limitations and Known Issues
      • List of issues as of version 0.5
  • Provider Internationalization
    • About
    • Working with translations
    • Updating Translations
    • Translating Job Definitions
    • Translating Test Programs
    • Working with Version Control Systems
    • Further Reading
  • Provider Definition Files
    • Lookup Directories
    • File Structure
      • The [Plainbox Provider] Section
    • Example
• Plainbox RFC822 Specification
  • BNF
  • Quirk 1 – the magic dot
  • Quirk 2 – the # comments
• Frequently Asked Questions
  • FAQ 1
  • FAQ 2

Warning

This chapter is very much under development. The list of stories below is a guiding point for subsequent editions that will expand and provide real value.

Personas and stories

• I’m a developer working on the checkbox project. With my job developer hat on:
  • how does plainbox help me do my job when…
    • … I’m fixing a bug in existing jobs or scripts?
    • … I’m working on a new job from scratch?
    • … I’m working on private collection of jobs?
  • how can I check for syntax correctness, simple errors, etc?
  • how can I write automated tests for my jobs?
  • how can I run automated tests for my jobs?
  • how can I document my jobs so that others can understand and use them better?
• I’m a developer working on a derivative of the checkbox project. I don’t know much about plainbox. What should I be aware of and how can I use plainbox to do my job better.
  • (same as above but with different assumptions about initial familiarity with plainbox)
  • how can I find about all the existing jobs?
  • how can I find about all the existing resource jobs?

Key topics

Note

The list here should always be based on the personas and stories section above.

• Introduction to plainbox
• Where is plainbox getting the jobs from?
• Creating and maintaining jobs with plainbox

comments powered by Disqus