config: Update githubRepository to target

Part of the preparation for #11.
mbland · Nov 5, 2017 · cfbf8d3 · cfbf8d3
1 parent 52a5a31
commit cfbf8d3
Show file tree

Hide file tree

Showing 9 changed files with 35 additions and 35 deletions.
diff --git a/config/slack-emoji-issues.json b/config/slack-emoji-issues.json
@@ -8,7 +8,7 @@
   "rules": [
     {
       "reactionName": "book",
-      "githubRepository": "slack-emoji-issues"
+      "target": "slack-emoji-issues"
     }
   ]
 }
diff --git a/lib/config.js b/lib/config.js
@@ -40,7 +40,7 @@ var schema = {
   },
   requiredRulesFields: {
     reactionName: 'name of the reaction emoji triggering the rule',
-    githubRepository: 'GitHub repository to which to post issues'
+    target: 'Repository name or other issue tracking system identifier'
   },
   optionalRulesFields: {
     channelNames: 'names of the Slack channels triggering the rules; ' +
@@ -183,7 +183,7 @@ function checkChannelNamesAreSorted(rules, reactionName, errors) {
 }
 
 function checkForDuplicateRepositories(rules, reactionName, errors) {
-  var duplicateRepos = rules.map(function(r) { return r.githubRepository })
+  var duplicateRepos = rules.map(function(r) { return r.target })
     .sort()
     .filter(detectDuplicates)
 
@@ -225,7 +225,7 @@ function checkForDuplicateAllChannelRules(rules, reactionName, errors) {
 function compareRules(lhs, rhs) {
   return lhs.reactionName.localeCompare(rhs.reactionName) ||
     compareChannelNames(lhs.channelNames, rhs.channelNames) ||
-    lhs.githubRepository.localeCompare(rhs.githubRepository)
+    lhs.target.localeCompare(rhs.target)
 }
 
 function compareChannelNames(lhs, rhs) {

diff --git a/lib/reaction-issue-filer.js b/lib/reaction-issue-filer.js
@@ -159,7 +159,7 @@ Impl.prototype.getReactions = function() {
 
 Impl.prototype.fileIssue = function(getReactionsResponse) {
   var metadata,
-      githubRepository = this.rule.githubRepository
+      target = this.rule.target
 
   if (this.alreadyProcessed(getReactionsResponse)) {
     this.logger.info(this.msgId, 'already processed')
@@ -168,9 +168,9 @@ Impl.prototype.fileIssue = function(getReactionsResponse) {
 
   metadata = parseMetadata(getReactionsResponse, this.channel)
   this.logger.info(this.msgId, 'filing GitHub issue in ' +
-    this.githubClient.collection + '/' + githubRepository)
+    this.githubClient.collection + '/' + target)
 
-  return this.githubClient.fileNewIssue(metadata, githubRepository)
+  return this.githubClient.fileNewIssue(metadata, target)
     .catch(this.abort('failed to create a GitHub issue'))
 }
 

diff --git a/lib/rule.js b/lib/rule.js
@@ -4,14 +4,14 @@ module.exports = Rule
 
 function Rule(configRule) {
   this.reactionName = configRule.reactionName
-  this.githubRepository = configRule.githubRepository
+  this.target = configRule.target
   this.channelNames = configRule.channelNames
 }
 
 Rule.prototype.toLogString = function() {
   var properties = [
     'reactionName: ' + this.reactionName,
-    'githubRepository: ' + this.githubRepository
+    'target: ' + this.target
   ]
 
   if (this.channelNames) {

diff --git a/tests/config-test.js b/tests/config-test.js
@@ -58,7 +58,7 @@ describe('Config', function() {
     configData.rules[0].xyzzy = 'plugh'
     configData.rules.push({
       'reactionName': 'smiley',
-      'githubRepository': 'mbland/slack-emoji-issues',
+      'target': 'mbland/slack-emoji-issues',
       'channelNames': ['hub'],
       'quux': {}
     })
@@ -71,12 +71,12 @@ describe('Config', function() {
     var configData = helpers.baseConfig(),
         errors = [
           'rule 0 missing reactionName',
-          'rule 2 missing githubRepository'
+          'rule 2 missing target'
         ],
         errorMessage = 'Invalid configuration:\n  ' + errors.join('\n  ')
 
     delete configData.rules[0].reactionName
-    delete configData.rules[2].githubRepository
+    delete configData.rules[2].target
 
     expect(function() { return new Config(configData) })
       .to.throw(Error, errorMessage)
@@ -150,14 +150,14 @@ describe('Config', function() {
 
       configData.rules = [
         { reactionName: 'smiley',
-          githubRepository: 'hubot-slack-github-issues'
+          target: 'hubot-slack-github-issues'
         },
         { reactionName: 'evergreen_tree',
-          githubRepository: 'slack-emoji-issues',
+          target: 'slack-emoji-issues',
           channelNames: ['bot-dev']
         },
         { reactionName: 'evergreen_tree',
-          githubRepository: 'handbook'
+          target: 'handbook'
         }
       ]
       errorMessage = 'Invalid configuration:\n' +
@@ -176,14 +176,14 @@ describe('Config', function() {
 
       configData.rules = [
         { reactionName: 'evergreen_tree',
-          githubRepository: 'handbook'
+          target: 'handbook'
         },
         { reactionName: 'evergreen_tree',
-          githubRepository: 'slack-emoji-issues',
+          target: 'slack-emoji-issues',
           channelNames: ['bot-dev']
         },
         { reactionName: 'smiley',
-          githubRepository: 'hubot-slack-github-issues'
+          target: 'hubot-slack-github-issues'
         }
       ]
       errorMessage = 'Invalid configuration:\n' +
@@ -203,15 +203,15 @@ describe('Config', function() {
 
       correctConfig.rules = [
         { reactionName: 'evergreen_tree',
-          githubRepository: 'handbook',
+          target: 'handbook',
           channelNames: ['handbook']
         },
         { reactionName: 'evergreen_tree',
-          githubRepository: 'hub',
+          target: 'hub',
           channelNames: ['hub']
         },
         { reactionName: 'smiley',
-          githubRepository: 'hubot-slack-github-issues'
+          target: 'hubot-slack-github-issues'
         }
       ]
 
@@ -234,9 +234,9 @@ describe('Config', function() {
       var configData = helpers.baseConfig(),
           errorMessage
 
-      configData.rules[0].githubRepository = 'guides'
+      configData.rules[0].target = 'guides'
       configData.rules[0].channelNames = ['wg-testing', 'wg-documentation']
-      configData.rules[1].githubRepository = 'handbook'
+      configData.rules[1].target = 'handbook'
       configData.rules[1].channelNames = ['hub', 'handbook']
       errorMessage = 'Invalid configuration:\n' +
         '  channelNames for evergreen_tree rule 0 are not sorted; expected:\n' +
@@ -254,7 +254,7 @@ describe('Config', function() {
           errorMessage
 
       configData.rules.forEach(function(rule) {
-        rule.githubRepository = 'handbook'
+        rule.target = 'handbook'
       })
       errorMessage = 'Invalid configuration:\n' +
         '  duplicate repositories for evergreen_tree rules:\n' +
@@ -268,7 +268,7 @@ describe('Config', function() {
           errorMessage
 
       configData.rules.forEach(function(rule) {
-        rule.githubRepository = 'handbook'
+        rule.target = 'handbook'
         rule.channelNames = ['hub']
       })
 
@@ -287,9 +287,9 @@ describe('Config', function() {
       var configData = helpers.baseConfig(),
           errorMessage
 
-      configData.rules[0].githubRepository = 'handbook'
+      configData.rules[0].target = 'handbook'
       delete configData.rules[0].channelNames
-      configData.rules[1].githubRepository = 'hub'
+      configData.rules[1].target = 'hub'
 
       errorMessage = 'Invalid configuration:\n' +
         '  multiple all-channel rules defined for evergreen_tree'

diff --git a/tests/helpers/test-config.json b/tests/helpers/test-config.json
@@ -8,18 +8,18 @@
   "rules": [
     {
       "reactionName": "evergreen_tree",
-      "githubRepository": "slack-emoji-issues",
+      "target": "slack-emoji-issues",
       "channelNames": ["bot-dev"]
     },
 
     {
       "reactionName": "evergreen_tree",
-      "githubRepository": "handbook"
+      "target": "handbook"
     },
 
     {
       "reactionName": "smiley",
-      "githubRepository": "hubot-slack-github-issues"
+      "target": "hubot-slack-github-issues"
     }
   ]
 }
diff --git a/tests/integration-test.js b/tests/integration-test.js
@@ -30,7 +30,7 @@ describe('Integration test', function() {
       apiServerDefaults, reactionAddedMessage, patchListenerImpl, sendReaction,
       initLogMessages, wrapInfoMessages,
       matchingRule = 'reactionName: evergreen_tree, ' +
-        'githubRepository: slack-emoji-issues, ' +
+        'target: slack-emoji-issues, ' +
         'channelNames: bot-dev'
 
   before(function() {

diff --git a/tests/reaction-issue-filer-test.js b/tests/reaction-issue-filer-test.js
@@ -44,7 +44,7 @@ describe('ReactionIssueFiler', function() {
           result = reactor.findMatchingRule(message, channelName)
 
       result.reactionName.should.equal(expected.reactionName)
-      result.githubRepository.should.equal(expected.githubRepository)
+      result.target.should.equal(expected.target)
       result.should.not.have.property('channelName')
     })
 

diff --git a/tests/rule-test.js b/tests/rule-test.js
@@ -8,7 +8,7 @@ describe('Rule', function() {
   var makeConfigRule = function() {
     return {
       reactionName: 'evergreen_tree',
-      githubRepository: 'slack-emoji-issues',
+      target: 'slack-emoji-issues',
       channelNames: ['bot-dev']
     }
   }
@@ -34,7 +34,7 @@ describe('Rule', function() {
       configRule.channelNames.push('general')
       expect(new Rule(configRule).toLogString())
         .to.eql('reactionName: evergreen_tree, ' +
-          'githubRepository: slack-emoji-issues, ' +
+          'target: slack-emoji-issues, ' +
           'channelNames: bot-dev,general')
     })
 
@@ -43,7 +43,7 @@ describe('Rule', function() {
       delete configRule.channelNames
       expect(new Rule(configRule).toLogString())
         .to.eql('reactionName: evergreen_tree, ' +
-          'githubRepository: slack-emoji-issues')
+          'target: slack-emoji-issues')
     })
   })