Skip to content

Latest commit

 

History

History
169 lines (127 loc) · 10.2 KB

README.md

File metadata and controls

169 lines (127 loc) · 10.2 KB
Raw

Overview

Odo is a proxy server that can serve as a mock server or allow for manipulation of live data. Odo features dynamic configuration and plugin support for http request/response override behaviors.

Benefits

  • Flexible: Multiple configurations can be run simultaneously
  • Extensible: Plugin support for custom override behaviors
  • Dynamic: Odo configuration can be changed through UI or through REST interface

Getting Started

Odo Concepts

  • Path: Path defines an API endpoint and the actions (overrides) to perform. The path is specified by friendly name, path value, request type.
  • Profile: A profile is a collection of paths.
  • Client: A client is an instance of a profile. Clients share the same path definitions, but overrides are specific to a client. This allows multiple users to access a centralized Odo server with their own custom configuration.
  • Override: An action to perform on a given endpoint. The actions could be to return a custom response, add a delay, return a specific response code, modify response data, etc.
  • Plugin: Odo is extensible through plugins. You can provide your own override behaviors by creating an Odo plugin.

Download Odo

To try out Odo without needing to download the source and package it, check out the releases for a prepackaged odo.war. Also included are a sample configuration and sample plugin. Import the sample (instructions below) to try out Odo with minimal steps.

Prepackaged setup

  1. Create a "plugins" directory at the odo.war location.
  2. Place the plugin jar file in the plugins directory
  3. Start Odo by running java -Xmx1024m -jar odo.war
  4. Import the sample configuration by running curl -X POST -F [email protected] http://localhost:8090/testproxy/api/backup
  5. View the Odo UI at http://localhost:8090/testproxy

Package Odo

Ensure that you have Java 8 installed. We currently do not support any other versions of Java due to technical limitations.

$ java -version
java version "1.8.0_212"
Java(TM) SE Runtime Environment (build 1.8.0_212-b10)
Java HotSpot(TM) 64-Bit Server VM (build 25.212-b10, mixed mode)

From the repo root, run the following command for packaging the executable war:

./gradlew bootWar

The executable war will be created at proxyui/build/libs.

Run Odo

