Feature comment target

.github/workflows/test-deploy.yml

@@ -58,12 +58,15 @@ jobs:
           TEST_GITHUB_TOKEN: ${{ secrets.TEST_GITHUB_TOKEN }}
           TEST_GITHUB_REPO: https://github.com/iterative/cml_qa_tests_dummy
           TEST_GITHUB_SHA: 0cd16da26e35f8e5d57b2549a97e22618abf08f6
+          TEST_GITHUB_ISSUE: 1
           TEST_GITLAB_TOKEN: ${{ secrets.TEST_GITLAB_TOKEN }}
           TEST_GITLAB_REPO: https://gitlab.com/iterative.ai/cml_qa_tests_dummy
           TEST_GITLAB_SHA: f8b8b49a253243830ef59a7f090eb887157b2b67
+          TEST_GITLAB_ISSUE: 1
           TEST_BBCLOUD_TOKEN: ${{ secrets.TEST_BBCLOUD_TOKEN }}
           TEST_BBCLOUD_REPO: https://bitbucket.org/iterative-ai/cml-qa-tests-dummy
           TEST_BBCLOUD_SHA: b511535a89f76d3d311b1c15e3e712b15c0b94e3
+          TEST_BBCLOUD_ISSUE: 1
   test-os:
     needs: authorize
     name: test-${{ matrix.system }}

bin/cml/comment/create.js

