kyle comments + add test

coadler · coadler · commit db92f72f4685 · 2022-05-17T14:18:09.000-05:00
diff --git a/provisionerd/provisionerd.go b/provisionerd/provisionerd.go
@@ -452,6 +452,8 @@ func (p *Server) runJob(ctx context.Context, job *proto.AcquiredJob) {
 	}
 }
 
+// ReadmeFile is the location we look for to extract documentation from template
+// versions.
 const ReadmeFile = "README.md"
 
 func (p *Server) runReadmeParse(ctx context.Context, job *proto.AcquiredJob) {
@@ -467,7 +469,7 @@ func (p *Server) runReadmeParse(ctx context.Context, job *proto.AcquiredJob) {
 			JobId: job.GetJobId(),
 			Logs: []*proto.Log{{
 				Source:    proto.LogSource_PROVISIONER_DAEMON,
-				Level:     sdkproto.LogLevel_INFO,
+				Level:     sdkproto.LogLevel_DEBUG,
 				Stage:     "No README.md provided",
 				CreatedAt: time.Now().UTC().UnixMilli(),
 			}},
@@ -484,7 +486,7 @@ func (p *Server) runReadmeParse(ctx context.Context, job *proto.AcquiredJob) {
 		Logs: []*proto.Log{{
 			Source:    proto.LogSource_PROVISIONER_DAEMON,
 			Level:     sdkproto.LogLevel_INFO,
-			Stage:     "README.md detected",
+			Stage:     "Adding README.md...",
 			CreatedAt: time.Now().UTC().UnixMilli(),
 		}},
 		Readme: fi,
diff --git a/provisionerd/provisionerd_test.go b/provisionerd/provisionerd_test.go
@@ -214,6 +214,7 @@ func TestProvisionerd(t *testing.T) {
 			didLog        atomic.Bool
 			didAcquireJob atomic.Bool
 			didDryRun     atomic.Bool
+			didReadme     atomic.Bool
 			completeChan  = make(chan struct{})
 			completeOnce  sync.Once
 		)
@@ -230,7 +231,8 @@ func TestProvisionerd(t *testing.T) {
 						JobId:       "test",
 						Provisioner: "someprovisioner",
 						TemplateSourceArchive: createTar(t, map[string]string{
-							"test.txt": "content",
+							"test.txt":              "content",
+							provisionerd.ReadmeFile: "# A cool template 😎",
 						}),
 						Type: &proto.AcquiredJob_TemplateImport_{
 							TemplateImport: &proto.AcquiredJob_TemplateImport{
@@ -240,9 +242,12 @@ func TestProvisionerd(t *testing.T) {
 					}, nil
 				},
 				updateJob: func(ctx context.Context, update *proto.UpdateJobRequest) (*proto.UpdateJobResponse, error) {
-					if len(update.Logs) != 0 {
+					if len(update.Logs) > 0 {
 						didLog.Store(true)
 					}
+					if len(update.Readme) > 0 {
+						didReadme.Store(true)
+					}
 					return &proto.UpdateJobResponse{}, nil
 				},
 				completeJob: func(ctx context.Context, job *proto.CompletedJob) (*proto.Empty, error) {
