depot/packages/networking/ipfs-cluster/api/rest/client/client_test.go

package client

import (
	"context"
	"fmt"
	"strings"
	"testing"

	"github.com/ipfs-cluster/ipfs-cluster/api/rest"
	"github.com/ipfs-cluster/ipfs-cluster/test"

	libp2p "github.com/libp2p/go-libp2p"
	pnet "github.com/libp2p/go-libp2p/core/pnet"
	tcp "github.com/libp2p/go-libp2p/p2p/transport/tcp"
	ma "github.com/multiformats/go-multiaddr"
)

func testAPI(t *testing.T) *rest.API {
	ctx := context.Background()
	//logging.SetDebugLogging()
	apiMAddr, _ := ma.NewMultiaddr("/ip4/127.0.0.1/tcp/0")

	cfg := rest.NewConfig()
	cfg.Default()
	cfg.HTTPListenAddr = []ma.Multiaddr{apiMAddr}
	secret := make(pnet.PSK, 32)

	h, err := libp2p.New(
		libp2p.ListenAddrs(apiMAddr),
		libp2p.PrivateNetwork(secret),
		libp2p.NoTransports,
		libp2p.Transport(tcp.NewTCPTransport),
	)
	if err != nil {
		t.Fatal(err)
	}

	rest, err := rest.NewAPIWithHost(ctx, cfg, h)
	if err != nil {
		t.Fatal("should be able to create a new Api: ", err)
	}

	rest.SetClient(test.NewMockRPCClient(t))
	return rest
}

func shutdown(a *rest.API) {
	ctx := context.Background()
	a.Shutdown(ctx)
	a.Host().Close()
}

func apiMAddr(a *rest.API) ma.Multiaddr {
	listen, _ := a.HTTPAddresses()
	hostPort := strings.Split(listen[0], ":")

	addr, _ := ma.NewMultiaddr(fmt.Sprintf("/ip4/127.0.0.1/tcp/%s", hostPort[1]))
	return addr
}

func peerMAddr(a *rest.API) ma.Multiaddr {
	ipfsAddr, _ := ma.NewMultiaddr(fmt.Sprintf("/p2p/%s", a.Host().ID().String()))
	for _, a := range a.Host().Addrs() {
		if _, err := a.ValueForProtocol(ma.P_IP4); err == nil {
			return a.Encapsulate(ipfsAddr)
		}
	}
	return nil
}

func testClientHTTP(t *testing.T, api *rest.API) *defaultClient {
	cfg := &Config{
		APIAddr:           apiMAddr(api),
		DisableKeepAlives: true,
	}
	c, err := NewDefaultClient(cfg)
	if err != nil {
		t.Fatal(err)
	}

	return c.(*defaultClient)
}

func testClientLibp2p(t *testing.T, api *rest.API) *defaultClient {
	cfg := &Config{
		APIAddr:           peerMAddr(api),
		ProtectorKey:      make([]byte, 32),
		DisableKeepAlives: true,
	}
	c, err := NewDefaultClient(cfg)
	if err != nil {
		t.Fatal(err)
	}
	return c.(*defaultClient)
}

func TestNewDefaultClient(t *testing.T) {
	api := testAPI(t)
	defer shutdown(api)

	c := testClientHTTP(t, api)
	if c.p2p != nil {
		t.Error("should not use a libp2p host")
	}

	c = testClientLibp2p(t, api)
	if c.p2p == nil {
		t.Error("expected a libp2p host")
	}
}

func TestDefaultAddress(t *testing.T) {
	cfg := &Config{
		APIAddr:           nil,
		DisableKeepAlives: true,
	}
	c, err := NewDefaultClient(cfg)
	if err != nil {
		t.Fatal(err)
	}
	dc := c.(*defaultClient)
	if dc.hostname != "127.0.0.1:9094" {
		t.Error("default should be used")
	}

	if dc.config.ProxyAddr == nil || dc.config.ProxyAddr.String() != "/ip4/127.0.0.1/tcp/9095" {
		t.Error("proxy address was not guessed correctly")
	}
}

func TestMultiaddressPrecedence(t *testing.T) {
	addr, _ := ma.NewMultiaddr("/ip4/1.2.3.4/tcp/1234")
	cfg := &Config{
		APIAddr:           addr,
		Host:              "localhost",
		Port:              "9094",
		DisableKeepAlives: true,
	}
	c, err := NewDefaultClient(cfg)
	if err != nil {
		t.Fatal(err)
	}
	dc := c.(*defaultClient)
	if dc.hostname != "1.2.3.4:1234" {
		t.Error("APIAddr should be used")
	}

	if dc.config.ProxyAddr == nil || dc.config.ProxyAddr.String() != "/ip4/1.2.3.4/tcp/9095" {
		t.Error("proxy address was not guessed correctly")
	}
}

