can now configure totalBits #5

Author: sandorfr

Tasks/EncodeSemverToInteger/EncodeSemverToInteger.ts

@@ -23,14 +23,15 @@ try {
     let preReleaseTagMap: IPrereleaseTagMap = JSON.parse(tl.getInput("PreReleaseTagMap"));
     let preReleaseNumberBits = getNumberInput("PreReleaseNumberBits");
     let outputVariable = tl.getInput("OutputVariable");
-    let disableZeroBitAllocation = tl.getBoolInput("disableZeroBitAllocation");
+    let disableZeroBitAllocation = tl.getBoolInput("DisableZeroBitAllocation");
+    let totalBits = getNumberInput("TotalBits");
 
     let varRegex = /\$\((.*?)\)/g;
     sourceSemVer = sourceSemVer.replace(varRegex, (match, varName, offset, s) => tl.getVariable(varName));
 
     console.log("Source Semver: " + sourceSemVer);
 
-    let encoder = new Encoder(new EncodingConfiguration(disableZeroBitAllocation, minorBits, patchBits, preReleaseTagBits, preReleaseTagMap, preReleaseNumberBits));
+    let encoder = new Encoder(new EncodingConfiguration(totalBits, disableZeroBitAllocation, minorBits, patchBits, preReleaseTagBits, preReleaseTagMap, preReleaseNumberBits));
     let code = checkNaN(encoder.encode(sourceSemVer), "Computed Version Code");
 
     console.log("Computed Version Code: " + code.toString());

Tasks/EncodeSemverToInteger/encoder.ts

@@ -5,12 +5,13 @@ export interface IPrereleaseTagMap {
 }
 
 export class EncodingConfiguration {
-    readonly majorBits: number = 31 - this.minorBits - this.patchBits - this.prereleaseNumberBits - this.prereleaseTagBits;
+    readonly majorBits: number = this.totalBits - this.minorBits - this.patchBits - this.prereleaseNumberBits - this.prereleaseTagBits;
 
     readonly maxPrereleaseTagCode = Math.pow(2, this.prereleaseTagBits) - 1;
     readonly maxPrereleaseNumberCode = Math.pow(2, this.prereleaseNumberBits) - 1;
 
     constructor(
+        readonly totalBits: number,
         readonly allowZeroBitAllocation: boolean,
         readonly minorBits: number,
         readonly patchBits: number,

Tasks/EncodeSemverToInteger/task.json

@@ -21,6 +21,13 @@
     ],
     "minimumAgentVersion": "1.91.0",
     "instanceNameFormat": "Encode Semver $(SourceSemver)",
+    "groups": [
+        {
+            "name": "advanced",
+            "displayName": "Advanced options",
+            "isExpanded": false
+        }
+    ],
     "inputs": [
         {
             "name": "SourceSemver",
@@ -79,11 +86,21 @@
             "helpMarkDown": "Bits used to encode PreReleaseNumber"
         },
         {
-            "name": "disableZeroBitAllocation",
+            "groupName": "advanced",
+            "name": "DisableZeroBitAllocation",
             "type": "boolean",
             "label": "Allow zero bit allocation",
             "defaultValue": "false",
             "helpMarkDown": "If this is enabled you can specify a 0 bit allocation for more or one component without it triggering an overflow error."
+        },
+        {
+            "groupName": "advanced",
+            "name": "TotalBits",
+            "type": "string",
+            "label": "Total bits",
+            "defaultValue": "31",
+            "required": true,
+            "helpMarkDown": "defaults to signed int 32 available bits. You can tweak this value if you want to encode over a larger or smaller integer size."
         }
     ],
     "execution": {

Tests/EncodeSemverToInteger/encoding.spec.ts

@@ -26,10 +26,11 @@ interface IExpectedErrors {
     [key: string]: string;
 }
 
-let onlyPrereleaseConfiguration = new EncodingConfiguration(true, 0, 0, 2, { "rc": 2, "beta": 1, "alpha": 0, "unstable": 0 }, 29);
-let defaultConfiguration = new EncodingConfiguration(false, 5, 4, 2, { "rc": 2, "beta": 1, "alpha": 0, "unstable": 0 }, 9);
-let balancedConfiguration = new EncodingConfiguration(false, 6, 5, 2, { "rc": 2, "beta": 1, "alpha": 0 }, 9, "Balanced");
-let distributedConfiguration = new EncodingConfiguration(false, 7, 7, 2, { "rc": 2, "beta": 1, "alpha": 0 }, 7, "Distributed");
+let onlyPrereleaseConfiguration = new EncodingConfiguration(31, true, 0, 0, 2, { "rc": 2, "beta": 1, "alpha": 0, "unstable": 0 }, 29);
+let defaultConfiguration = new EncodingConfiguration(31, false, 5, 4, 2, { "rc": 2, "beta": 1, "alpha": 0, "unstable": 0 }, 9);
+let balancedConfiguration = new EncodingConfiguration(31, false, 6, 5, 2, { "rc": 2, "beta": 1, "alpha": 0 }, 9, "Balanced");
+let distributedConfiguration = new EncodingConfiguration(31, false, 7, 7, 2, { "rc": 2, "beta": 1, "alpha": 0 }, 7, "Distributed");
+let longDistributedConfiguration = new EncodingConfiguration(63, false, 14, 14, 4, { "rc": 2, "beta": 1, "alpha": 0 }, 14, "Long (signed 64 bits) Distributed");
 
 describe("Simple encoding", () => {
     let defaultConfigurationEncoder = new Encoder(defaultConfiguration);
@@ -151,7 +152,7 @@ describe("Overflows", () => {
             },
         },
         {
-            configuration: new EncodingConfiguration(false, 5, 4, 2, { "prod": 4, "preprod": 3, "rc": 2, "beta": 1, "alpha": 0 }, 9),
+            configuration: new EncodingConfiguration(31, false, 5, 4, 2, { "prod": 4, "preprod": 3, "rc": 2, "beta": 1, "alpha": 0 }, 9),
             expectedErrors: {
                 "0.0.0-prod.1": "Prerelease Tag will overflow allocated bits (4 >= 4).",
                 "0.0.0-preprod.1": "The max allowed Prerelease Tag value (3) should be kept for Semver without Prerelease Tag.",
@@ -227,6 +228,16 @@ describe("Precedence", () => {
             lastCode = code;
         }
     });
+
+    it("should be preserved with configuration '" + longDistributedConfiguration.friendlyName + "'", () => {
+        let lastCode = -1;
+        let distributedConfigurationEncoder = new Encoder(distributedConfiguration);
+        for (let i = 0; i < traits.length; i++) {
+            let code = distributedConfigurationEncoder.encode(traits[i]);
+            expect(code).toBeGreaterThan(lastCode);
+            lastCode = code;
+        }
+    });
 });
 
 describe("Disabled components encoding", () => {