kubo/test/cli/rpc_unixsocket_test.go

package cli

import (
	"context"
	"net/url"
	"path"
	"path/filepath"
	"strings"
	"testing"

	rpcapi "github.com/ipfs/kubo/client/rpc"
	"github.com/ipfs/kubo/config"
	"github.com/ipfs/kubo/test/cli/harness"
	"github.com/multiformats/go-multiaddr"
	"github.com/stretchr/testify/require"
)

func TestRPCUnixSocket(t *testing.T) {
	t.Parallel()

	testCases := []struct {
		name             string
		getSockMultiaddr func(sockPath string) (unixMultiaddr string)
	}{
		{
			name: "Legacy /unix: unescaped socket path",
			getSockMultiaddr: func(sockDir string) string {
				return path.Join("/unix", sockDir, "sock")
			},
		},
		{
			name: "Spec-compliant /unix: percent-encoded socket path without leading slash",
			getSockMultiaddr: func(sockDir string) string {
				sockPath := path.Join(sockDir, "sock")
				pathWithoutLeadingSlash := strings.TrimPrefix(sockPath, string(filepath.Separator))
				escapedPath := url.PathEscape(pathWithoutLeadingSlash)
				return path.Join("/unix", escapedPath)
			},
		},
		{
			name: "Spec-compliant /unix: percent-encoded socket path with leading slash",
			getSockMultiaddr: func(sockDir string) string {
				sockPath := path.Join(sockDir, "sock")
				escapedPath := url.PathEscape(sockPath)
				return path.Join("/unix", escapedPath)
			},
		},
	}

	for _, tc := range testCases {
		t.Run(tc.name, func(t *testing.T) {
			node := harness.NewT(t).NewNode().Init()
			sockDir := node.Dir
			sockAddr := tc.getSockMultiaddr(sockDir)
			node.UpdateConfig(func(cfg *config.Config) {
				//cfg.Addresses.API = append(cfg.Addresses.API, sockPath)
				cfg.Addresses.API = []string{sockAddr}
			})
			t.Log("Starting daemon with unix socket:", sockAddr)
			node.StartDaemon()

			unixMaddr, err := multiaddr.NewMultiaddr(sockAddr)
			require.NoError(t, err)

			apiClient, err := rpcapi.NewApi(unixMaddr)
			require.NoError(t, err)

			var ver struct {
				Version string
			}
			err = apiClient.Request("version").Exec(context.Background(), &ver)
			require.NoError(t, err)
			require.NotEmpty(t, ver)
			t.Log("Got version:", ver.Version)

			var res struct {
				ID string
			}
			err = apiClient.Request("id").Exec(context.Background(), &res)
			require.NoError(t, err)
			require.NotEmpty(t, res)
			t.Log("Got ID:", res.ID)

			node.StopDaemon()
		})
	}
}