pkg/api/platformapi/instanceconfigapi/pull.go

// Licensed to Elasticsearch B.V. under one or more contributor
// license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright
// ownership. Elasticsearch B.V. licenses this file to you 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 instanceconfigapi

import (
	"encoding/json"
	"errors"
	"os"
	"path/filepath"

	"github.com/elastic/cloud-sdk-go/pkg/api"
	"github.com/elastic/cloud-sdk-go/pkg/api/apierror"
	"github.com/elastic/cloud-sdk-go/pkg/models"
	"github.com/elastic/cloud-sdk-go/pkg/multierror"
	"github.com/elastic/cloud-sdk-go/pkg/util/ec"
)

// PullToDirectoryParams is used to store all available instance configurations
// in a local directory.
type PullToDirectoryParams struct {
	*api.API
	Directory string
	Region    string
}

// Validate ensures that the parameters are correct.
func (params PullToDirectoryParams) Validate() error {
	var merr = multierror.NewPrefixed("invalid instance config pull params")
	if params.API == nil {
		merr = merr.Append(apierror.ErrMissingAPI)
	}

	if params.Directory == "" {
		merr = merr.Append(errors.New("folder not specified and is required for the operation"))
	}

	if err := ec.RequireRegionSet(params.Region); err != nil {
		merr = merr.Append(err)
	}

	return merr.ErrorOrNil()
}

// PullToDirectory downloads instance configs and save them in a local folder
func PullToDirectory(params PullToDirectoryParams) error {
	if err := params.Validate(); err != nil {
		return err
	}

	res, err := List(ListParams{API: params.API, Region: params.Region})
	if err != nil {
		return err
	}

	return writeInstanceConfigToDirectory(params.Directory, res)
}

// writeInstanceConfigToDirectory this will write all the instance configs to a folder
// following this structure:
//   folder/
//   folder/id.json
func writeInstanceConfigToDirectory(folder string, instanceConfigs []*models.InstanceConfiguration) error {
	p := folder
	if filepath.Ext(p) != "" {
		p = filepath.Dir(folder)
	}

	if err := os.MkdirAll(p, os.ModePerm); err != nil {
		return err
	}

	var merr = multierror.NewPrefixed("failed persisting instance configurations")
	for _, template := range instanceConfigs {
		f, err := os.Create(filepath.Join(folder, template.ID+".json"))
		if err != nil {
			merr = merr.Append(err)
			continue
		}

		var enc = json.NewEncoder(f)
		enc.SetIndent("", "  ")
		if err := enc.Encode(template); err != nil {
			merr = merr.Append(err)
		}
	}

	return merr.ErrorOrNil()
}