Merge pull request #46 from shanep/add-logging-clone

Add logging clone for issue #4

Author: zrdaley

cmd/gh-classroom/clone/student-repos/student-repos.go

@@ -88,11 +88,13 @@ func NewCmdStudentRepo(f *cmdutil.Factory) *cobra.Command {
 				}
 			}
 
+			totalCloned := 0
 			for _, acceptAssignment := range acceptedAssignmentList.AcceptedAssignments {
 				clonePath := filepath.Join(fullPath, acceptAssignment.Repository.Name())
 				if _, err := os.Stat(clonePath); os.IsNotExist(err) {
 					fmt.Printf("Cloning into: %v\n", clonePath)
 					_, _, err := gh.Exec("repo", "clone", acceptAssignment.Repository.FullName, "--", clonePath)
+					totalCloned++
 					if err != nil {
 						log.Fatal(err)
 						return
@@ -101,6 +103,12 @@ func NewCmdStudentRepo(f *cmdutil.Factory) *cobra.Command {
 					fmt.Printf("Skip existing repo: %v use gh classroom pull to get new commits\n", clonePath)
 				}
 			}
+			if getAll {
+				fmt.Printf("Cloned %v repos.\n", totalCloned)
+			} else {
+				numPages, _ := shared.NumberOfAcceptedAssignmentsAndPages(client, assignmentId, perPage)
+				fmt.Printf("Cloned %v repos. There are %v more pages of repos to clone.\n", totalCloned, numPages-page)
+			}
 		},
 	}
 

cmd/gh-classroom/shared/shared.go

@@ -2,6 +2,7 @@ package shared
 
 import (
 	"errors"
+	"log"
 	"math"
 	"sync"
 
@@ -97,6 +98,18 @@ func PromptForAssignment(client api.RESTClient, classroomId int) (assignment cla
 	return optionMap[answer.Assignment], nil
 }
 
+// Get the total number of accepted assignments and the number of pages necessary to get them all
+// Calculate the number of pages necessary to get all of the assignments with a given perPage
+func NumberOfAcceptedAssignmentsAndPages(client api.RESTClient, assignmentID int, perPage int) (numPages, totalAccepted int) {
+	assignment, err := classroom.GetAssignment(client, assignmentID)
+	if err != nil {
+		log.Fatal(err)
+	}
+	numPages = int(math.Ceil(float64(assignment.Accepted) / float64(perPage)))
+	totalAccepted = assignment.Accepted
+	return
+}
+
 func ListAcceptedAssignments(client api.RESTClient, assignmentID int, page int, perPage int) (classroom.AcceptedAssignmentList, error) {
 	response, err := classroom.GetAssignmentList(client, assignmentID, page, perPage)
 	if err != nil {
@@ -118,17 +131,11 @@ type assignmentList struct {
 
 func ListAllAcceptedAssignments(client api.RESTClient, assignmentID int, perPage int) (classroom.AcceptedAssignmentList, error) {
 
-	//Calculate the number of go channels to create. We will assign 1 channel per page
-	//so we don't put too much pressure on the API all at once
-	assignment, err := classroom.GetAssignment(client, assignmentID)
-	if err != nil {
-		return classroom.AcceptedAssignmentList{}, err
-	}
-	numChannels := int(math.Ceil(float64(assignment.Accepted) / float64(perPage)))
+	numPages, totalAccepted := NumberOfAcceptedAssignmentsAndPages(client, assignmentID, perPage)
 
 	ch := make(chan assignmentList)
 	var wg sync.WaitGroup
-	for page := 1; page <= numChannels; page++ {
+	for page := 1; page <= numPages; page++ {
 		wg.Add(1)
 		go func(pg int) {
 			defer wg.Done()
@@ -141,9 +148,9 @@ func ListAllAcceptedAssignments(client api.RESTClient, assignmentID int, perPage
 	}
 
 	var mu sync.Mutex
-	assignments := make([]classroom.AcceptedAssignment, 0, assignment.Accepted)
+	assignments := make([]classroom.AcceptedAssignment, 0, totalAccepted)
 	var hadErr error = nil
-	for page := 1; page <= numChannels; page++ {
+	for page := 1; page <= numPages; page++ {
 		wg.Add(1)
 		go func() {
 			defer wg.Done()
@@ -162,7 +169,7 @@ func ListAllAcceptedAssignments(client api.RESTClient, assignmentID int, perPage
 	close(ch)
 
 	if hadErr != nil {
-		return classroom.AcceptedAssignmentList{}, err
+		return classroom.AcceptedAssignmentList{}, hadErr
 	}
 
 	return classroom.NewAcceptedAssignmentList(assignments), nil

cmd/gh-classroom/shared/shared_test.go

@@ -1,13 +1,49 @@
 package shared
 
 import (
+	"sort"
 	"testing"
 
 	"github.com/cli/go-gh"
 	"github.com/stretchr/testify/assert"
 	"gopkg.in/h2non/gock.v1"
 )
 
+func TestNumberOfAcceptedAssignmentsAndPages(t *testing.T) {
+	t.Setenv("GITHUB_TOKEN", "999")
+	defer gock.Off()
+
+	gock.New("https://api.github.com").
+		Get("/assignments/1").
+		Reply(200).
+		JSON(`{"id": 1,
+		"title": "Assignment 1",
+		"description": "This is the first assignment",
+		"due_date": "2018-01-01",
+		"accepted": 2,
+		"classroom": {
+			"id": 1,
+			"name":      "Classroom Name"
+		},
+		"starter_code_repository": {
+			"id": 1,
+			"full_name": "org1/starter-code-repo"
+		}
+	}`)
+	client, err := gh.RESTClient(nil)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	numPages, totalAccepted := NumberOfAcceptedAssignmentsAndPages(client, 1, 1)
+	assert.Equal(t, 2, numPages)
+	assert.Equal(t, 2, totalAccepted)
+
+	if err != nil {
+		t.Fatal(err)
+	}
+}
+
 func TestListAcceptedAssignments(t *testing.T) {
 	t.Setenv("GITHUB_TOKEN", "999")
 	defer gock.Off()
@@ -192,6 +228,12 @@ func TestListAllAcceptedAssignments(t *testing.T) {
 		t.Fatal(err)
 	}
 
+	//Due to ListAllAcceptedAssignments using channels we can not guarantee the order of the results
+	//so we need to sort the results before we can compare them to the expected results
+	sort.Slice(actual.AcceptedAssignments, func(i, j int) bool {
+		return actual.AcceptedAssignments[i].Id < actual.AcceptedAssignments[j].Id
+	})
+
 	assert.Equal(t, 2, actual.Count)
 	assert.Equal(t, 1, actual.AcceptedAssignments[0].Id)
 	assert.Equal(t, "org1/student1-repo", actual.AcceptedAssignments[0].Repository.FullName)