From the location where you have the executable war (let's call it proxyui.war) run

java -Xmx1024m -jar proxyui.war

If you have Odo plugins, place them in a "plugins" directory under the proxyui.war location.

Build Run Odo from Docker

Odo requires a specific version of the Java SDK (Java 8) to build and run, thus a containerized approach makes sense to guarantee proper set up.

  1. First build Odo from source into a Docker image. At the root of the repository, run:

    docker build -t odo .

  2. Now we create a container for Odo:

    docker run -d \
	-p 8090:8090 \
	-p 8082:8082 \
	-p 8012:8012 \
	-p 9090:9090 \
	-p 9092:9092 \
	--name odo \
	odo:latest

    This will create a Docker container with the required ports published.

  3. To run Odo in the future:

    docker start odo

Using Odo

Odo UI

Odo UI is available at http://localhost:8090/testproxy

UI Quickstart: Setting up a Profile

If you are starting from a fresh install, there are a few preliminary steps before actually configuring an override.

  1. Create a profile. When you navigate to http://localhost:8090/testproxy you are presented with the profile list. Initially it will be empty. To create a new Profile, click the '+' icon below the list and give the new profile a name in the dialog that appears. Select the newly-created profile. Finally, click the "Activate Profile" button at the top of the profile page.

  2. Add an API server. An API server is needed to determine which requests to handle. When a request enters Odo, the request hostname is compared to the API Servers configured. If the request hostname is not in Odo's configured hostnames, Odo will simply pass the request through without processing it.

    To add a host, click the '+' button under the "API Servers" list and fill in the Source Hostname and Destination Hostname/IP. For a live server, the source would be the actual hostname (domain.com) and the destination will be the actual IP address of the host. For this example, add Source Hostname "localhost" and Destination "blackhole". When a custom response is enabled on a path that request is never actually sent to the destination, so the destination host will not matter in this case.

  3. Create a path. Click on the '+' button under the Paths list to add a new path. A dialog prompting for path name, path value, and path type will show. Path name can be any name for you to identify it. Enter "Test path" for path name. Path value is a regular expression of the endpoint, so "/test" will match a response directed to "localhost/test". Enter "/test" for this value. Select "GET" for the path type.

UI Quickstart: Creating a Custom Response

  1. Add the Custom Response override. Clicking on your newly added path's name will display a details view. The "Response" tab contains the configuration for your response overrides. A Response Override is for modifying the data received from an API server before sending that data back to the requestor. This is also where we enable a custom response to act as a mock server.

    From the "Add Override" dropdown list, select "Custom Response". This will add the "Custom Response" override to the list of enabled overrides and enable the "Response" column in the Paths list.

  2. Configure the override. With your newly added override selected, the override parameters are displayed next to the "Overrides" list. For our custom response, we have "response" and "repeat count" parameters. The response parameter is the response content to return to the requestor. Enter "test content" here. The repeat count is a parameter that exists for all overrides. It is the number of times an override will be executed before it is disabled. -1 is infinite. Click "Apply" to update the override.

  3. Test it. Verify the override is working by sending a request or navigating to http://localhost:8082/test. You will see that your response content "test content" is returned to you.

UI Quickstart: Default overrides

Included with Odo are some default response overrides. To use them, create a directory called plugins in the proxyui/target directory (the location of odo.war). Then, move the plugins-jar-with-dependencies.jar file found in the proxyui directory into your newly created plugins directory.

If you now select a profile and go to the Edit Groups page by selecting it in the navigation bar, you will see the default overrides. You can select any or none of them for each of your groups, and any that are selected will be available to use when adding a response override to a path for which that group is selected. (You can select groups for a path in the Configuration tab, in the box that appears when you select a path from the table.)

The following overrides are included with Odo:

  • delay: Slows down response, given the length of time to slow down in milliseconds.
  • http302: Returns redirect error response.
  • http400: Returns bad request error response.
  • http401: Returns unauthorized error response.
  • http403: Returns forbidden error response.
  • http404: Returns not found error response.
  • http408: Returns request timeout error response.
  • http500: Returns internal server error response.
  • http201: Returns created error response.
  • http_200_empty_response: Returns empty response.
  • malformed_json: Returns malformed JSON response.
  • remove_json_value: Removes a JSON value, given a name and path.
  • response_from_file: Uses a response from a .txt file, given the file name.
  • set_json_value: Sets a JSON value, given a name, value, and path.

UI Quickstart: Sample configuration

Included in the examples directory is a sample configuration backup. The sample configuration uses the sample plugin. After running mvn package the sample plugin will be located at examples/plugin/target/plugin-*.jar. Create a directory called plugins at the location of the odo.war and copy the sample plugin jar there.

You can then import the backup.json data and view a sample Odo configuration.

Via Odo UI:

  1. Navigate to the profile screen: http://localhost:8090/testproxy
  2. Click the Options menu
  3. Click the Import Configuration item
  4. Select your json file to import(backup.json in this case)
  5. Press Submit

Via API:

curl -X POST -F [email protected] http://localhost:8090/testproxy/api/backup

Note that the API Servers contains a single entry. The source host is "localhost" and the destination host is "blackhole". This implies that requests sent to "localhost" will be considered for overrides. The destination host is "blackhole" simply because this is a host that does not resolve. For a path with a custom override enabled the destination host will not be resolved.

Samples

The examples directory contains samples to help get you started with Odo

  • backup.json: A sample configuration that can be imported to demonstrate some basic features of Odo.
  • api-usage: Example code demonstrating modifying an Odo configuration through the Java client.
  • plugin: Example code demonstrating how you can extend Odo's functionality by adding your own override behaviors.

Default Odo Ports

  • 8090: API - access the Odo UI, Odo configuration REST endpoints (http://localhost:8090/testproxy/api/)
  • 8082: HTTP proxy - handles HTTP traffic
  • 8012: HTTPS proxy - handles HTTPS traffic
  • 9090: Forwarding port. You can send HTTP and HTTPS requests to this port and Odo will forward them to the correct port according to the protocol
  • 9092: Database

Each of these ports can be configured by setting an environment variable with the desired port value before startup.

  • API: ODO_API_PORT
  • HTTP: ODO_HTTP_PORT
  • HTTPS: ODO_HTTPS_PORT
  • Forwarding: ODO_FWD_PORT
  • Database: ODO_DB_PORT

Odo Details

For more detailed information on Odo and developing with Odo, visit the Odo Wiki