|
| 1 | +// Copyright 2023 Google LLC |
| 2 | +// |
| 3 | +// Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +// you may not use this file except in compliance with the License. |
| 5 | +// You may obtain a copy of the License at |
| 6 | +// |
| 7 | +// http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +// |
| 9 | +// Unless required by applicable law or agreed to in writing, software |
| 10 | +// distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +// See the License for the specific language governing permissions and |
| 13 | +// limitations under the License. |
| 14 | + |
| 15 | +import {describe, it, afterEach, beforeEach} from 'mocha'; |
| 16 | +import {Salesforce} from '../../src/strategies/salesforce'; |
| 17 | +import { |
| 18 | + buildMockConventionalCommit, |
| 19 | + buildGitHubFileContent, |
| 20 | + assertHasUpdate, |
| 21 | +} from '../helpers'; |
| 22 | +import * as nock from 'nock'; |
| 23 | +import * as sinon from 'sinon'; |
| 24 | +import {GitHub} from '../../src/github'; |
| 25 | +import {Version} from '../../src/version'; |
| 26 | +import {TagName} from '../../src/util/tag-name'; |
| 27 | +import {expect} from 'chai'; |
| 28 | +import {Changelog} from '../../src/updaters/changelog'; |
| 29 | +import {SfdxProjectJson} from '../../src/updaters/salesforce/sfdx-project-json'; |
| 30 | +import * as assert from 'assert'; |
| 31 | +import {MissingRequiredFileError, FileNotFoundError} from '../../src/errors'; |
| 32 | + |
| 33 | +nock.disableNetConnect(); |
| 34 | +const sandbox = sinon.createSandbox(); |
| 35 | +const fixturesPath = './test/fixtures/strategies/salesforce'; |
| 36 | + |
| 37 | +describe('Salesforce', () => { |
| 38 | + let github: GitHub; |
| 39 | + const commits = [ |
| 40 | + ...buildMockConventionalCommit( |
| 41 | + 'fix(deps): update dependency com.google.cloud:google-cloud-storage to v1.120.0' |
| 42 | + ), |
| 43 | + ]; |
| 44 | + beforeEach(async () => { |
| 45 | + github = await GitHub.create({ |
| 46 | + owner: 'googleapis', |
| 47 | + repo: 'salesforce-test-repo', |
| 48 | + defaultBranch: 'main', |
| 49 | + }); |
| 50 | + }); |
| 51 | + afterEach(() => { |
| 52 | + sandbox.restore(); |
| 53 | + }); |
| 54 | + describe('buildReleasePullRequest', () => { |
| 55 | + it('returns release PR changes with defaultInitialVersion', async () => { |
| 56 | + const expectedVersion = '1.0.0'; |
| 57 | + const strategy = new Salesforce({ |
| 58 | + targetBranch: 'main', |
| 59 | + github, |
| 60 | + component: 'google-cloud-automl', |
| 61 | + packageName: 'google-cloud-automl', |
| 62 | + }); |
| 63 | + const latestRelease = undefined; |
| 64 | + const release = await strategy.buildReleasePullRequest( |
| 65 | + commits, |
| 66 | + latestRelease |
| 67 | + ); |
| 68 | + expect(release!.version?.toString()).to.eql(expectedVersion); |
| 69 | + }); |
| 70 | + it('builds a release pull request', async () => { |
| 71 | + const expectedVersion = '0.123.5'; |
| 72 | + const strategy = new Salesforce({ |
| 73 | + targetBranch: 'main', |
| 74 | + github, |
| 75 | + component: 'some-salesforce-package', |
| 76 | + packageName: 'some-salesforce-package', |
| 77 | + }); |
| 78 | + const latestRelease = { |
| 79 | + tag: new TagName(Version.parse('0.123.4'), 'some-salesforce-package'), |
| 80 | + sha: 'abc123', |
| 81 | + notes: 'some notes', |
| 82 | + }; |
| 83 | + const pullRequest = await strategy.buildReleasePullRequest( |
| 84 | + commits, |
| 85 | + latestRelease |
| 86 | + ); |
| 87 | + expect(pullRequest!.version?.toString()).to.eql(expectedVersion); |
| 88 | + }); |
| 89 | + it('detects a default component', async () => { |
| 90 | + const expectedVersion = '0.123.5'; |
| 91 | + const strategy = new Salesforce({ |
| 92 | + targetBranch: 'main', |
| 93 | + github, |
| 94 | + }); |
| 95 | + const commits = [ |
| 96 | + ...buildMockConventionalCommit( |
| 97 | + 'fix(deps): update dependency com.google.cloud:google-cloud-storage to v1.120.0' |
| 98 | + ), |
| 99 | + ]; |
| 100 | + const latestRelease = { |
| 101 | + tag: new TagName(Version.parse('0.123.4'), 'salesforce-test-repo'), |
| 102 | + sha: 'abc123', |
| 103 | + notes: 'some notes', |
| 104 | + }; |
| 105 | + const getFileContentsStub = sandbox.stub( |
| 106 | + github, |
| 107 | + 'getFileContentsOnBranch' |
| 108 | + ); |
| 109 | + getFileContentsStub |
| 110 | + .withArgs('sfdx-project.json', 'main') |
| 111 | + .resolves(buildGitHubFileContent(fixturesPath, 'sfdx-project.json')); |
| 112 | + const pullRequest = await strategy.buildReleasePullRequest( |
| 113 | + commits, |
| 114 | + latestRelease |
| 115 | + ); |
| 116 | + expect(pullRequest!.version?.toString()).to.eql(expectedVersion); |
| 117 | + }); |
| 118 | + it('detects a default packageName', async () => { |
| 119 | + const expectedVersion = '0.123.5'; |
| 120 | + const strategy = new Salesforce({ |
| 121 | + targetBranch: 'main', |
| 122 | + github, |
| 123 | + component: 'abc-123', |
| 124 | + }); |
| 125 | + const commits = [ |
| 126 | + ...buildMockConventionalCommit( |
| 127 | + 'fix(deps): update dependency com.google.cloud:google-cloud-storage to v1.120.0' |
| 128 | + ), |
| 129 | + ]; |
| 130 | + const latestRelease = { |
| 131 | + tag: new TagName(Version.parse('0.123.4'), 'salesforce-test-repo'), |
| 132 | + sha: 'abc123', |
| 133 | + notes: 'some notes', |
| 134 | + }; |
| 135 | + const getFileContentsStub = sandbox.stub( |
| 136 | + github, |
| 137 | + 'getFileContentsOnBranch' |
| 138 | + ); |
| 139 | + getFileContentsStub |
| 140 | + .withArgs('sfdx-project.json', 'main') |
| 141 | + .resolves(buildGitHubFileContent(fixturesPath, 'sfdx-project.json')); |
| 142 | + const pullRequest = await strategy.buildReleasePullRequest( |
| 143 | + commits, |
| 144 | + latestRelease |
| 145 | + ); |
| 146 | + expect(pullRequest!.version?.toString()).to.eql(expectedVersion); |
| 147 | + }); |
| 148 | + it('handles missing sfdx-project.json', async () => { |
| 149 | + sandbox |
| 150 | + .stub(github, 'getFileContentsOnBranch') |
| 151 | + .rejects(new FileNotFoundError('stub/path')); |
| 152 | + const strategy = new Salesforce({ |
| 153 | + targetBranch: 'main', |
| 154 | + github, |
| 155 | + }); |
| 156 | + const latestRelease = { |
| 157 | + tag: new TagName(Version.parse('0.123.4'), 'some-salesforce-package'), |
| 158 | + sha: 'abc123', |
| 159 | + notes: 'some notes', |
| 160 | + }; |
| 161 | + assert.rejects(async () => { |
| 162 | + await strategy.buildReleasePullRequest(commits, latestRelease); |
| 163 | + }, MissingRequiredFileError); |
| 164 | + }); |
| 165 | + }); |
| 166 | + describe('buildUpdates', () => { |
| 167 | + it('builds common files', async () => { |
| 168 | + const strategy = new Salesforce({ |
| 169 | + targetBranch: 'main', |
| 170 | + github, |
| 171 | + component: 'google-cloud-automl', |
| 172 | + packageName: 'google-cloud-automl-pkg', |
| 173 | + }); |
| 174 | + sandbox.stub(github, 'findFilesByFilenameAndRef').resolves([]); |
| 175 | + const latestRelease = undefined; |
| 176 | + const release = await strategy.buildReleasePullRequest( |
| 177 | + commits, |
| 178 | + latestRelease |
| 179 | + ); |
| 180 | + const updates = release!.updates; |
| 181 | + assertHasUpdate(updates, 'CHANGELOG.md', Changelog); |
| 182 | + assertHasUpdate(updates, 'sfdx-project.json', SfdxProjectJson); |
| 183 | + }); |
| 184 | + }); |
| 185 | +}); |
0 commit comments