aeintegrate

Documentation

Overview

Package aeintegrate facilitates end-to-end testing against the production Google App Engine.

This is a specialized tool that could be used in addition to unit tests. It calls the `gcloud app` command directly.

aedeploy (go get google.golang.org/appengine/cmd/aedeploy) and gcloud (https://cloud.google.com/sdk) must be installed. You must be authorized via the gcloud command-line tool (`gcloud auth login`).

You may specify the locations of aedeploy and/or gcloud via the AEDEPLOY_BIN and GCLOUD_BIN environment variables, respectively.

Sample usage with `go test`:

package myapp

import (
	"testing"
	"google.golang.org/appengine/aeintegrate"
)

func TestApp(t *testing.T) {
	t.Parallel()
	app := aeintegrate.App{Name: "A", Dir: "app"},
	if err := app.Deploy(); err != nil {
		t.Fatalf("could not deploy app: %v", err)
	}
	defer app.Cleanup()
	resp, err := app.Get("/")
	...
}

Index

• type App
  • func (p *App) Cleanup() error
  • func (p *App) Deploy() error
  • func (p *App) Deployed() bool
  • func (p *App) Get(path string) (*http.Response, error)
  • func (p *App) Module() (string, error)
  • func (p *App) URL(path string) (string, error)

Types

type App

type App struct {
	// Name is an ID, used for logging and to generate a unique version to this run.
	Name string

	// The root directory containing the app's source code.
	Dir string

	// The configuration (app.yaml) file, relative to Dir. Defaults to "app.yaml".
	AppYaml string

	// The project to deploy to.
	ProjectID string

	// Additional runtime environment variable overrides for the app.
	Env map[string]string
	// contains filtered or unexported fields
}

App describes an App Engine application.

func (*App) Cleanup

func (p *App) Cleanup() error

Cleanup deletes the created version from App Engine.

func (*App) Deploy

func (p *App) Deploy() error

Deploy deploys the application to App Engine. If the deployment fails, it tries to clean up the failed deployment.

func (*App) Deployed

func (p *App) Deployed() bool

Deployed reports whether the application has been deployed.

func (*App) Get

func (p *App) Get(path string) (*http.Response, error)

Get issues a GET request against the base URL of the deployed application.

func (*App) Module

func (p *App) Module() (string, error)

Module returns the Module ID, which is read from the app.yaml file.

func (*App) URL

func (p *App) URL(path string) (string, error)

URL prepends the deployed application's base URL to the given path. Returns an error if the application has not been deployed.