This is an automated email from the ASF dual-hosted git repository.

klesh pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake.git


The following commit(s) were added to refs/heads/main by this push:
     new 399eeaa29 fix(gitextractor): update log, print raw error detail (#7181)
399eeaa29 is described below

commit 399eeaa2952eb2be55a79799326d6625f7018ba7
Author: Lynwee <[email protected]>
AuthorDate: Mon Mar 18 11:03:03 2024 +0800

    fix(gitextractor): update log, print raw error detail (#7181)
    
    * fix(gitextractor): update log, print raw error detail
    
    * fix(gitextractor): remove user password from errors when cloning repos
    
    * fix(gitextractor): fix lint error
    
    * fix(gitextractor): add test case
    
    ---------
    
    Co-authored-by: houlinwei <[email protected]>
---
 backend/plugins/gitextractor/parser/clone.go      | 34 ++++++++++++++++++---
 backend/plugins/gitextractor/parser/clone_test.go | 37 +++++++++++++++++++++++
 2 files changed, 66 insertions(+), 5 deletions(-)

diff --git a/backend/plugins/gitextractor/parser/clone.go 
b/backend/plugins/gitextractor/parser/clone.go
index 809aeaafd..65ae8ee98 100644
--- a/backend/plugins/gitextractor/parser/clone.go
+++ b/backend/plugins/gitextractor/parser/clone.go
@@ -22,6 +22,7 @@ import (
        "context"
        "crypto/tls"
        "encoding/base64"
+       goerrors "errors"
        "fmt"
        "github.com/apache/incubator-devlake/core/errors"
        "github.com/apache/incubator-devlake/core/plugin"
@@ -122,11 +123,7 @@ func (l *GitRepoCreator) cloneOverHTTP(ctx 
plugin.SubTaskContext, withGoGit bool
                done <- struct{}{}
                if err != nil {
                        // Some sensitive information such as password will be 
released in this err.
-                       if err.Error() == "repository not found" {
-                               // do nothing, it's a safe error message.
-                       } else {
-                               err = fmt.Errorf("plain clone git error")
-                       }
+                       err = removePasswordFromError(err, password, url)
                        l.logger.Error(err, "PlainCloneContext")
                        return nil, err
                }
@@ -219,3 +216,30 @@ func withTempDirectory(f func(tempDir string) 
(RepoCollector, error)) (RepoColle
        }
        return repo, nil
 }
+
+func removePasswordFromError(err error, password string, gitUrl string) error {
+       if err == nil {
+               return err
+       }
+       newErrMsg := err.Error()
+       var candidatePassword []string
+       if password != "" {
+               candidatePassword = append(candidatePassword, password)
+       }
+       if gitUrl != "" {
+               url, err := neturl.Parse(gitUrl)
+               if err == nil && url != nil && url.User != nil {
+                       passwordInGitUrl, ok := url.User.Password()
+                       if ok && passwordInGitUrl != "" {
+                               candidatePassword = append(candidatePassword, 
passwordInGitUrl)
+                       }
+               }
+       }
+       for _, passwd := range candidatePassword {
+               newErrMsg = strings.Replace(newErrMsg, passwd, 
strings.Repeat("*", len(password)), -1)
+       }
+       if newErrMsg == err.Error() {
+               return err
+       }
+       return goerrors.New(newErrMsg)
+}
diff --git a/backend/plugins/gitextractor/parser/clone_test.go 
b/backend/plugins/gitextractor/parser/clone_test.go
index 3e63e2af6..620130017 100644
--- a/backend/plugins/gitextractor/parser/clone_test.go
+++ b/backend/plugins/gitextractor/parser/clone_test.go
@@ -19,12 +19,15 @@ package parser
 
 import (
        gocontext "context"
+       "errors"
+       "fmt"
        "github.com/apache/incubator-devlake/core/config"
        "github.com/apache/incubator-devlake/core/context"
        "github.com/apache/incubator-devlake/core/dal"
        "github.com/apache/incubator-devlake/core/log"
        "github.com/apache/incubator-devlake/core/plugin"
        "github.com/apache/incubator-devlake/impls/dalgorm"
+       "github.com/stretchr/testify/assert"
        "gorm.io/driver/mysql"
        "gorm.io/gorm"
        "testing"
@@ -138,3 +141,37 @@ func (ctx *testSubTaskContext) TaskContext() 
plugin.TaskContext {
        //TODO implement me
        panic("implement me")
 }
+
+func Test_removePasswordFromErro1r(t *testing.T) {
+       type args struct {
+               err      error
+               password string
+               gitUrl   string
+       }
+       err := errors.New("some errors occurred when requesting 
http://devlakeuser:[email protected]/repos";)
+       tests := []struct {
+               name    string
+               args    args
+               wantErr assert.ErrorAssertionFunc
+       }{
+               {
+                       name: "test-0",
+                       args: args{
+                               err:      err,
+                               password: "password",
+                               gitUrl:   
"http://devlakeuser:[email protected]/repos";,
+                       },
+                       wantErr: func(t assert.TestingT, err error, i 
...interface{}) bool {
+                               return err.Error() == "some errors occurred 
when requesting http://devlakeuser:********@127.0.0.1/repos";
+                       },
+               },
+       }
+       for _, tt := range tests {
+               t.Run(tt.name, func(t *testing.T) {
+                       err = removePasswordFromError(tt.args.err, 
tt.args.password, tt.args.gitUrl)
+                       t.Logf("removePasswordFromError return err: %s", err)
+                       fmt.Printf("removePasswordFromError return err: %s\n", 
err)
+                       tt.wantErr(t, err)
+               })
+       }
+}

Reply via email to