@@ -18,7 +18,13 @@ exports.options = kebabcaseKeys({
   pr: {
     type: 'boolean',
     description:
-      'Post to an existing PR/MR associated with the specified commit'
+      'Post to an existing PR/MR associated with the specified commit',
+    conflicts: ['issue']
+  },
+  issue: {
+    type: 'number',
+    description: 'Post to the given issue number',
+    conflicts: ['pr']
   },
   commitSha: {
     type: 'string',

bin/cml/comment/create.test.js

@@ -20,6 +20,7 @@ describe('Comment integration tests', () => {
       Options:
         --pr                        Post to an existing PR/MR associated with the
                                     specified commit                         [boolean]
+        --issue                     Post to the given issue number            [number]
         --commit-sha, --head-sha    Commit SHA linked to this comment
                                                             [string] [default: \\"HEAD\\"]
         --watch                     Watch for changes and automatically update the

src/cml.js

@@ -164,6 +164,7 @@ class CML {
     const triggerSha = await this.triggerSha();
     const {
       commitSha: inCommitSha = triggerSha,
+      issue: issueId,
       rmWatermark,
       update,
       pr,
@@ -267,6 +268,23 @@ class CML {
         return body.includes('watermark.svg');
       });
     };
+    // Create or update an issue comment.
+    if (issueId) {
+      if (update) {
+        comment = updatableComment(await drv.issueComments({ issueId }));
+
+        if (comment)
+          return await drv.issueCommentUpdate({
+            report,
+            id: comment.id,
+            issueId
+          });
+      }
+      return await drv.issueCommentCreate({
+        report,
+        issueId
+      });
+    }
 
     const isBB = this.driver === BB;
     if (pr || isBB) {

src/drivers/bitbucket_cloud.e2e.test.js

@@ -2,7 +2,8 @@ const BitbucketCloud = require('./bitbucket_cloud');
 const {
   TEST_BBCLOUD_TOKEN: TOKEN,
   TEST_BBCLOUD_REPO: REPO,
-  TEST_BBCLOUD_SHA: SHA
+  TEST_BBCLOUD_SHA: SHA,
+  TEST_BBCLOUD_ISSUE: ISSUE = 1
 } = process.env;
 
 describe('Non Enviromental tests', () => {
@@ -13,12 +14,20 @@ describe('Non Enviromental tests', () => {
     expect(client.token).toBe(TOKEN);
   });
 
+  test('Issue comment', async () => {
+    const report = '## Test comment';
+    const issueId = ISSUE;
+    const url = await client.issueCommentCreate({ report, issueId });
+
+    expect(url.startsWith('https://')).toBe(true);
+  });
+
   test('Comment', async () => {
     const report = '## Test comment';
     const commitSha = SHA;
     const url = await client.commentCreate({ report, commitSha });
 
-    expect(url.startsWith('https://')).toBe(true);
+    expect(url.startsWith(REPO)).toBe(true);
   });
 
   test('Check', async () => {

src/drivers/bitbucket_cloud.js

@@ -29,6 +29,45 @@ class BitbucketCloud {
     }
   }
 
+  async issueCommentCreate(opts = {}) {
+    const { projectPath } = this;
+    const { issueId, report } = opts;
+    const endpoint = `/repositories/${projectPath}/issues/${issueId}/comments/`;
+    return (
+      await this.request({
+        endpoint,
+        method: 'POST',
+        body: JSON.stringify({ content: { raw: report } })
+      })
+    ).links.html.href;
+  }
+
+  async issueCommentUpdate(opts = {}) {
+    const { projectPath } = this;
+    const { issueId, id, report } = opts;
+
+    const endpoint = `/repositories/${projectPath}/issues/${issueId}/comments/${id}`;
+    return (
+      await this.request({
+        endpoint,
+        method: 'PUT',
+        body: JSON.stringify({ content: { raw: report } })
+      })
+    ).links.html.href;
+  }
+
+  async issueComments(opts = {}) {
+    const { projectPath } = this;
+    const { issueId } = opts;
+
+    const endpoint = `/repositories/${projectPath}/issues/${issueId}/comments/`;
+    return (await this.paginatedRequest({ endpoint, method: 'GET' })).map(
+      ({ id, content: { raw: body = '' } = {} }) => {
+        return { id, body };
+      }
+    );
+  }
+
   async commentCreate(opts = {}) {
     const { projectPath } = this;
     const { commitSha, report } = opts;

src/drivers/github.e2e.test.js

@@ -3,7 +3,8 @@ const GithubClient = require('./github');
 const {
   TEST_GITHUB_TOKEN: TOKEN,
   TEST_GITHUB_REPO: REPO,
-  TEST_GITHUB_SHA: SHA
+  TEST_GITHUB_SHA: SHA,
+  TEST_GITHUB_ISSUE: ISSUE = 1
 } = process.env;
 
 describe('Non Enviromental tests', () => {
@@ -19,12 +20,20 @@ describe('Non Enviromental tests', () => {
     expect(repo).toBe(parts[parts.length - 1]);
   });
 
+  test('Issue comment', async () => {
+    const report = '## Test comment';
+    const issueId = ISSUE;
+    const url = await client.issueCommentCreate({ issueId, report });
+
+    expect(url.startsWith(REPO)).toBe(true);
+  });
+
   test('Comment', async () => {
     const report = '## Test comment';
     const commitSha = SHA;
     const url = await client.commentCreate({ report, commitSha });
 
-    expect(url.startsWith('https://')).toBe(true);
+    expect(url.startsWith(REPO)).toBe(true);
   });
 
   test('Publish', async () => {

src/drivers/github.js

@@ -539,6 +539,56 @@ class Github {
     }
   }
 
+  async issueCommentCreate(opts = {}) {
+    const { issueId, report } = opts;
+    const { owner, repo } = ownerRepo({ uri: this.repo });
+    const { issues } = octokit(this.token, this.repo);
+
+    const {
+      data: { html_url: htmlUrl }
+    } = await issues.createComment({
+      owner,
+      repo,
+      body: report,
+      issue_number: issueId
+    });
+
+    return htmlUrl;
+  }
+
+  async issueCommentUpdate(opts = {}) {
+    const { id, report } = opts;
+    const { owner, repo } = ownerRepo({ uri: this.repo });
+    const { issues } = octokit(this.token, this.repo);
+
+    const {
+      data: { html_url: htmlUrl }
+    } = await issues.updateComment({
+      owner,
+      repo,
+      body: report,
+      comment_id: id
+    });
+
+    return htmlUrl;
+  }
+
+  async issueComments(opts = {}) {
+    const { issueId } = opts;
+    const { owner, repo } = ownerRepo({ uri: this.repo });
+    const { issues } = octokit(this.token, this.repo);
+
+    const { data: comments } = await issues.listComments({
+      owner,
+      repo,
+      issue_number: issueId
+    });
+
+    return comments.map(({ id, body }) => {
+      return { id, body };
+    });
+  }
+
   async prCommentCreate(opts = {}) {
     const { report: body, prNumber } = opts;
     const { owner, repo } = ownerRepo({ uri: this.repo });

src/drivers/gitlab.e2e.test.js

@@ -3,7 +3,8 @@ const GitlabClient = require('./gitlab');
 const {
   TEST_GITLAB_TOKEN: TOKEN,
   TEST_GITLAB_REPO: REPO,
-  TEST_GITLAB_SHA: SHA
+  TEST_GITLAB_SHA: SHA,
+  TEST_GITLAB_ISSUE: ISSUE = 1
 } = process.env;
 
 describe('Non Enviromental tests', () => {
@@ -14,6 +15,14 @@ describe('Non Enviromental tests', () => {
     expect(client.token).toBe(TOKEN);
   });
 
+  test('Issue comment', async () => {
+    const report = '## Test comment';
+    const issueId = ISSUE;
+    const url = await client.issueCommentCreate({ issueId, report });
+
+    expect(url.startsWith(REPO)).toBe(true);
+  });
+
   test('Comment', async () => {
     const report = '## Test comment';
     const commitSha = SHA;

src/drivers/gitlab.js

@@ -329,6 +329,56 @@ class Gitlab {
     }
   }
 
+  async issueCommentCreate(opts = {}) {
+    const projectPath = await this.projectPath();
+    const { issueId, report } = opts;
+
+    const endpoint = `/projects/${projectPath}/issues/${issueId}/notes`;
+    const body = new URLSearchParams();
+    body.append('body', report);
+
+    const { id } = await this.request({
+      endpoint,
+      method: 'POST',
+      body
+    });
+
+    return `${this.repo}/-/issues/${issueId}#note_${id}`;
+  }
+
+  async issueCommentUpdate(opts = {}) {
+    const projectPath = await this.projectPath();
+    const { issueId, id: commentId, report } = opts;
+
+    const endpoint = `/projects/${projectPath}/issues/${issueId}/notes/${commentId}`;
+    const body = new URLSearchParams();
+    body.append('body', report);
+
+    const { id } = await this.request({
+      endpoint,
+      method: 'PUT',
+      body
+    });
+
+    return `${this.repo}/-/issues/${issueId}#note_${id}`;
+  }
+
+  async issueComments(opts = {}) {
+    const projectPath = await this.projectPath();
+    const { issueId } = opts;
+
+    const endpoint = `/projects/${projectPath}/issues/${issueId}/notes`;
+
+    const comments = await this.request({
+      endpoint,
+      method: 'GET'
+    });
+
+    return comments.map(({ id, body }) => {
+      return { id, body };
+    });
+  }
+
   async prCommentCreate(opts = {}) {
     const projectPath = await this.projectPath();
     const { report, prNumber } = opts;