Allow to omit channel topic update

chargefox · Jan 7, 2021 · 871f1c0 · 871f1c0
1 parent a1d22f7
commit 871f1c0
Show file tree

Hide file tree

Showing 4 changed files with 45 additions and 45 deletions.
diff --git a/README.md b/README.md
@@ -8,15 +8,15 @@ Right now, the only supported target is Slack: given a list of PageDuty schedule
 
 You will need to create a Slack app with the following scopes
 
-| Scope              | Optional | Used for                          |
-|--------------------|----------|-----------------------------------|
-| `users:read`       | no       |                                   |
-| `channels:read`    | no       |                                   |
-| `channels:manage`  | no       |                                   |
-| `groups:read`      | yes      | interacting with private channels |
-| `groups:write`     | yes      | interacting with private channels |
-| `usergroups:read`  | yes      | managing user groups              |
-| `usergroups:write` | yes      | managing user groups              |
+| Scope              | Optional | Used for                           |
+|--------------------|----------|------------------------------------|
+| `users:read`       | no       |                                    |
+| `channels:read`    | yes      | managing topics (public channels)  |
+| `channels:manage`  | yes      | managing topics (public channels)  |
+| `groups:read`      | yes      | managing topics (private channels) |
+| `groups:write`     | yes      | managing topics (private channels) |
+| `usergroups:read`  | yes      | managing user groups               |
+| `usergroups:write` | yes      | managing user groups               |
 
 and invite it to the target channel.
 

diff --git a/config.go b/config.go
@@ -180,10 +180,6 @@ func parseSchedule(schedule string) (ConfigSchedule, error) {
 		delete(kvs, "name")
 	}
 
-	if id == "" && name == "" {
-			return ConfigSchedule{}, errors.New(`one of "id" or "name" must be given`)
-	}
-
 	if id != "" && name != "" {
 		return ConfigSchedule{}, errors.New(`"id" and "name" cannot be specified simultaneously`)
 	}
@@ -242,12 +238,13 @@ func validateConfig(cfg *config) error {
 			}
 		}
 
-		if sync.Channel.ID == "" && sync.Channel.Name == "" {
-			return fmt.Errorf("slack sync %q invalid: must specify either channel ID or channel name", sync.Name)
-		}
-
-		if sync.Template == "" {
-			return fmt.Errorf("slack sync %q invalid: template is missing", sync.Name)
+		channelGiven := sync.Channel.ID != "" || sync.Channel.Name != ""
+		if sync.Template != "" {
+			if !channelGiven {
+				return fmt.Errorf("slack sync %q invalid: must specify either channel ID or channel name when topic is given", sync.Name)
+			}
+		} else if channelGiven {
+			return fmt.Errorf("slack sync %q invalid: must specify template when either channel ID or channel name is given", sync.Name)
 		}
 	}
 

diff --git a/config_test.go b/config_test.go
@@ -29,11 +29,6 @@ func TestParseSchedule(t *testing.T) {
 			inSchedule: "name=schedule1;name=schedule2",
 			wantErrStr: `multiple values for key "name" not allowed`,
 		},
-		{
-			name:       "none of id or name specifiers given",
-			inSchedule: "foo=bar",
-			wantErrStr: `one of "id" or "name" must be given`,
-		},
 		{
 			name:       "id and name specifiers given",
 			inSchedule: "id=schedule;name=schedule",

diff --git a/syncer.go b/syncer.go
@@ -12,7 +12,6 @@ type runSlackSync struct {
 	name           string
 	pdSchedules    pdSchedules
 	slackChannelID string
-	//userGroupsBySchedule map[string]UserGroups
 	tmpl           *template.Template
 	dryRun         bool
 }
@@ -32,12 +31,22 @@ func (sp syncerParams) createSlackSyncs(ctx context.Context, cfg config) ([]runS
 			dryRun: cfgSlSync.DryRun,
 		}
 
-		slChannel, err := sp.slClient.getChannel(ctx, cfgSlSync.Channel.Name, cfgSlSync.Channel.ID)
-		if err != nil {
-			return nil, fmt.Errorf("failed to create slack sync %q: failed to get Slack channel: %s", slSync.name, err)
+		if cfgSlSync.Template == "" {
+			fmt.Printf("Slack sync %s: skipping topic handling because template is undefined\n", slSync.name)
+		} else {
+			var err error
+			slSync.tmpl, err = template.New("topic").Parse(cfgSlSync.Template)
+			if err != nil {
+				return nil, fmt.Errorf("failed to create slack sync %q: failed to parse template %q: %s", slSync.name, cfgSlSync.Template, err)
+			}
+
+			slChannel, err := sp.slClient.getChannel(ctx, cfgSlSync.Channel.Name, cfgSlSync.Channel.ID)
+			if err != nil {
+				return nil, fmt.Errorf("failed to create slack sync %q: failed to get Slack channel: %s", slSync.name, err)
+			}
+			slSync.slackChannelID = slChannel.ID
+			fmt.Printf("Slack sync %s: found Slack channel %q (ID %s)\n", slSync.name, slChannel.Name, slChannel.ID)
 		}
-		slSync.slackChannelID = slChannel.ID
-		fmt.Printf("Slack sync %s: found Slack channel %q (ID %s)\n", slSync.name, slChannel.Name, slChannel.ID)
 
 		pdSchedules := pdSchedules{}
 		fmt.Printf("Slack sync %s: Getting PagerDuty schedules\n", slSync.name)
@@ -72,11 +81,6 @@ func (sp syncerParams) createSlackSyncs(ctx context.Context, cfg config) ([]runS
 		slSync.pdSchedules = pdSchedules
 		fmt.Printf("Slack sync %s: found %d PagerDuty schedule(s)\n", slSync.name, len(pdSchedules))
 
-		slSync.tmpl, err = template.New("topic").Parse(cfgSlSync.Template)
-		if err != nil {
-			return nil, fmt.Errorf("failed to create slack sync %q: failed to parse template %q: %s", slSync.name, cfgSlSync.Template, err)
-		}
-
 		slSyncs = append(slSyncs, slSync)
 	}
 
@@ -134,17 +138,21 @@ func (s *syncer) runSlackSync(ctx context.Context, slackSync runSlackSync) error
 		return fmt.Errorf("failed to update on-call user group members: %s", err)
 	}
 
-	var buf bytes.Buffer
-	fmt.Printf("Executing template with Slack user IDs by schedule name: %s\n", slackUserIDByScheduleName)
-	err := slackSync.tmpl.Execute(&buf, slackUserIDByScheduleName)
-	if err != nil {
-		return fmt.Errorf("failed to render template: %s", err)
-	}
+	if slackSync.tmpl == nil {
+		fmt.Println("Skipping topic update")
+	} else {
+		var buf bytes.Buffer
+		fmt.Printf("Executing template with Slack user IDs by schedule name: %s\n", slackUserIDByScheduleName)
+		err := slackSync.tmpl.Execute(&buf, slackUserIDByScheduleName)
+		if err != nil {
+			return fmt.Errorf("failed to render template: %s", err)
+		}
 
-	topic := buf.String()
-	err = s.slClient.updateTopic(ctx, slackSync.slackChannelID, topic, slackSync.dryRun)
-	if err != nil {
-		return fmt.Errorf("failed to update topic: %s", err)
+		topic := buf.String()
+		err = s.slClient.updateTopic(ctx, slackSync.slackChannelID, topic, slackSync.dryRun)
+		if err != nil {
+			return fmt.Errorf("failed to update topic: %s", err)
+		}
 	}
 
 	return nil