internal.go

// Copyright 2017 Google Inc. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// Package internal contains utilities for running integration tests.
package internal

import (
	"context"
	"encoding/json"
	"go/build"
	"io/ioutil"
	"net/http"
	"path/filepath"
	"strings"

	firebase "firebase.google.com/go"
	"firebase.google.com/go/internal"
	"google.golang.org/api/option"
	"google.golang.org/api/transport"
)

const certPath = "integration_cert.json"
const apiKeyPath = "integration_apikey.txt"

// Resource returns the absolute path to the specified test resource file.
func Resource(name string) string {
	p := []string{build.Default.GOPATH, "src", "firebase.google.com", "go", "testdata", name}
	return filepath.Join(p...)
}

// NewTestApp creates a new App instance for integration tests.
//
// NewTestApp looks for a service account JSON file named integration_cert.json
// in the testdata directory. This file is used to initialize the newly created
// App instance.
func NewTestApp(ctx context.Context, conf *firebase.Config) (*firebase.App, error) {
	return firebase.NewApp(ctx, conf, option.WithCredentialsFile(Resource(certPath)))
}

// APIKey fetches a Firebase API key for integration tests.
//
// APIKey reads the API key string from a file named integration_apikey.txt
// in the testdata directory.
func APIKey() (string, error) {
	b, err := ioutil.ReadFile(Resource(apiKeyPath))
	if err != nil {
		return "", err
	}
	return strings.TrimSpace(string(b)), nil
}

// ProjectID fetches a Google Cloud project ID for integration tests.
func ProjectID() (string, error) {
	b, err := ioutil.ReadFile(Resource(certPath))
	if err != nil {
		return "", err
	}
	var serviceAccount struct {
		ProjectID string `json:"project_id"`
	}
	if err := json.Unmarshal(b, &serviceAccount); err != nil {
		return "", err
	}
	return serviceAccount.ProjectID, nil
}

// NewHTTPClient creates an HTTP client for making authorized requests during tests.
func NewHTTPClient(ctx context.Context, opts ...option.ClientOption) (*http.Client, error) {
	opts = append(
		opts,
		option.WithCredentialsFile(Resource(certPath)),
		option.WithScopes(internal.FirebaseScopes...),
	)
	hc, _, err := transport.NewHTTPClient(ctx, opts...)
	return hc, err
}