chore(srcfingerprint): squash generic properties of providers

Author: jguerreiro

analyzer.go

@@ -1,4 +1,4 @@
-package dnacollector
+package srcfingerprint
 
 import (
 	git "gopkg.in/src-d/go-git.v4/plumbing/object"

analyzer_test.go

@@ -1,7 +1,6 @@
-package dnacollector_test
+package srcfingerprint
 
 import (
-	"dnacollector"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
@@ -14,7 +13,7 @@ type AnalyzerTestSuite struct {
 }
 
 func (suite *AnalyzerTestSuite) TestAnalyzeCommit() {
-	analyzer := dnacollector.Analyzer{}
+	analyzer := Analyzer{}
 	commit := &object.Commit{
 		Author: object.Signature{
 			Name:  "Author",

cloner.go renamed to cloner/cloner.go

@@ -1,4 +1,4 @@
-package dnacollector
+package cloner
 
 import (
 	"io/ioutil"

extractor.go

@@ -1,4 +1,4 @@
-package dnacollector
+package srcfingerprint
 
 import (
 	"bufio"

go.mod

@@ -1,4 +1,4 @@
-module dnacollector
+module srcfingerprint
 
 go 1.15
 
@@ -10,11 +10,11 @@ require (
 	github.com/google/go-querystring v1.1.0 // indirect
 	github.com/hashicorp/go-cleanhttp v0.5.2 // indirect
 	github.com/kevinburke/ssh_config v1.1.0 // indirect
-	github.com/ldez/go-git-cmd-wrapper/v2 v2.0.0 // indirect
 	github.com/russross/blackfriday/v2 v2.1.0 // indirect
 	github.com/sergi/go-diff v1.2.0 // indirect
 	github.com/sirupsen/logrus v1.8.1
 	github.com/stretchr/testify v1.7.0
+	github.com/suhaibmujahid/go-bitbucket-server v0.1.0
 	github.com/urfave/cli/v2 v2.3.0
 	github.com/xanzy/go-gitlab v0.48.0
 	github.com/xanzy/ssh-agent v0.3.0 // indirect

go.sum

@@ -150,8 +150,6 @@ github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
 github.com/kr/pty v1.1.8/go.mod h1:O1sed60cT9XZ5uDucP5qwvh+TE3NnUj51EiZO/lmSfw=
 github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
 github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
-github.com/ldez/go-git-cmd-wrapper/v2 v2.0.0 h1:WyBXbkLaU1oZlZ5czVgnTmzzSD7hMpPVtdavyVk2+7g=
-github.com/ldez/go-git-cmd-wrapper/v2 v2.0.0/go.mod h1:8IK8SZaL0HgWHK4Gb8byfw2eyYkaBZjZ6fVLt++vQ7Y=
 github.com/mitchellh/go-homedir v1.1.0 h1:lukF9ziXFxDFPkA1vsr5zpc1XuPDn/wFntq5mG+4E0Y=
 github.com/mitchellh/go-homedir v1.1.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrkLzIz1N1q0pr0=
 github.com/pelletier/go-buffruneio v0.2.0/go.mod h1:JkE26KsDizTr40EUHkXVtNPvgGtbSNq5BcowyYOWdKo=
@@ -184,6 +182,8 @@ github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UV
 github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
 github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
 github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+github.com/suhaibmujahid/go-bitbucket-server v0.1.0 h1:gx0F7l5NRzwtGz31lNT3HxqZzxuppWCeZCfhueIhKds=
+github.com/suhaibmujahid/go-bitbucket-server v0.1.0/go.mod h1:Wjot/W+YmE1Y/zWOhJ+VrMG85z9qRB896ZE3RrCSCv0=
 github.com/urfave/cli/v2 v2.3.0 h1:qph92Y649prgesehzOrQjdWyxFOp/QVM+6imKHad91M=
 github.com/urfave/cli/v2 v2.3.0/go.mod h1:LJmUH05zAU44vOAcrfzZQKsZbVcdbOG8rtL3/XcUArI=
 github.com/xanzy/go-gitlab v0.48.0 h1:RP9r4pMDIwE2fbtc+QYiC1euDsPGHcAjPkhje4X3QPU=

notes.md

@@ -2,18 +2,26 @@
 
 ## Name
 
-`src-fingerprint` collect --vcs (GitHub|GitLab|Bitbucket) --object (repository|org|group|instance|org)
+`src-fingerprint` collect --vcs (GitHub|GitLab|Bitbucket) --object (
+
+workflow
+in_review
+0
+0
+
+repository|org|group|instance|org)
+
 ## Testing strategy
 
 - [ ] Test it on multiple os -> Windows, Linux, MacOs
 
-
 ## To Do
+
 - [ ] Support BitBucket
 - [ ] Implement a Redactor class to remove some data (repository name)
-- [ ] Use cobra or other packages for the CLI
-- [ ] Implement CLI entry to scan a repo and not a full org. 
-- [ ]
+- [x] Use cobra or other packages for the CLI
+- [ ] Implement CLI entry to scan a repo and not a full org.
 
 ## CLI implementation
-- [ ] 
+
+- [ ]

pipeline.go

@@ -1,6 +1,8 @@
-package dnacollector
+package srcfingerprint
 
 import (
+	"srcfingerprint/cloner"
+	"srcfingerprint/provider"
 	"sync"
 
 	log "github.com/sirupsen/logrus"
@@ -13,19 +15,19 @@ type PipelineEvent interface{}
 // RepositoryListPipelineEvent is the event fired when the list of repositories has been gathered.
 type RepositoryListPipelineEvent struct {
 	// Repositories is the list of repositories
-	Repositories []GitRepository
+	Repositories []provider.GitRepository
 }
 
 // ResultCommitPipelineEvent represents the event for a result.
 type ResultCommitPipelineEvent struct {
-	Repository GitRepository
+	Repository provider.GitRepository
 	Commit     *object.Commit
 	Author     object.Signature
 	Committer  object.Signature
 }
 
 type ResultGitFilePipelineEvent struct {
-	Repository GitRepository
+	Repository provider.GitRepository
 	GitFile    *GitFile
 }
 
@@ -47,8 +49,8 @@ type CommitPipelineEvent struct {
 
 // Pipeline represents the whole extraction pipeline.
 type Pipeline struct {
-	Provider Provider
-	Cloner   Cloner
+	Provider provider.Provider
+	Cloner   cloner.Cloner
 	Analyzer *Analyzer
 
 	ClonersCount int
@@ -65,7 +67,7 @@ func (p *Pipeline) gather(
 	wg *sync.WaitGroup,
 	eventChan chan<- PipelineEvent,
 	user string,
-	output chan<- GitRepository) {
+	output chan<- provider.GitRepository) {
 	defer wg.Done()
 	defer close(output)
 
@@ -86,7 +88,7 @@ func (p *Pipeline) gather(
 }
 
 // ExtractRepository extracts for a single repository.
-func (p *Pipeline) ExtractRepository(repository GitRepository, eventChan chan<- PipelineEvent) error {
+func (p *Pipeline) ExtractRepository(repository provider.GitRepository, eventChan chan<- PipelineEvent) error {
 	defer p.publishEvent(eventChan, RepositoryPipelineEvent{true, repository.GetName()})
 
 	log.Infof("Cloning repo %v\n", repository.GetName())
@@ -118,7 +120,7 @@ const (
 func (p *Pipeline) ExtractRepositories(user string, eventChan chan<- PipelineEvent) {
 	log.Infof("Extracting user %v\n", user)
 
-	repositoryChannel := make(chan GitRepository)
+	repositoryChannel := make(chan provider.GitRepository)
 
 	extractionWorkersCount := p.ClonersCount
 	if extractionWorkersCount == 0 {

pipeline_test.go

@@ -1,7 +1,9 @@
-package dnacollector
+package srcfingerprint
 
 import (
 	"path/filepath"
+	"srcfingerprint/cloner"
+	"srcfingerprint/provider"
 	"sync"
 	"testing"
 	"time"
@@ -20,12 +22,12 @@ type ProviderMock struct {
 	mock.Mock
 }
 
-func (mock *ProviderMock) Gather(user string) ([]GitRepository, error) {
+func (mock *ProviderMock) Gather(user string) ([]provider.GitRepository, error) {
 	args := mock.Called(user)
-	return args.Get(0).([]GitRepository), args.Error(1)
+	return args.Get(0).([]provider.GitRepository), args.Error(1)
 }
 
-func (mock *ProviderMock) CloneRepository(cloner Cloner, repository GitRepository) (*git.Repository, error) {
+func (mock *ProviderMock) CloneRepository(cloner cloner.Cloner, repository provider.GitRepository) (*git.Repository, error) {
 	args := mock.Called(cloner, repository)
 	return args.Get(0).(*git.Repository), args.Error(1)
 }
@@ -38,7 +40,7 @@ func (m gitRepositoryMock) GetHTTPUrl() string      { return "" }
 func (m gitRepositoryMock) GetCreatedAt() time.Time { return time.Unix(0, 0) }
 func (m gitRepositoryMock) GetStorageSize() int64   { return 0 }
 
-func createGitRepository(name string) GitRepository {
+func createGitRepository(name string) provider.GitRepository {
 	return gitRepositoryMock{name: name}
 }
 
@@ -52,26 +54,26 @@ func openTestGitRepository(t *testing.T) *git.Repository {
 }
 
 func (suite *PipelineTestSuite) TestGather() {
-	outputChan := make(chan GitRepository)
+	outputChan := make(chan provider.GitRepository)
 	wg := &sync.WaitGroup{}
-	provider := &ProviderMock{}
+	providerMock := &ProviderMock{}
 	pipeline := Pipeline{
-		Provider: provider,
+		Provider: providerMock,
 	}
 
-	provider.On("Gather", "user").Return([]GitRepository{createGitRepository("1")}, nil)
+	providerMock.On("Gather", "user").Return([]provider.GitRepository{createGitRepository("1")}, nil)
 
 	wg.Add(1)
 	go pipeline.gather(wg, nil, "user", outputChan)
 
-	repositories := make([]GitRepository, 0, 2)
+	repositories := make([]provider.GitRepository, 0, 2)
 	for output := range outputChan {
 		repositories = append(repositories, output)
 	}
 	wg.Wait()
 
-	provider.AssertExpectations(suite.T())
-	assert.Equal(suite.T(), []GitRepository{gitRepositoryMock{name: "1"}}, repositories)
+	providerMock.AssertExpectations(suite.T())
+	assert.Equal(suite.T(), []provider.GitRepository{gitRepositoryMock{name: "1"}}, repositories)
 }
 
 func (suite *PipelineTestSuite) TestExtractGitRepository() {
@@ -116,17 +118,17 @@ func (suite *PipelineTestSuite) TestExtractGitRepository() {
 func (suite *PipelineTestSuite) TestExtractRepositories() {
 	suite.T().Skip("Skip until repository is stable") // Skip for now
 	eventChan := make(chan PipelineEvent)
-	provider := &ProviderMock{}
+	providerMock := &ProviderMock{}
 	repository := createGitRepository("repoName")
-	pipeline := Pipeline{Provider: provider}
+	pipeline := Pipeline{Provider: providerMock}
 
 	gitRepository := openTestGitRepository(suite.T())
 	commitIter, _ := gitRepository.CommitObjects()
 	// firstCommit, _ := commitIter.Next()
 	commitIter.Close()
 
-	provider.On("Gather", "user").Return([]GitRepository{repository}, nil)
-	provider.On("CloneRepository", nil, repository).Return(gitRepository, nil)
+	providerMock.On("Gather", "user").Return([]provider.GitRepository{repository}, nil)
+	providerMock.On("CloneRepository", nil, repository).Return(gitRepository, nil)
 
 	go func() {
 		defer close(eventChan)
@@ -140,7 +142,7 @@ func (suite *PipelineTestSuite) TestExtractRepositories() {
 	}
 
 	expectedEvents := []PipelineEvent{
-		RepositoryListPipelineEvent{Repositories: []GitRepository{repository}},
+		RepositoryListPipelineEvent{Repositories: []provider.GitRepository{repository}},
 		// ResultPipelineEvent{
 		// 	Repository: repository,
 		// 	Commit:     firstCommit,
@@ -150,7 +152,7 @@ func (suite *PipelineTestSuite) TestExtractRepositories() {
 		RepositoryPipelineEvent{true, "repoName"},
 	}
 
-	provider.AssertExpectations(suite.T())
+	providerMock.AssertExpectations(suite.T())
 	assert.Equal(suite.T(), expectedEvents, events)
 }