debug_test.go

/*
BSD 3-Clause License

Copyright (c) 2021, Outscale SAS
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

  - Redistributions of source code must retain the above copyright notice, this
    list of conditions and the following disclaimer.

  - Redistributions in binary form must reproduce the above copyright notice,
    this list of conditions and the following disclaimer in the documentation
    and/or other materials provided with the distribution.

  - Neither the name of the copyright holder nor the names of its
    contributors may be used to endorse or promote products derived from
    this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package osc_test

import (
	"context"
	"fmt"
	"net/http"
	"os"

	osc "github.com/outscale/osc-sdk-go/v2"
)

/*
	Debug example

A quick example which show how to enable SDK debugging in case you have to see what's happening in requests.
This examples just list existing volumes and shows HTTP details.
*/
func ExampleDebug() {
	// few things which might be useful for debugging
	configEnv := osc.NewConfigEnv()
	config, err := configEnv.Configuration()
	if err != nil {
		fmt.Fprintln(os.Stderr, "Cannot init configuration from env variables")
		os.Exit(1)
	}
	config.Debug = true
	config.UserAgent = "osc-sdk-go-example/0.0.0"
	// If you need to setup a specific HTTPClient for SSL client, check https://gist.github.com/michaljemala/d6f4e01c4834bf47a9c4
	config.HTTPClient = new(http.Client)

	client := osc.NewAPIClient(config)
	ctx, err := configEnv.Context(context.Background())
	if err != nil {
		fmt.Fprintln(os.Stderr, "Cannot init context from env variables")
		os.Exit(1)
	}

	volumes, httpRes, err := client.VolumeApi.ReadVolumes(ctx).ReadVolumesRequest(osc.ReadVolumesRequest{}).Execute()
	if err != nil {
		fmt.Fprintln(os.Stderr, "Error while reading volumes")
		if httpRes != nil {
			fmt.Fprintln(os.Stderr, httpRes.Status)
		}
		os.Exit(1)
	}
	for _, volume := range *volumes.Volumes {
		println("-", *volume.VolumeId)
	}

	fmt.Println("Debug journey is over")
	// Output: Debug journey is over
}