Merge pull request #36 from kyoshidajp/care_github_token_error

Care GitHub token error

Author: kyoshidajp

.gitignore

@@ -1,6 +1,7 @@
 .DS_Store
 .vscode/
 .env
+.env.invalid
 .envrc
 
 cover.html

cmd/diagnose.go

@@ -9,11 +9,9 @@ import (
 	"strings"
 	"sync"
 
-	"github.com/MakeNowJust/heredoc"
 	"github.com/aquasecurity/go-dep-parser/pkg/io"
 	parser_io "github.com/aquasecurity/go-dep-parser/pkg/io"
 	"github.com/aquasecurity/go-dep-parser/pkg/types"
-	"github.com/fatih/color"
 	dart "github.com/kyoshidajp/dep-doctor/cmd/dart/pub"
 	erlang_elixir "github.com/kyoshidajp/dep-doctor/cmd/erlang_elixir/hex"
 	"github.com/kyoshidajp/dep-doctor/cmd/github"
@@ -68,6 +66,15 @@ func (p RepositoryParams) SearchableParams() []github.FetchRepositoryParam {
 	return params
 }
 
+func Prepare() error {
+	token := os.Getenv(github.TOKEN_NAME)
+	if len(token) == 0 {
+		m := fmt.Sprintf("The Environment variable `%s` is not set. It must be set before execution. For example, please refer to https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens", github.TOKEN_NAME)
+		return errors.New(m)
+	}
+	return nil
+}
+
 func FetchRepositoryParams(libs []types.Library, d Doctor) RepositoryParams {
 	var params []github.FetchRepositoryParam
 	var wg sync.WaitGroup
@@ -157,6 +164,7 @@ func Diagnose(d Doctor, r io.ReadSeekCloserAt, year int, ignores []string) map[s
 					Ignored:   isIgnore,
 					Diagnosed: true,
 					IsActive:  r.IsActive(year),
+					Error:     r.Error,
 				}
 				diagnoses[r.Name] = diagnosis
 			}
@@ -180,6 +188,11 @@ func Diagnose(d Doctor, r io.ReadSeekCloserAt, year int, ignores []string) map[s
 	return diagnoses
 }
 
+func Report(diagnoses map[string]Diagnosis, strict_mode bool) error {
+	reporter := NewStdoutReporter(diagnoses, strict_mode)
+	return reporter.Report()
+}
+
 type Options struct {
 	packageManager string
 	filePath       string
@@ -231,6 +244,10 @@ var diagnoseCmd = &cobra.Command{
 	Use:   "diagnose",
 	Short: "Diagnose dependencies",
 	Run: func(cmd *cobra.Command, args []string) {
+		if err := Prepare(); err != nil {
+			log.Fatal(err)
+		}
+
 		doctor, ok := doctors[o.packageManager]
 		if !ok {
 			m := doctors.UnknownErrorMessage(o.packageManager)
@@ -269,66 +286,3 @@ func init() {
 		fmt.Println(err.Error())
 	}
 }
-
-func Report(diagnoses map[string]Diagnosis, strict_mode bool) error {
-	errMessages, warnMessages, ignoredMessages := []string{}, []string{}, []string{}
-	errCount, warnCount, infoCount := 0, 0, 0
-	unDiagnosedCount, ignoredCount := 0, 0
-
-	lib_names := make([]string, 0, len(diagnoses))
-	for key := range diagnoses {
-		lib_names = append(lib_names, key)
-	}
-	sort.Strings(lib_names)
-
-	for _, lib_name := range lib_names {
-		diagnosis := diagnoses[lib_name]
-		if diagnosis.Ignored {
-			ignoredMessages = append(ignoredMessages, fmt.Sprintf("[info] %s (ignored):", diagnosis.Name))
-			ignoredCount += 1
-			infoCount += 1
-			continue
-		}
-
-		if !diagnosis.Diagnosed {
-			warnMessages = append(warnMessages, fmt.Sprintf("[warn] %s (unknown): %s", diagnosis.Name, diagnosis.ErrorMessage()))
-			unDiagnosedCount += 1
-			warnCount += 1
-			continue
-		}
-		if diagnosis.Archived {
-			errMessages = append(errMessages, fmt.Sprintf("[error] %s (archived): %s", diagnosis.Name, diagnosis.URL))
-			errCount += 1
-		}
-		if !diagnosis.IsActive {
-			warnMessages = append(warnMessages, fmt.Sprintf("[warn] %s (not-maintained): %s", diagnosis.Name, diagnosis.URL))
-			warnCount += 1
-		}
-	}
-
-	fmt.Printf("\n")
-	if len(ignoredMessages) > 0 {
-		fmt.Println(strings.Join(ignoredMessages, "\n"))
-	}
-	if len(warnMessages) > 0 {
-		color.Yellow(strings.Join(warnMessages, "\n"))
-	}
-	if len(errMessages) > 0 {
-		color.Red(strings.Join(errMessages, "\n"))
-	}
-
-	color.Green(heredoc.Docf(`
-		Diagnosis completed! %d libraries.
-		%d error, %d warn (%d unknown), %d info (%d ignored)`,
-		len(diagnoses),
-		errCount,
-		warnCount, unDiagnosedCount,
-		infoCount, ignoredCount),
-	)
-
-	if len(errMessages) > 0 || strict_mode && warnCount > 0 {
-		return errors.New("has error")
-	}
-
-	return nil
-}

cmd/github/github.go

@@ -3,7 +3,6 @@ package github
 import (
 	"context"
 	"fmt"
-	"log"
 	"os"
 	"strings"
 	"time"
@@ -25,6 +24,7 @@ type GitHubRepository struct {
 	URL             string
 	Archived        bool
 	LastCommittedAt time.Time
+	Error           error
 }
 
 func (r GitHubRepository) IsActive(year int) bool {
@@ -102,11 +102,6 @@ func ParseGitHubURL(url string) (GitHubRepository, error) {
 
 func FetchFromGitHub(params []FetchRepositoryParam) []GitHubRepository {
 	token := os.Getenv(TOKEN_NAME)
-	if len(token) == 0 {
-		m := fmt.Sprintf("Environment variable `%s` is not found.", TOKEN_NAME)
-		log.Fatal(m)
-	}
-
 	src := oauth2.StaticTokenSource(
 		&oauth2.Token{AccessToken: token},
 	)
@@ -152,8 +147,15 @@ func FetchFromGitHub(params []FetchRepositoryParam) []GitHubRepository {
 	}
 
 	repos := []GitHubRepository{}
+
 	err := client.Query(context.Background(), &query, variables)
 	if err != nil {
+		for _, param := range params {
+			repos = append(repos, GitHubRepository{
+				Name:  param.PackageName,
+				Error: err,
+			})
+		}
 		return repos
 	}
 

cmd/report.go

@@ -0,0 +1,96 @@
+package cmd
+
+import (
+	"errors"
+	"fmt"
+	"sort"
+	"strings"
+
+	"github.com/MakeNowJust/heredoc"
+	"github.com/fatih/color"
+)
+
+type Reporter interface {
+	Report() error
+}
+
+type StdoutReporter struct {
+	diagnoses   map[string]Diagnosis
+	strict_mode bool
+}
+
+func NewStdoutReporter(diagnosis map[string]Diagnosis, strict_mode bool) *StdoutReporter {
+	return &StdoutReporter{
+		diagnoses:   diagnosis,
+		strict_mode: strict_mode,
+	}
+}
+
+func (r *StdoutReporter) Report() error {
+	errMessages, warnMessages, ignoredMessages := []string{}, []string{}, []string{}
+	errCount, warnCount, infoCount := 0, 0, 0
+	unDiagnosedCount, ignoredCount := 0, 0
+
+	lib_names := make([]string, 0, len(r.diagnoses))
+	for key := range r.diagnoses {
+		lib_names = append(lib_names, key)
+	}
+	sort.Strings(lib_names)
+
+	for _, lib_name := range lib_names {
+		diagnosis := r.diagnoses[lib_name]
+		if diagnosis.Ignored {
+			ignoredMessages = append(ignoredMessages, fmt.Sprintf("[info] %s (ignored):", diagnosis.Name))
+			ignoredCount += 1
+			infoCount += 1
+			continue
+		}
+
+		if diagnosis.Error != nil {
+			errMessages = append(errMessages, fmt.Sprintf("[error] %s: %s", diagnosis.Name, diagnosis.Error))
+			errCount += 1
+			continue
+		}
+
+		if !diagnosis.Diagnosed {
+			warnMessages = append(warnMessages, fmt.Sprintf("[warn] %s (unknown): %s", diagnosis.Name, diagnosis.ErrorMessage()))
+			unDiagnosedCount += 1
+			warnCount += 1
+			continue
+		}
+		if diagnosis.Archived {
+			errMessages = append(errMessages, fmt.Sprintf("[error] %s (archived): %s", diagnosis.Name, diagnosis.URL))
+			errCount += 1
+		}
+		if !diagnosis.IsActive {
+			warnMessages = append(warnMessages, fmt.Sprintf("[warn] %s (not-maintained): %s", diagnosis.Name, diagnosis.URL))
+			warnCount += 1
+		}
+	}
+
+	fmt.Printf("\n")
+	if ignoredCount > 0 {
+		fmt.Println(strings.Join(ignoredMessages, "\n"))
+	}
+	if warnCount > 0 {
+		color.Yellow(strings.Join(warnMessages, "\n"))
+	}
+	if errCount > 0 {
+		color.Red(strings.Join(errMessages, "\n"))
+	}
+
+	color.Green(heredoc.Docf(`
+		Diagnosis completed! %d libraries.
+		%d error, %d warn (%d unknown), %d info (%d ignored)`,
+		len(r.diagnoses),
+		errCount,
+		warnCount, unDiagnosedCount,
+		infoCount, ignoredCount),
+	)
+
+	if errCount > 0 || r.strict_mode && warnCount > 0 {
+		return errors.New("has error")
+	}
+
+	return nil
+}