fix: php root-composer-update-packages version replace (#1553)

* fix: php root-composer-update-packages version replace

* chore: Add tests

* chore: add missing headers

* chore: remove only from test

* chore: update copyright to 2022

* refactor: update both replace and root

* refactor: veriable name

* refactor: remove eslint ignore

Co-authored-by: Jeff Ching <chingor@google.com>

Author: anderson-comvex

__snapshots__/php-composer-update-packages.js

@@ -0,0 +1,30 @@
+exports['PHPComposer updateContent does not update a version when version is the same 1'] = `
+{"version":"1.0.0","replace":{"version":"1.0.0"}}
+`
+
+exports['PHPComposer updateContent update all versions in composer.json 1'] = `
+{"version":"1.0.0","replace":{"version":"1.0.0"}}
+`
+
+exports['PHPComposer updateContent update replace version in composer.json 1'] = `
+{"replace":{"version":"1.0.0"}}
+`
+
+exports['PHPComposer updateContent update replace version in composer.json when version is missing 1'] = `
+{"replace":{"version":"1.0.0"}}
+`
+
+exports['PHPComposer updateContent update replace version in composer.json when version is present 1'] = `
+{"replace":{"version":"1.0.0"}}
+`
+
+exports['PHPComposer updateContent update root version in composer.json 1'] = `
+{"version":"1.0.0"}
+`
+
+exports['PHPComposer updateContent update version in composer.json 1'] = `
+{
+  "version": "1.0.0"
+}
+
+`

src/updaters/php/root-composer-update-packages.ts

@@ -32,13 +32,19 @@ export class RootComposerUpdatePackages extends DefaultUpdater {
     }
     const parsed = JSON.parse(content);
     if (this.versionsMap) {
-      // eslint-disable-next-line prefer-const
-      for (let [key, version] of this.versionsMap.entries()) {
-        version = version || '1.0.0';
-        logger.info(
-          `updating ${key} from ${parsed.replace[key]} to ${version}`
-        );
-        parsed.replace[key] = version.toString();
+      for (const [key, version] of this.versionsMap.entries()) {
+        const toVersion = version.toString() || '1.0.0';
+        let fromVersion: string | undefined;
+        if (parsed.replace) {
+          fromVersion = parsed.replace[key];
+          parsed.replace[key] = toVersion;
+        }
+        if (parsed[key]) {
+          fromVersion ??= parsed[key];
+          parsed[key] = toVersion;
+        }
+
+        logger.info(`updating ${key} from ${fromVersion} to ${toVersion}`);
       }
     }
     return jsonStringify(parsed, content);

test/updaters/php-composer-update-packages.ts

@@ -0,0 +1,120 @@
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+import * as snapshot from 'snap-shot-it';
+import {describe, it} from 'mocha';
+import {expect} from 'chai';
+import {RootComposerUpdatePackages} from '../../src/updaters/php/root-composer-update-packages';
+import {Version, VersionsMap} from '../../src/version';
+
+describe('PHPComposer', () => {
+  describe('updateContent', () => {
+    it('does not update a version when version is the same', async () => {
+      const oldContent = '{"version":"1.0.0","replace":{"version":"1.0.0"}}';
+
+      const version = Version.parse('1.0.0');
+
+      const versionsMap: VersionsMap = new Map();
+
+      const newContent = new RootComposerUpdatePackages({
+        version,
+        versionsMap,
+      }).updateContent(oldContent);
+
+      expect(newContent).to.eq(
+        '{"version":"1.0.0","replace":{"version":"1.0.0"}}'
+      );
+
+      snapshot(newContent);
+    });
+
+    it('update all versions in composer.json', async () => {
+      const oldContent = '{"version":"0.0.0","replace":{"version":"0.0.0"}}';
+
+      const version = Version.parse('1.0.0');
+
+      const versionsMap: VersionsMap = new Map();
+
+      versionsMap.set('version', version);
+
+      const newContent = new RootComposerUpdatePackages({
+        version,
+        versionsMap,
+      }).updateContent(oldContent);
+
+      expect(newContent).to.eq(
+        '{"version":"1.0.0","replace":{"version":"1.0.0"}}'
+      );
+
+      snapshot(newContent);
+    });
+
+    it('update root version in composer.json', async () => {
+      const oldContent = '{"version":"0.0.0"}';
+
+      const version = Version.parse('1.0.0');
+
+      const versionsMap: VersionsMap = new Map();
+
+      versionsMap.set('version', version);
+
+      const newContent = new RootComposerUpdatePackages({
+        version,
+        versionsMap,
+      }).updateContent(oldContent);
+
+      expect(newContent).to.eq('{"version":"1.0.0"}');
+
+      snapshot(newContent);
+    });
+
+    it('update replace version in composer.json when version is present', async () => {
+      const oldContent = '{"replace":{"version":"0.0.0"}}';
+
+      const version = Version.parse('1.0.0');
+
+      const versionsMap: VersionsMap = new Map();
+
+      versionsMap.set('version', version);
+
+      const newContent = new RootComposerUpdatePackages({
+        version,
+        versionsMap,
+      }).updateContent(oldContent);
+
+      expect(newContent).to.eq('{"replace":{"version":"1.0.0"}}');
+
+      snapshot(newContent);
+    });
+
+    it('update replace version in composer.json when version is missing', async () => {
+      const oldContent = '{"replace":{}}';
+
+      const version = Version.parse('1.0.0');
+
+      const versionsMap: VersionsMap = new Map();
+
+      versionsMap.set('version', version);
+
+      const newContent = new RootComposerUpdatePackages({
+        version,
+        versionsMap,
+      }).updateContent(oldContent);
+
+      expect(newContent).to.eq('{"replace":{"version":"1.0.0"}}');
+
+      snapshot(newContent);
+    });
+  });
+});