Development documentation
This document provides an overview of the various documents and links that are part of this project's technical documentation.
Architecture
Architecture description
This document describes the architecture of the project.
Configuration
This document gives an overview of how the project configured.
Implementation
Build Pineapple from source
This guide describes how to build Pineapple from the source repository.
Maven project organization
This document describes how the project is organized in Maven projects.
Plugin framework reference
This guide describes the plugin framework and how to implement plugins.
Execution framework reference
This guide describes the execution framework and how to use it in plugins, commands and clients.
Guidelines for implementation of commands
This guide describes how Chain commands should be implemented in the project.
Pineapple version implementation
This document describes where version information for the different components is defined.
Core component
Usage of the core component
This document describes how to use the core component from clients.
Implementation of supported use cases in the core component:
- Initialization of the core component.
- Execute operation.
- Register result listener.
- Get administration interface.
Extending the core component:
Test
Pineapple test infrastructure
This document describes the design of the test infrastructure used to test the Pineapple project.
Examples
General application infrastructure
- How-to: Setup a project with internalization (I18N) support.
- How-to: Use the API project with the Spring framework.
- How-to: Use the Hamcrest support project with the Spring framework.
- How-to: Use the Hamcrest asserter object with matchers.
- How-to: Use the process execution support project with the Spring framework.
- How-to: Use the process execution session to execute external processes.
Core component
- How-to: Create the core component with default settings.
- How-to: Create the core component with default settings using Spring.
- How-to: Create the core component with a custom credential provider.
- How-to: Create the core component which loads resources from an alternate location.
- How-to: Create the core component with result listeners registered.
- How-to: Invoke the core component from a client.
- How-to: Register a result listener with the core component.
Test utilities
- How-to: Write test cases that requires disk access.
- How-to: Write test cases that requires access to the name of the test method.
- How-to: Mock the MessageProvider in tests.
- How-to: Write unit tests in Pineapple.
- How-to: Write integration tests in Pineapple.
- How-to: Write system tests in Pineapple.
- How-to: Write code to generate modules.