func TestHostPort(t *testing.T) {

	type testcase struct {
		host              string
		port              string
		expectedHostname  string
		expectedProxyAddr string
	}

	testcases := []testcase{
		{
			host:              "3.3.1.1",
			port:              "9094",
			expectedHostname:  "3.3.1.1:9094",
			expectedProxyAddr: "/ip4/3.3.1.1/tcp/9095",
		},
		{
			host:              "ipfs.io",
			port:              "9094",
			expectedHostname:  "ipfs.io:9094",
			expectedProxyAddr: "/dns4/ipfs.io/tcp/9095",
		},
		{
			host:              "2001:db8::1",
			port:              "9094",
			expectedHostname:  "[2001:db8::1]:9094",
			expectedProxyAddr: "/ip6/2001:db8::1/tcp/9095",
		},
	}

	for _, tc := range testcases {
		cfg := &Config{
			APIAddr:           nil,
			Host:              tc.host,
			Port:              tc.port,
			DisableKeepAlives: true,
		}
		c, err := NewDefaultClient(cfg)
		if err != nil {
			t.Fatal(err)
		}
		dc := c.(*defaultClient)
		if dc.hostname != tc.expectedHostname {
			t.Error("Host Port should be used")
		}

		if paddr := dc.config.ProxyAddr; paddr == nil || paddr.String() != tc.expectedProxyAddr {
			t.Error("proxy address was not guessed correctly: ", paddr)
		}
	}
}

func TestDNSMultiaddress(t *testing.T) {
	addr2, _ := ma.NewMultiaddr("/dns4/localhost/tcp/1234")
	cfg := &Config{
		APIAddr:           addr2,
		Host:              "localhost",
		Port:              "9094",
		DisableKeepAlives: true,
	}
	c, err := NewDefaultClient(cfg)
	if err != nil {
		t.Fatal(err)
	}
	dc := c.(*defaultClient)
	if dc.hostname != "localhost:1234" {
		t.Error("address should not be resolved")
	}

	if paddr := dc.config.ProxyAddr; paddr == nil || paddr.String() != "/dns4/localhost/tcp/9095" {
		t.Error("proxy address was not guessed correctly: ", paddr)
	}
}

func TestPeerAddress(t *testing.T) {
	peerAddr, _ := ma.NewMultiaddr("/dns4/localhost/tcp/1234/p2p/QmP7R7gWEnruNePxmCa9GBa4VmUNexLVnb1v47R8Gyo3LP")
	cfg := &Config{
		APIAddr:           peerAddr,
		Host:              "localhost",
		Port:              "9094",
		DisableKeepAlives: true,
	}
	c, err := NewDefaultClient(cfg)
	if err != nil {
		t.Fatal(err)
	}
	dc := c.(*defaultClient)
	if dc.hostname != "QmP7R7gWEnruNePxmCa9GBa4VmUNexLVnb1v47R8Gyo3LP" || dc.net != "libp2p" {
		t.Error("bad resolved address")
	}

	if dc.config.ProxyAddr == nil || dc.config.ProxyAddr.String() != "/ip4/127.0.0.1/tcp/9095" {
		t.Error("proxy address was not guessed correctly")
	}
}

func TestProxyAddress(t *testing.T) {
	addr, _ := ma.NewMultiaddr("/ip4/1.3.4.5/tcp/1234")
	cfg := &Config{
		DisableKeepAlives: true,
		ProxyAddr:         addr,
	}
	c, err := NewDefaultClient(cfg)
	if err != nil {
		t.Fatal(err)
	}
	dc := c.(*defaultClient)
	if dc.config.ProxyAddr.String() != addr.String() {
		t.Error("proxy address was replaced")
	}
}

func TestIPFS(t *testing.T) {
	ctx := context.Background()
	ipfsMock := test.NewIpfsMock(t)
	defer ipfsMock.Close()

	proxyAddr, err := ma.NewMultiaddr(
		fmt.Sprintf("/ip4/%s/tcp/%d", ipfsMock.Addr, ipfsMock.Port),
	)
	if err != nil {
		t.Fatal(err)
	}

	cfg := &Config{
		DisableKeepAlives: true,
		ProxyAddr:         proxyAddr,
	}

	c, err := NewDefaultClient(cfg)
	if err != nil {
		t.Fatal(err)
	}
	dc := c.(*defaultClient)
	ipfs := dc.IPFS(ctx)

	err = ipfs.Pin(test.Cid1.String())
	if err != nil {
		t.Error(err)
	}

	pins, err := ipfs.Pins()
	if err != nil {
		t.Error(err)
	}

	pin, ok := pins[test.Cid1.String()]
	if !ok {
		t.Error("pin should be in pin list")
	}
	if pin.Type != "recursive" {
		t.Error("pin type unexpected")
	}
}