Skip to content

Commit

Permalink
ftp.Dial with debugOut and ftp.DialWithExplicitTLS
Browse files Browse the repository at this point in the history
  • Loading branch information
@ungerik
ungerik committed Apr 9, 2024
1 parent cd0b557 commit 4e9e0a7
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 44 deletions.
31 changes: 14 additions & 17 deletions ftpfs/ftp.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,12 +72,12 @@ type fileSystem struct {
// Dial a new FTP or FTPS connection and registers it as file system.
//
// The passed address can be a URL with scheme `ftp:` or `ftps:`.
func Dial(ctx context.Context, address string, credentialsCallback CredentialsCallback) (fs.FileSystem, error) {
func Dial(ctx context.Context, address string, credentialsCallback CredentialsCallback, debugOut io.Writer) (fs.FileSystem, error) {
u, username, password, prefix, secure, err := prepareDial(address, credentialsCallback)
if err != nil {
return nil, err
}
conn, err := dial(ctx, u.Host, username, password, secure)
conn, err := dial(ctx, u.Host, username, password, secure, debugOut)
if err != nil {
return nil, err
}
Expand All @@ -88,25 +88,22 @@ func Dial(ctx context.Context, address string, credentialsCallback CredentialsCa
}, nil
}

func dial(ctx context.Context, host, username, password string, secure bool) (conn *ftp.ServerConn, err error) {
func dial(ctx context.Context, host, username, password string, secure bool, debugOut io.Writer) (conn *ftp.ServerConn, err error) {
dialOptions := []ftp.DialOption{
ftp.DialWithContext(ctx),
ftp.DialWithDebugOutput(debugOut),
}
if secure {
if !strings.ContainsRune(host, ':') {
host += ":990"
}
conn, err = ftp.Dial(
host,
ftp.DialWithContext(ctx),
ftp.DialWithTLS(&tls.Config{InsecureSkipVerify: true}), // DialWithExplicitTLS also possible
)
dialOptions = append(dialOptions, ftp.DialWithExplicitTLS(&tls.Config{InsecureSkipVerify: true}))
} else {
if !strings.ContainsRune(host, ':') {
host += ":21"
}
conn, err = ftp.Dial(
host,
ftp.DialWithContext(ctx),
)
}
conn, err = ftp.Dial(host, dialOptions...)
if err != nil {
return nil, err
}
Expand All @@ -120,8 +117,8 @@ func dial(ctx context.Context, host, username, password string, secure bool) (co
// DialAndRegister dials a new FTP or FTPS connection and register it as file system.
//
// The passed address can be a URL with scheme `ftp:` or `ftps:`.
func DialAndRegister(ctx context.Context, address string, credentialsCallback CredentialsCallback) (fs.FileSystem, error) {
fileSystem, err := Dial(ctx, address, credentialsCallback)
func DialAndRegister(ctx context.Context, address string, credentialsCallback CredentialsCallback, debugOut io.Writer) (fs.FileSystem, error) {
fileSystem, err := Dial(ctx, address, credentialsCallback, debugOut)
if err != nil {
return nil, err
}
Expand All @@ -134,7 +131,7 @@ func DialAndRegister(ctx context.Context, address string, credentialsCallback Cr
// The returned free function has to be called to decrease the file system's
// reference count and close it when the reference count reaches 0.
// The returned free function will never be nil.
func EnsureRegistered(ctx context.Context, address string, credentialsCallback CredentialsCallback) (free func() error, err error) {
func EnsureRegistered(ctx context.Context, address string, credentialsCallback CredentialsCallback, debugOut io.Writer) (free func() error, err error) {
u, username, password, prefix, secure, err := prepareDial(address, credentialsCallback)
if err != nil {
return nop, err
Expand All @@ -145,7 +142,7 @@ func EnsureRegistered(ctx context.Context, address string, credentialsCallback C
return func() error { fs.Unregister(f); return nil }, nil
}

conn, err := dial(ctx, u.Host, username, password, secure)
conn, err := dial(ctx, u.Host, username, password, secure, debugOut)
if err != nil {
return nop, err
}
Expand Down Expand Up @@ -224,7 +221,7 @@ func (f *fileSystem) getConn(ctx context.Context, filePath string) (conn *ftp.Se
return nil, "", nop, fmt.Errorf("no password in %s URL: %s", f.Name(), f.URL(filePath))
}

conn, err = dial(ctx, u.Host, username, password, f.secure)
conn, err = dial(ctx, u.Host, username, password, f.secure, nil)
if err != nil {
return nil, "", nop, err
}
Expand Down
45 changes: 23 additions & 22 deletions ftpfs/ftp_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package ftpfs

import (
"context"
"os"
"testing"

"github.com/stretchr/testify/assert"
Expand All @@ -22,7 +23,7 @@ func checkAndReadFile(t *testing.T, f fs.File) []byte {

func TestDialAndRegister(t *testing.T) {
{
ftpFS, err := DialAndRegister(context.Background(), "ftp://[email protected]", Password("password"))
ftpFS, err := DialAndRegister(context.Background(), "ftp://[email protected]", Password("password"), os.Stdout)
require.NoError(t, err, "Dial")

require.Equal(t, "ftp://[email protected]", ftpFS.Prefix())
Expand All @@ -46,29 +47,29 @@ func TestDialAndRegister(t *testing.T) {
err = ftpFS.Close()
require.NoError(t, err, "Close")
}
{
ftpFS, err := DialAndRegister(context.Background(), "ftps://[email protected]", Password("password"))
require.NoError(t, err, "Dial")
// {
// ftpFS, err := DialAndRegister(context.Background(), "ftps://[email protected]", Password("password"), os.Stdout)
// require.NoError(t, err, "Dial")

require.Equal(t, "ftps://[email protected]", ftpFS.Prefix())
id, err := ftpFS.ID()
require.NoError(t, err)
require.Equal(t, "ftps://[email protected]", id)
require.Equal(t, "ftps://[email protected] file system", ftpFS.String())
require.Equal(t, "FTPS", ftpFS.Name())
require.Equal(t, "/a/b", ftpFS.JoinCleanPath("a", "skip", "..", "/", "b", "/"))
require.Equal(t, fs.File("ftps://[email protected]/a/b"), ftpFS.JoinCleanFile("a", "skip", "..", "/", "b", "/"))
// require.Equal(t, "ftps://[email protected]", ftpFS.Prefix())
// id, err := ftpFS.ID()
// require.NoError(t, err)
// require.Equal(t, "ftps://[email protected]", id)
// require.Equal(t, "ftps://[email protected] file system", ftpFS.String())
// require.Equal(t, "FTPS", ftpFS.Name())
// require.Equal(t, "/a/b", ftpFS.JoinCleanPath("a", "skip", "..", "/", "b", "/"))
// require.Equal(t, fs.File("ftps://[email protected]/a/b"), ftpFS.JoinCleanFile("a", "skip", "..", "/", "b", "/"))

f := fs.File("ftps://[email protected]/readme.txt")
assert.Equal(t, "readme.txt", f.Name())
// data := checkAndReadFile(t, f)
// assert.True(t, len(data) > 0, "read more than zero bytes from readme.txt") // TODO: fails for some reason
// f := fs.File("ftps://[email protected]/readme.txt")
// assert.Equal(t, "readme.txt", f.Name())
// data := checkAndReadFile(t, f)
// assert.True(t, len(data) > 0, "read more than zero bytes from readme.txt")

// files, err := fs.File("ftp://test.rebex.net:21/").ListDirMax(-1)
// fmt.Println(files)
// t.Fatal("todo")
// // files, err := fs.File("ftp://test.rebex.net:21/").ListDirMax(-1)
// // fmt.Println(files)
// // t.Fatal("todo")

err = ftpFS.Close()
require.NoError(t, err, "Close")
}
// err = ftpFS.Close()
// require.NoError(t, err, "Close")
// }
}
10 changes: 5 additions & 5 deletions sftpfs/sftp_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,16 +26,16 @@ func TestDialAndRegister(t *testing.T) {
sftpFS, err := DialAndRegister(context.Background(), "[email protected]:22", Password("password"), AcceptAnyHostKey)
require.NoError(t, err, "Dial")

require.Equal(t, "sftp://[email protected]:22", sftpFS.Prefix())
require.Equal(t, "sftp://[email protected]", sftpFS.Prefix())
id, err := sftpFS.ID()
require.NoError(t, err)
require.Equal(t, "sftp://[email protected]:22", id)
require.Equal(t, "sftp://[email protected]:22 file system", sftpFS.String())
require.Equal(t, "sftp://[email protected]", id)
require.Equal(t, "sftp://[email protected] file system", sftpFS.String())
require.Equal(t, "SFTP", sftpFS.Name())
require.Equal(t, "/a/b", sftpFS.JoinCleanPath("a", "skip", "..", "/", "b", "/"))
require.Equal(t, fs.File("sftp://[email protected]:22/a/b"), sftpFS.JoinCleanFile("a", "skip", "..", "/", "b", "/"))
require.Equal(t, fs.File("sftp://[email protected]/a/b"), sftpFS.JoinCleanFile("a", "skip", "..", "/", "b", "/"))

f := fs.File("sftp://[email protected]:22/readme.txt")
f := fs.File("sftp://[email protected]/readme.txt")
assert.Equal(t, "readme.txt", f.Name())
data := checkAndReadFile(t, f)
assert.True(t, len(data) > 0)
Expand Down

0 comments on commit 4e9e0a7

Please sign in to comment.