Example for interacting with remote file servers #1061
+346
−0
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| # Add FileStore Example | ||
|
|
||
| This GoFr example demonstrates a CMD application that can be used to interact with a remote file server using FTP or SFTP protocol | ||
|
|
||
| ### Setting up an FTP server in local machine | ||
| - https://security.appspot.com/vsftpd.html | ||
| - https://pypi.org/project/pyftpdlib/ | ||
|
|
||
| Choose a library listed above and follow their respective documentation to configure an FTP server in your local machine and replace the configs/env file with correct HOST,USER_NAME,PASSWORD,PORT and REMOTE_DIR_PATH details. | ||
|
|
||
| ### To run the example use the commands below: | ||
| To print the current working directory of the configured remote file server | ||
| ``` | ||
| go run main.go pwd | ||
| ``` | ||
| To get the list of all directories or files in the given path of the configured remote file server | ||
|
|
||
| ``` | ||
| go run main.go ls -path=<path> | ||
|
|
||
| Eg:- go run main.go ls -path=/ | ||
| ``` | ||
| To grep the list of all files and directories in the given path that is matching with the keyword provided | ||
|
|
||
| ``` | ||
| go run main.go grep -keyword=fi -path=<path> | ||
|
|
||
| Eg:- go run main.go grep -keyword=fi -path=/ | ||
| ``` | ||
|
|
||
| To create a file in the current working directory with the provided filename | ||
| ``` | ||
| go run main.go createfile -filename=<filename> | ||
|
|
||
| Eg:- go run main.go createfile -filename=file.txt | ||
| ``` | ||
|
|
||
| To remove the file with the provided filename from the current working directory | ||
| ``` | ||
| go run main.go rm -filename=<filename> | ||
|
|
||
| Eg:- go run main.go rm -filename=file.txt | ||
| ``` | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| HOST="localhost" | ||
| USER_NAME="anonymous" | ||
| PASSWORD="test" | ||
| PORT=21 | ||
| REMOTE_DIR_PATH="/" | ||
|
Comment on lines
+1
to
+5
There was a problem hiding this comment. configs ain't necessarily needed to pass within double quotes ( |
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| package main | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "strconv" | ||
| "strings" | ||
|
|
||
| "gofr.dev/pkg/gofr" | ||
| "gofr.dev/pkg/gofr/datasource/file" | ||
| "gofr.dev/pkg/gofr/datasource/file/ftp" | ||
| ) | ||
|
|
||
| type FileServerType int | ||
|
|
||
| const ( | ||
| FTP FileServerType = iota | ||
| SFTP | ||
| ) | ||
|
|
||
| // This can be a common function to configure both FTP and SFTP server. | ||
| func configureFileServer(app *gofr.App) file.FileSystemProvider { | ||
| port, _ := strconv.Atoi(app.Config.Get("PORT")) | ||
|
|
||
| return ftp.New(&ftp.Config{ | ||
| Host: app.Config.Get("HOST"), | ||
| User: app.Config.Get("USER_NAME"), | ||
| Password: app.Config.Get("PASSWORD"), | ||
| Port: port, | ||
| RemoteDir: app.Config.Get("REMOTE_DIR_PATH"), | ||
| }) | ||
| } | ||
|
|
||
| func printFiles(files []file.FileInfo, err error) { | ||
| if err != nil { | ||
| fmt.Println(err) | ||
| } else { | ||
| for _, f := range files { | ||
| fmt.Println(f.Name()) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func grepFiles(files []file.FileInfo, keyword string, err error) { | ||
| if err != nil { | ||
| fmt.Println(err) | ||
| } else { | ||
| for _, f := range files { | ||
| if strings.HasPrefix(f.Name(), keyword) { | ||
| fmt.Println(f.Name()) | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func registerPwdCommand(app *gofr.App, fs file.FileSystemProvider) { | ||
| app.SubCommand("pwd", func(_ *gofr.Context) (interface{}, error) { | ||
| workingDirectory, err := fs.Getwd() | ||
|
|
||
| return workingDirectory, err | ||
| }) | ||
| } | ||
|
|
||
| func registerLsCommand(app *gofr.App, fs file.FileSystemProvider) { | ||
| app.SubCommand("ls", func(c *gofr.Context) (interface{}, error) { | ||
| path := c.Param("path") | ||
| files, err := fs.ReadDir(path) | ||
| printFiles(files, err) | ||
|
|
||
| return "", err | ||
| }) | ||
| } | ||
|
|
||
| func registerGrepCommand(app *gofr.App, fs file.FileSystemProvider) { | ||
| app.SubCommand("grep", func(c *gofr.Context) (interface{}, error) { | ||
| keyword := c.Param("keyword") | ||
| path := c.Param("path") | ||
| files, err := fs.ReadDir(path) | ||
| grepFiles(files, keyword, err) | ||
|
|
||
| return "", err | ||
| }) | ||
| } | ||
|
|
||
| func registerCreateFileCommand(app *gofr.App, fs file.FileSystemProvider) { | ||
| app.SubCommand("createfile", func(c *gofr.Context) (interface{}, error) { | ||
| fileName := c.Param("filename") | ||
| fmt.Printf("Creating file :%s", fileName) | ||
|
There was a problem hiding this comment. shouldn't we use gofr logger instead of |
||
| _, err := fs.Create(fileName) | ||
|
|
||
| if err == nil { | ||
| fmt.Printf("Successfully created file:%s", fileName) | ||
| } | ||
|
|
||
| return "", err | ||
| }) | ||
| } | ||
|
|
||
| func registerRmCommand(app *gofr.App, fs file.FileSystemProvider) { | ||
| app.SubCommand("rm", func(c *gofr.Context) (interface{}, error) { | ||
| fileName := c.Param("filename") | ||
| fmt.Printf("Removing file :%s", fileName) | ||
| err := fs.Remove(fileName) | ||
|
|
||
| if err == nil { | ||
| fmt.Printf("Successfully removed file:%s", fileName) | ||
| } | ||
|
|
||
| return "", err | ||
| }) | ||
| } | ||
|
|
||
| func main() { | ||
| app := gofr.NewCMD() | ||
|
|
||
| fileSystemProvider := configureFileServer(app) | ||
|
|
||
| app.AddFileStore(fileSystemProvider) | ||
|
|
||
| registerPwdCommand(app, fileSystemProvider) | ||
|
|
||
| registerLsCommand(app, fileSystemProvider) | ||
|
|
||
| registerGrepCommand(app, fileSystemProvider) | ||
|
|
||
| registerCreateFileCommand(app, fileSystemProvider) | ||
|
|
||
| registerRmCommand(app, fileSystemProvider) | ||
|
|
||
| app.Run() | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,155 @@ | ||
| package main | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "os" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| "go.uber.org/mock/gomock" | ||
| "gofr.dev/pkg/gofr" | ||
| "gofr.dev/pkg/gofr/datasource/file" | ||
| "gofr.dev/pkg/gofr/testutil" | ||
| ) | ||
|
|
||
| type mockFileInfo struct { | ||
| name string | ||
| } | ||
|
|
||
| func (m mockFileInfo) Name() string { return m.name } | ||
| func (mockFileInfo) Size() int64 { return 0 } | ||
| func (mockFileInfo) Mode() os.FileMode { return 0 } | ||
| func (mockFileInfo) ModTime() time.Time { return time.Now() } | ||
| func (mockFileInfo) IsDir() bool { return false } | ||
| func (mockFileInfo) Sys() interface{} { return nil } | ||
|
|
||
| func TestPwdCommand(t *testing.T) { | ||
| os.Args = []string{"command", "pwd"} | ||
| logs := testutil.StdoutOutputForFunc(func() { | ||
| ctrl := gomock.NewController(t) | ||
| defer ctrl.Finish() | ||
|
|
||
| app := gofr.NewCMD() | ||
| mock := file.NewMockFileSystemProvider(ctrl) | ||
|
|
||
| mock.EXPECT().UseLogger(app.Logger()) | ||
| mock.EXPECT().UseMetrics(app.Metrics()) | ||
| mock.EXPECT().Connect() | ||
| mock.EXPECT().Getwd().DoAndReturn(func() (string, error) { | ||
| return "/", nil | ||
| }) | ||
| app.AddFileStore(mock) | ||
| registerPwdCommand(app, mock) | ||
| app.Run() | ||
| }) | ||
| assert.Contains(t, logs, "/", "Test failed") | ||
| } | ||
|
|
||
| func TestLSCommand(t *testing.T) { | ||
| path := "/" | ||
| os.Args = []string{"command", "ls", fmt.Sprintf("-path=%s", path)} | ||
| logs := testutil.StdoutOutputForFunc(func() { | ||
| ctrl := gomock.NewController(t) | ||
| defer ctrl.Finish() | ||
|
|
||
| app := gofr.NewCMD() | ||
| mock := file.NewMockFileSystemProvider(ctrl) | ||
|
|
||
| mock.EXPECT().UseLogger(app.Logger()) | ||
| mock.EXPECT().UseMetrics(app.Metrics()) | ||
| mock.EXPECT().Connect() | ||
| mock.EXPECT().ReadDir(path).DoAndReturn(func(_ string) ([]file.FileInfo, error) { | ||
| files := []file.FileInfo{ | ||
| mockFileInfo{name: "file1.txt"}, | ||
| mockFileInfo{name: "file2.txt"}, | ||
| } | ||
|
|
||
| return files, nil | ||
| }) | ||
| app.AddFileStore(mock) | ||
| registerLsCommand(app, mock) | ||
| app.Run() | ||
| }) | ||
| assert.Contains(t, logs, "file1.txt", "Test failed") | ||
| assert.Contains(t, logs, "file2.txt", "Test failed") | ||
| assert.NotContains(t, logs, "file3.txt", "Test failed") | ||
| } | ||
|
|
||
| func TestGrepCommand(t *testing.T) { | ||
| path := "/" | ||
| os.Args = []string{"command", "grep", "-keyword=fi", fmt.Sprintf("-path=%s", path)} | ||
| logs := testutil.StdoutOutputForFunc(func() { | ||
| ctrl := gomock.NewController(t) | ||
| defer ctrl.Finish() | ||
|
|
||
| app := gofr.NewCMD() | ||
| mock := file.NewMockFileSystemProvider(ctrl) | ||
|
|
||
| mock.EXPECT().UseLogger(app.Logger()) | ||
| mock.EXPECT().UseMetrics(app.Metrics()) | ||
| mock.EXPECT().Connect() | ||
| mock.EXPECT().ReadDir("/").DoAndReturn(func(_ string) ([]file.FileInfo, error) { | ||
| files := []file.FileInfo{ | ||
| mockFileInfo{name: "file1.txt"}, | ||
| mockFileInfo{name: "file2.txt"}, | ||
| } | ||
|
|
||
| return files, nil | ||
| }) | ||
| app.AddFileStore(mock) | ||
| registerGrepCommand(app, mock) | ||
| app.Run() | ||
| }) | ||
| assert.Contains(t, logs, "file1.txt", "Test failed") | ||
| assert.Contains(t, logs, "file2.txt", "Test failed") | ||
| assert.NotContains(t, logs, "file3.txt", "Test failed") | ||
| } | ||
|
|
||
| func TestCreateFileCommand(t *testing.T) { | ||
| fileName := "file.txt" | ||
| os.Args = []string{"command", "createfile", fmt.Sprintf("-filename=%s", fileName)} | ||
| logs := testutil.StdoutOutputForFunc(func() { | ||
| ctrl := gomock.NewController(t) | ||
| defer ctrl.Finish() | ||
|
|
||
| app := gofr.NewCMD() | ||
| mock := file.NewMockFileSystemProvider(ctrl) | ||
|
|
||
| mock.EXPECT().UseLogger(app.Logger()) | ||
| mock.EXPECT().UseMetrics(app.Metrics()) | ||
| mock.EXPECT().Connect() | ||
| mock.EXPECT().Create(fileName).DoAndReturn(func(_ string) (file.File, error) { | ||
| return &file.MockFile{}, nil | ||
| }) | ||
| app.AddFileStore(mock) | ||
| registerCreateFileCommand(app, mock) | ||
| app.Run() | ||
| }) | ||
| assert.Contains(t, logs, "Creating file :file.txt", "Test failed") | ||
| assert.Contains(t, logs, "Successfully created file:file.txt", "Test failed") | ||
| } | ||
|
|
||
| func TestRmCommand(t *testing.T) { | ||
| fileName := "file.txt" | ||
| os.Args = []string{"command", "rm", fmt.Sprintf("-filename=%s", fileName)} | ||
| logs := testutil.StdoutOutputForFunc(func() { | ||
| ctrl := gomock.NewController(t) | ||
| defer ctrl.Finish() | ||
|
|
||
| app := gofr.NewCMD() | ||
| mock := file.NewMockFileSystemProvider(ctrl) | ||
|
|
||
| mock.EXPECT().UseLogger(app.Logger()) | ||
| mock.EXPECT().UseMetrics(app.Metrics()) | ||
| mock.EXPECT().Connect() | ||
| mock.EXPECT().Remove("file.txt").DoAndReturn(func(_ string) error { | ||
| return nil | ||
| }) | ||
| app.AddFileStore(mock) | ||
| registerRmCommand(app, mock) | ||
| app.Run() | ||
| }) | ||
| assert.Contains(t, logs, "Removing file :file.txt", "Test failed") | ||
| assert.Contains(t, logs, "Successfully removed file:file.txt", "Test failed") | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This needs refactoring, as it seems duplicate.. Also, in below snapshot please see that copy button will copy complete block to clipboard and it won't be useful for user. Ideally, we should only add required command reference, so user can just copy and change filePath.