diff --git a/common-npm-packages/webdeployment-common-v2/ParameterParserUtility.ts b/common-npm-packages/webdeployment-common-v2/ParameterParserUtility.ts new file mode 100644 index 000000000000..b9fe138c28c2 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/ParameterParserUtility.ts @@ -0,0 +1,127 @@ +// TODO: This whole file is copied from AzureResourceGroupDeployment task. Move this parser to common lib +// Similar parser is used in Grid UI extension. Try to move the code to some place where all can use it. + +export function parse(input: string): {[key: string]: any} { + var result = {}; + var index = 0; + var obj = { name: "", value: "" }; + while (index < input.length) { + var literalData = findLiteral(input, index); + var nextIndex = literalData.currentPosition; + var specialCharacterFlag = literalData.specialCharacterFlag + var literal = input.substr(index, nextIndex - index).trim(); + if (isName(literal, specialCharacterFlag)) { + if (obj.name) { + result[obj.name] = { value: obj.value }; + obj = { name: "", value: "" }; + } + obj.name = literal.substr(1, literal.length); + } + else { + obj.value = literal; + result[obj.name] = { value: obj.value }; + obj = { name: "", value: "" }; + } + index = nextIndex + 1; + } + if (obj.name) { + result[obj.name] = { value: obj.value }; + } + for (var name in result) { + result[name].value = result[name].value.replace(/^"(.*)"$/, '$1'); + } + return result; +} + +function isName(literal: string, specialCharacterFlag: boolean): boolean { + return literal[0] === '-' && !specialCharacterFlag && isNaN(Number(literal)); +} + +function findLiteral(input, currentPosition): {[key: string]: any} { + var specialCharacterFlag = false; + for (; currentPosition < input.length; currentPosition++) { + if (input[currentPosition] == " " || input[currentPosition] == "\t") { + for (; currentPosition < input.length; currentPosition++) { + if (input[currentPosition + 1] != " " && input[currentPosition + 1] != "\t") { + break; + } + } + break; + } + else if (input[currentPosition] == "(") { + currentPosition = findClosingBracketIndex(input, currentPosition + 1, ")"); + specialCharacterFlag = true; + } + else if (input[currentPosition] == "[") { + currentPosition = findClosingBracketIndex(input, currentPosition + 1, "]"); + specialCharacterFlag = true; + } + else if (input[currentPosition] == "{") { + currentPosition = findClosingBracketIndex(input, currentPosition + 1, "}"); + specialCharacterFlag = true; + } + else if (input[currentPosition] == "\"") { + //keep going till this one closes + currentPosition = findClosingQuoteIndex(input, currentPosition + 1, "\""); + specialCharacterFlag = true; + } + else if (input[currentPosition] == "'") { + //keep going till this one closes + currentPosition = findClosingQuoteIndex(input, currentPosition + 1, "'"); + specialCharacterFlag = true; + } + else if (input[currentPosition] == "`") { + currentPosition++; + specialCharacterFlag = true; + if (currentPosition >= input.length) { + break; + } + } + } + return { currentPosition: currentPosition, specialCharacterFlag: specialCharacterFlag }; +} + +function findClosingBracketIndex(input, currentPosition, closingBracket): number { + for (; currentPosition < input.length; currentPosition++) { + if (input[currentPosition] == closingBracket) { + break; + } + else if (input[currentPosition] == "(") { + currentPosition = findClosingBracketIndex(input, currentPosition + 1, ")"); + } + else if (input[currentPosition] == "[") { + currentPosition = findClosingBracketIndex(input, currentPosition + 1, "]"); + } + else if (input[currentPosition] == "{") { + currentPosition = findClosingBracketIndex(input, currentPosition + 1, "}"); + } + else if (input[currentPosition] == "\"") { + currentPosition = findClosingQuoteIndex(input, currentPosition + 1, "\""); + } + else if (input[currentPosition] == "'") { + currentPosition = findClosingQuoteIndex(input, currentPosition + 1, "'"); + } + else if (input[currentPosition] == "`") { + currentPosition++; + if (currentPosition >= input.length) { + break; + } + } + } + return currentPosition; +} + +function findClosingQuoteIndex(input, currentPosition, closingQuote) { + for (; currentPosition < input.length; currentPosition++) { + if (input[currentPosition] == closingQuote) { + break; + } + else if (input[currentPosition] == "`") { + currentPosition++; + if (currentPosition >= input.length) { + break; + } + } + } + return currentPosition; +} diff --git a/common-npm-packages/webdeployment-common-v2/Strings/resources.resjson/de-de/resources.resjson b/common-npm-packages/webdeployment-common-v2/Strings/resources.resjson/de-de/resources.resjson new file mode 100644 index 000000000000..9cd973923402 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/Strings/resources.resjson/de-de/resources.resjson @@ -0,0 +1,13 @@ +{ + "loc.messages.Updatemachinetoenablesecuretlsprotocol": "Make sure the machine is using TLS 1.2 protocol or higher. Check https://aka.ms/enableTlsv2 for more information on how to enable TLS in your machine.", + "loc.messages.JarPathNotPresent": "Java jar path is not present", + "loc.messages.JSONvariablesubstitutionappliedsuccessfully": "JSON variable substitution applied successfully.", + "loc.messages.XMLvariablesubstitutionappliedsuccessfully": "XML variable substitution applied successfully.", + "loc.messages.XDTTransformationsappliedsuccessfully": "XML Transformations applied successfully", + "loc.messages.CannotPerformXdtTransformationOnNonWindowsPlatform": "Cannot perform XML transformations on a non-Windows platform.", + "loc.messages.XdtTransformationErrorWhileTransforming": "XML transformation error while transforming %s using %s.", + "loc.messages.JSONParseError": "Unable to parse JSON file: %s. Error: %s", + "loc.messages.NOJSONfilematchedwithspecificpattern": "NO JSON file matched with specific pattern: %s.", + "loc.messages.FailedToApplyTransformation": "Unable to apply transformation for the given package. Verify the following.", + "loc.messages.MissingArgumentsforXMLTransformation": "Incomplete or missing arguments. Expected format -transform -xml -result . Transformation and source file are mandatory inputs." +} \ No newline at end of file diff --git a/common-npm-packages/webdeployment-common-v2/Strings/resources.resjson/en-US/resources.resjson b/common-npm-packages/webdeployment-common-v2/Strings/resources.resjson/en-US/resources.resjson new file mode 100644 index 000000000000..b62b0fc11950 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/Strings/resources.resjson/en-US/resources.resjson @@ -0,0 +1,32 @@ +{ + "loc.messages.Updatemachinetoenablesecuretlsprotocol": "Make sure the machine is using TLS 1.2 protocol or higher. Check https://aka.ms/enableTlsv2 for more information on how to enable TLS in your machine.", + "loc.messages.JarPathNotPresent": "Java jar path is not present", + "loc.messages.JSONvariablesubstitutionappliedsuccessfully": "JSON variable substitution applied successfully.", + "loc.messages.XMLvariablesubstitutionappliedsuccessfully": "XML variable substitution applied successfully.", + "loc.messages.XDTTransformationsappliedsuccessfully": "XML Transformations applied successfully", + "loc.messages.CannotPerformXdtTransformationOnNonWindowsPlatform": "Cannot perform XML transformations on a non-Windows platform.", + "loc.messages.XdtTransformationErrorWhileTransforming": "XML transformation error while transforming %s using %s.", + "loc.messages.JSONParseError": "Unable to parse JSON file: %s. Error: %s", + "loc.messages.NOJSONfilematchedwithspecificpattern": "NO JSON file matched with specific pattern: %s.", + "loc.messages.FailedToApplyTransformation": "Unable to apply transformation for the given package. Verify the following.", + "loc.messages.FailedToApplySpecialTransformation": "Unable to apply transformation for the given package.", + "loc.messages.FailedToApplySpecialTransformationReason1": "Unable to apply transformation for the given package - Changes are already present in the package.", + "loc.messages.FailedToApplyTransformationReason1": "1. Whether the Transformation is already applied for the MSBuild generated package during build. If yes, remove the tag for each config in the csproj file and rebuild. ", + "loc.messages.FailedToApplyTransformationReason2": "2. Ensure that the config file and transformation files are present in the same folder inside the package.", + "loc.messages.FailedToApplyXMLvariablesubstitutionReason1": "Failed to apply XML variable substitution. Changes are already present in the package.", + "loc.messages.MissingArgumentsforXMLTransformation": "Incomplete or missing arguments. Expected format -transform -xml -result . Transformation and source file are mandatory inputs.", + "loc.messages.MorethanonepackagematchedwithspecifiedpatternPleaserestrainthesearchpattern": "More than one package matched with specified pattern: %s. Please restrain the search pattern.", + "loc.messages.JSONvariableSubstitution": "Applying JSON variable substitution for %s", + "loc.messages.SubstitutingValueonKey": "Substituting value on key: %s", + "loc.messages.SubstitutingValueonKeyWithNumber": "Substituting value on key %s with (number) value: %s", + "loc.messages.SubstitutingValueonKeyWithBoolean": "Substituting value on key %s with (boolean) value: %s", + "loc.messages.SubstitutingValueonKeyWithObject": "Substituting value on key %s with (object) value: %s", + "loc.messages.SubstitutingValueonKeyWithString": "Substituting value on key %s with (string) value: %s", + "loc.messages.ApplyingXDTtransformation": "Applying XDT Transformation from transformation file %s -> source file %s ", + "loc.messages.SubstitutionForXmlNode": "Processing substitution for xml node : %s", + "loc.messages.UpdatingKeyWithTokenValue": "Updating value for key= %s with token value: %s", + "loc.messages.SubstitutingConnectionStringValue": "Substituting connectionString value for connectionString = %s with token value: %s ", + "loc.messages.VariableSubstitutionInitiated": "Initiated variable substitution in config file : %s", + "loc.messages.ConfigFileUpdated": "Config file : %s updated.", + "loc.messages.SkippedUpdatingFile": "Skipped Updating file: %s" +} \ No newline at end of file diff --git a/common-npm-packages/webdeployment-common-v2/Strings/resources.resjson/es-es/resources.resjson b/common-npm-packages/webdeployment-common-v2/Strings/resources.resjson/es-es/resources.resjson new file mode 100644 index 000000000000..9cd973923402 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/Strings/resources.resjson/es-es/resources.resjson @@ -0,0 +1,13 @@ +{ + "loc.messages.Updatemachinetoenablesecuretlsprotocol": "Make sure the machine is using TLS 1.2 protocol or higher. Check https://aka.ms/enableTlsv2 for more information on how to enable TLS in your machine.", + "loc.messages.JarPathNotPresent": "Java jar path is not present", + "loc.messages.JSONvariablesubstitutionappliedsuccessfully": "JSON variable substitution applied successfully.", + "loc.messages.XMLvariablesubstitutionappliedsuccessfully": "XML variable substitution applied successfully.", + "loc.messages.XDTTransformationsappliedsuccessfully": "XML Transformations applied successfully", + "loc.messages.CannotPerformXdtTransformationOnNonWindowsPlatform": "Cannot perform XML transformations on a non-Windows platform.", + "loc.messages.XdtTransformationErrorWhileTransforming": "XML transformation error while transforming %s using %s.", + "loc.messages.JSONParseError": "Unable to parse JSON file: %s. Error: %s", + "loc.messages.NOJSONfilematchedwithspecificpattern": "NO JSON file matched with specific pattern: %s.", + "loc.messages.FailedToApplyTransformation": "Unable to apply transformation for the given package. Verify the following.", + "loc.messages.MissingArgumentsforXMLTransformation": "Incomplete or missing arguments. Expected format -transform -xml -result . Transformation and source file are mandatory inputs." +} \ No newline at end of file diff --git a/common-npm-packages/webdeployment-common-v2/Strings/resources.resjson/fr-fr/resources.resjson b/common-npm-packages/webdeployment-common-v2/Strings/resources.resjson/fr-fr/resources.resjson new file mode 100644 index 000000000000..9cd973923402 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/Strings/resources.resjson/fr-fr/resources.resjson @@ -0,0 +1,13 @@ +{ + "loc.messages.Updatemachinetoenablesecuretlsprotocol": "Make sure the machine is using TLS 1.2 protocol or higher. Check https://aka.ms/enableTlsv2 for more information on how to enable TLS in your machine.", + "loc.messages.JarPathNotPresent": "Java jar path is not present", + "loc.messages.JSONvariablesubstitutionappliedsuccessfully": "JSON variable substitution applied successfully.", + "loc.messages.XMLvariablesubstitutionappliedsuccessfully": "XML variable substitution applied successfully.", + "loc.messages.XDTTransformationsappliedsuccessfully": "XML Transformations applied successfully", + "loc.messages.CannotPerformXdtTransformationOnNonWindowsPlatform": "Cannot perform XML transformations on a non-Windows platform.", + "loc.messages.XdtTransformationErrorWhileTransforming": "XML transformation error while transforming %s using %s.", + "loc.messages.JSONParseError": "Unable to parse JSON file: %s. Error: %s", + "loc.messages.NOJSONfilematchedwithspecificpattern": "NO JSON file matched with specific pattern: %s.", + "loc.messages.FailedToApplyTransformation": "Unable to apply transformation for the given package. Verify the following.", + "loc.messages.MissingArgumentsforXMLTransformation": "Incomplete or missing arguments. Expected format -transform -xml -result . Transformation and source file are mandatory inputs." +} \ No newline at end of file diff --git a/common-npm-packages/webdeployment-common-v2/Strings/resources.resjson/it-IT/resources.resjson b/common-npm-packages/webdeployment-common-v2/Strings/resources.resjson/it-IT/resources.resjson new file mode 100644 index 000000000000..9cd973923402 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/Strings/resources.resjson/it-IT/resources.resjson @@ -0,0 +1,13 @@ +{ + "loc.messages.Updatemachinetoenablesecuretlsprotocol": "Make sure the machine is using TLS 1.2 protocol or higher. Check https://aka.ms/enableTlsv2 for more information on how to enable TLS in your machine.", + "loc.messages.JarPathNotPresent": "Java jar path is not present", + "loc.messages.JSONvariablesubstitutionappliedsuccessfully": "JSON variable substitution applied successfully.", + "loc.messages.XMLvariablesubstitutionappliedsuccessfully": "XML variable substitution applied successfully.", + "loc.messages.XDTTransformationsappliedsuccessfully": "XML Transformations applied successfully", + "loc.messages.CannotPerformXdtTransformationOnNonWindowsPlatform": "Cannot perform XML transformations on a non-Windows platform.", + "loc.messages.XdtTransformationErrorWhileTransforming": "XML transformation error while transforming %s using %s.", + "loc.messages.JSONParseError": "Unable to parse JSON file: %s. Error: %s", + "loc.messages.NOJSONfilematchedwithspecificpattern": "NO JSON file matched with specific pattern: %s.", + "loc.messages.FailedToApplyTransformation": "Unable to apply transformation for the given package. Verify the following.", + "loc.messages.MissingArgumentsforXMLTransformation": "Incomplete or missing arguments. Expected format -transform -xml -result . Transformation and source file are mandatory inputs." +} \ No newline at end of file diff --git a/common-npm-packages/webdeployment-common-v2/Strings/resources.resjson/ja-jp/resources.resjson b/common-npm-packages/webdeployment-common-v2/Strings/resources.resjson/ja-jp/resources.resjson new file mode 100644 index 000000000000..9cd973923402 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/Strings/resources.resjson/ja-jp/resources.resjson @@ -0,0 +1,13 @@ +{ + "loc.messages.Updatemachinetoenablesecuretlsprotocol": "Make sure the machine is using TLS 1.2 protocol or higher. Check https://aka.ms/enableTlsv2 for more information on how to enable TLS in your machine.", + "loc.messages.JarPathNotPresent": "Java jar path is not present", + "loc.messages.JSONvariablesubstitutionappliedsuccessfully": "JSON variable substitution applied successfully.", + "loc.messages.XMLvariablesubstitutionappliedsuccessfully": "XML variable substitution applied successfully.", + "loc.messages.XDTTransformationsappliedsuccessfully": "XML Transformations applied successfully", + "loc.messages.CannotPerformXdtTransformationOnNonWindowsPlatform": "Cannot perform XML transformations on a non-Windows platform.", + "loc.messages.XdtTransformationErrorWhileTransforming": "XML transformation error while transforming %s using %s.", + "loc.messages.JSONParseError": "Unable to parse JSON file: %s. Error: %s", + "loc.messages.NOJSONfilematchedwithspecificpattern": "NO JSON file matched with specific pattern: %s.", + "loc.messages.FailedToApplyTransformation": "Unable to apply transformation for the given package. Verify the following.", + "loc.messages.MissingArgumentsforXMLTransformation": "Incomplete or missing arguments. Expected format -transform -xml -result . Transformation and source file are mandatory inputs." +} \ No newline at end of file diff --git a/common-npm-packages/webdeployment-common-v2/Strings/resources.resjson/ko-KR/resources.resjson b/common-npm-packages/webdeployment-common-v2/Strings/resources.resjson/ko-KR/resources.resjson new file mode 100644 index 000000000000..9cd973923402 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/Strings/resources.resjson/ko-KR/resources.resjson @@ -0,0 +1,13 @@ +{ + "loc.messages.Updatemachinetoenablesecuretlsprotocol": "Make sure the machine is using TLS 1.2 protocol or higher. Check https://aka.ms/enableTlsv2 for more information on how to enable TLS in your machine.", + "loc.messages.JarPathNotPresent": "Java jar path is not present", + "loc.messages.JSONvariablesubstitutionappliedsuccessfully": "JSON variable substitution applied successfully.", + "loc.messages.XMLvariablesubstitutionappliedsuccessfully": "XML variable substitution applied successfully.", + "loc.messages.XDTTransformationsappliedsuccessfully": "XML Transformations applied successfully", + "loc.messages.CannotPerformXdtTransformationOnNonWindowsPlatform": "Cannot perform XML transformations on a non-Windows platform.", + "loc.messages.XdtTransformationErrorWhileTransforming": "XML transformation error while transforming %s using %s.", + "loc.messages.JSONParseError": "Unable to parse JSON file: %s. Error: %s", + "loc.messages.NOJSONfilematchedwithspecificpattern": "NO JSON file matched with specific pattern: %s.", + "loc.messages.FailedToApplyTransformation": "Unable to apply transformation for the given package. Verify the following.", + "loc.messages.MissingArgumentsforXMLTransformation": "Incomplete or missing arguments. Expected format -transform -xml -result . Transformation and source file are mandatory inputs." +} \ No newline at end of file diff --git a/common-npm-packages/webdeployment-common-v2/Strings/resources.resjson/ru-RU/resources.resjson b/common-npm-packages/webdeployment-common-v2/Strings/resources.resjson/ru-RU/resources.resjson new file mode 100644 index 000000000000..9cd973923402 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/Strings/resources.resjson/ru-RU/resources.resjson @@ -0,0 +1,13 @@ +{ + "loc.messages.Updatemachinetoenablesecuretlsprotocol": "Make sure the machine is using TLS 1.2 protocol or higher. Check https://aka.ms/enableTlsv2 for more information on how to enable TLS in your machine.", + "loc.messages.JarPathNotPresent": "Java jar path is not present", + "loc.messages.JSONvariablesubstitutionappliedsuccessfully": "JSON variable substitution applied successfully.", + "loc.messages.XMLvariablesubstitutionappliedsuccessfully": "XML variable substitution applied successfully.", + "loc.messages.XDTTransformationsappliedsuccessfully": "XML Transformations applied successfully", + "loc.messages.CannotPerformXdtTransformationOnNonWindowsPlatform": "Cannot perform XML transformations on a non-Windows platform.", + "loc.messages.XdtTransformationErrorWhileTransforming": "XML transformation error while transforming %s using %s.", + "loc.messages.JSONParseError": "Unable to parse JSON file: %s. Error: %s", + "loc.messages.NOJSONfilematchedwithspecificpattern": "NO JSON file matched with specific pattern: %s.", + "loc.messages.FailedToApplyTransformation": "Unable to apply transformation for the given package. Verify the following.", + "loc.messages.MissingArgumentsforXMLTransformation": "Incomplete or missing arguments. Expected format -transform -xml -result . Transformation and source file are mandatory inputs." +} \ No newline at end of file diff --git a/common-npm-packages/webdeployment-common-v2/Strings/resources.resjson/zh-CN/resources.resjson b/common-npm-packages/webdeployment-common-v2/Strings/resources.resjson/zh-CN/resources.resjson new file mode 100644 index 000000000000..9cd973923402 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/Strings/resources.resjson/zh-CN/resources.resjson @@ -0,0 +1,13 @@ +{ + "loc.messages.Updatemachinetoenablesecuretlsprotocol": "Make sure the machine is using TLS 1.2 protocol or higher. Check https://aka.ms/enableTlsv2 for more information on how to enable TLS in your machine.", + "loc.messages.JarPathNotPresent": "Java jar path is not present", + "loc.messages.JSONvariablesubstitutionappliedsuccessfully": "JSON variable substitution applied successfully.", + "loc.messages.XMLvariablesubstitutionappliedsuccessfully": "XML variable substitution applied successfully.", + "loc.messages.XDTTransformationsappliedsuccessfully": "XML Transformations applied successfully", + "loc.messages.CannotPerformXdtTransformationOnNonWindowsPlatform": "Cannot perform XML transformations on a non-Windows platform.", + "loc.messages.XdtTransformationErrorWhileTransforming": "XML transformation error while transforming %s using %s.", + "loc.messages.JSONParseError": "Unable to parse JSON file: %s. Error: %s", + "loc.messages.NOJSONfilematchedwithspecificpattern": "NO JSON file matched with specific pattern: %s.", + "loc.messages.FailedToApplyTransformation": "Unable to apply transformation for the given package. Verify the following.", + "loc.messages.MissingArgumentsforXMLTransformation": "Incomplete or missing arguments. Expected format -transform -xml -result . Transformation and source file are mandatory inputs." +} \ No newline at end of file diff --git a/common-npm-packages/webdeployment-common-v2/Strings/resources.resjson/zh-TW/resources.resjson b/common-npm-packages/webdeployment-common-v2/Strings/resources.resjson/zh-TW/resources.resjson new file mode 100644 index 000000000000..9cd973923402 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/Strings/resources.resjson/zh-TW/resources.resjson @@ -0,0 +1,13 @@ +{ + "loc.messages.Updatemachinetoenablesecuretlsprotocol": "Make sure the machine is using TLS 1.2 protocol or higher. Check https://aka.ms/enableTlsv2 for more information on how to enable TLS in your machine.", + "loc.messages.JarPathNotPresent": "Java jar path is not present", + "loc.messages.JSONvariablesubstitutionappliedsuccessfully": "JSON variable substitution applied successfully.", + "loc.messages.XMLvariablesubstitutionappliedsuccessfully": "XML variable substitution applied successfully.", + "loc.messages.XDTTransformationsappliedsuccessfully": "XML Transformations applied successfully", + "loc.messages.CannotPerformXdtTransformationOnNonWindowsPlatform": "Cannot perform XML transformations on a non-Windows platform.", + "loc.messages.XdtTransformationErrorWhileTransforming": "XML transformation error while transforming %s using %s.", + "loc.messages.JSONParseError": "Unable to parse JSON file: %s. Error: %s", + "loc.messages.NOJSONfilematchedwithspecificpattern": "NO JSON file matched with specific pattern: %s.", + "loc.messages.FailedToApplyTransformation": "Unable to apply transformation for the given package. Verify the following.", + "loc.messages.MissingArgumentsforXMLTransformation": "Incomplete or missing arguments. Expected format -transform -xml -result . Transformation and source file are mandatory inputs." +} \ No newline at end of file diff --git a/common-npm-packages/webdeployment-common-v2/Tests/L0CopyDirectory.ts b/common-npm-packages/webdeployment-common-v2/Tests/L0CopyDirectory.ts new file mode 100644 index 000000000000..5d9395f08f19 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/Tests/L0CopyDirectory.ts @@ -0,0 +1,59 @@ +var mockery = require('mockery'); +mockery.enable({ + useCleanCache: true, + warnOnReplace: false, + warnOnUnregistered: false +}); + +var fileList = ["C:/vinca/path", "C:/vinca/path/myfile.txt", + "C:/vinca/path/New Folder", "C:/vinca/path/New Folder/Another New Folder", + "C:/vinca/New Folder/anotherfile.py", "C:/vinca/New Folder/Another New Folder/mynewfile.txt"]; + +var mkdirPCount = 0; +var cpfilesCount = 0; +mockery.registerMock('azure-pipelines-task-lib/task', { + exist: function (path) { + console.log("exist : " + path); + }, + find: function (path) { + console.log("find : " + path); + return fileList; + }, + mkdirP: function (path) { + mkdirPCount += 1; + console.log("mkdirp : " + path); + }, + cp: function (source, dest, options, continueOnError) { + if(fileList.indexOf(source)!= -1) { + cpfilesCount += 1; + console.log('cp ' + source + ' to ' + dest); + } + }, + stats: function (path) { + return { + isDirectory: function() { + if(path.endsWith('.py') || path.endsWith('.txt')) { + return false; + } + return true; + } + }; + }, + debug: function(message) { + console.log(message); + } +}); +var utility = require('webdeployment-common-v2/utility.js'); +utility.copyDirectory('C:/vinca/path', 'C:/vinca/path/destFolder'); + +if(cpfilesCount === 3) { + console.log('## Copy Files Successful ##'); +} +/** + * 7 dir to be created including dest dir + * Hash is not created to check already created dir, for testing purpose + */ +if(mkdirPCount === 7) { + console.log('## mkdir Successful ##'); +} + diff --git a/common-npm-packages/webdeployment-common-v2/Tests/L0GenerateWebConfig.ts b/common-npm-packages/webdeployment-common-v2/Tests/L0GenerateWebConfig.ts new file mode 100644 index 000000000000..b73768b71c1e --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/Tests/L0GenerateWebConfig.ts @@ -0,0 +1,32 @@ +var mockery = require('mockery'); +mockery.enable({ + useCleanCache: true, + warnOnReplace: false, + warnOnUnregistered: false +}); + +mockery.registerMock('azure-pipelines-task-lib/task', { + writeFile: function (file, data, options) { + console.log("web.config contents: " + data); + }, + debug: function(message: string) { + console.log("##[debug]: " + message); + } +}); + +mockery.registerMock('fs', { + readFileSync: function (path, format) { + return "{NodeStartFile};{Handler}" + } +}); + +var generateWebConfig = require('webdeployment-common-v2/webconfigutil.js'); +generateWebConfig.generateWebConfigFile( + 'node', + 'TemplatePath/node', + { + "Handler": "iisnode", + "NodeStartFile": "server.js" + } +); + diff --git a/common-npm-packages/webdeployment-common-v2/Tests/L0MSDeployUtility.ts b/common-npm-packages/webdeployment-common-v2/Tests/L0MSDeployUtility.ts new file mode 100644 index 000000000000..189aefff952d --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/Tests/L0MSDeployUtility.ts @@ -0,0 +1,116 @@ +var msdeployUtility = require('webdeployment-common-v2/msdeployutility.js'); + +var errorMessages = { + 'ERROR_INSUFFICIENT_ACCESS_TO_SITE_FOLDER': 'ERROR_INSUFFICIENT_ACCESS_TO_SITE_FOLDER', + "An error was encountered when processing operation 'Delete Directory' on 'D:\\home\\site\\wwwroot\\app_data\\jobs\\continous'": "WebJobsInProgressIssue", + "Cannot delete file main.dll. Error code: FILE_IN_USE": "FILE_IN_USE", + "transport connection": "transport connection", + "error code: ERROR_CONNECTION_TERMINATED": "ERROR_CONNECTION_TERMINATED" +} + +function checkParametersIfPresent(argumentString: string, argumentCheckArray: Array) { + for(var argument of argumentCheckArray) { + if(argumentString.indexOf(argument) == -1) { + return false; + } + } + + return true; +} + +var defaultMSBuildPackageArgument: string = msdeployUtility.getMSDeployCmdArgs('package.zip', 'webapp_name', { + publishUrl: 'http://webapp_name.scm.azurewebsites.net:443', userName: '$webapp_name', userPWD: 'webapp_password' +}, true, false, true, null, null, null, true, false, false); + +console.log(` * MSBUILD DEFAULT PARAMS: ${defaultMSBuildPackageArgument}`); +if(checkParametersIfPresent(defaultMSBuildPackageArgument, ["-source:package=\"'package.zip'\"", + " -dest:auto,ComputerName=\"'https://http://webapp_name.scm.azurewebsites.net:443/msdeploy.axd?site=webapp_name'\",UserName=\"'$webapp_name'\",Password=\"'webapp_password'\",AuthType=\"'Basic'\"", + " -setParam:name=\"'IIS Web Application Name'\",value=\"'webapp_name'\"", '-enableRule:AppOffline']) && defaultMSBuildPackageArgument.indexOf('-setParamFile') == -1) { + console.log("MSBUILD DEFAULT PARAMS PASSED"); +} +else { + throw new Error('MSBUILD PACKAGE DEFAULT PARAMS FAILED'); +} + + +var packageWithSetParamArgument: string = msdeployUtility.getMSDeployCmdArgs('package.zip', 'webapp_name', { + publishUrl: 'http://webapp_name.scm.azurewebsites.net:443', userName: '$webapp_name', userPWD: 'webapp_password' +}, false, false, true, null, 'temp_param.xml', null, false, false, true); + + +console.log(` * PACKAGE WITh SET PARAMS: ${packageWithSetParamArgument}`); + + +if(checkParametersIfPresent(packageWithSetParamArgument, ['-setParamFile=temp_param.xml', "-dest:contentPath=\"'webapp_name'\"" , '-enableRule:DoNotDelete'])) { + console.log('ARGUMENTS WITH SET PARAMS PASSED'); +} +else { + throw Error('ARGUMENTS WITH SET PARAMS FAILED'); +} + +var folderPackageArgument: string = msdeployUtility.getMSDeployCmdArgs('c:/package/folder', 'webapp_name', { + publishUrl: 'http://webapp_name.scm.azurewebsites.net:443', userName: '$webapp_name', userPWD: 'webapp_password' +}, true, false, true, null, null, null, true, true, true); + +console.log(` * ARGUMENT WITh FOLDER AS PACKAGE: ${folderPackageArgument}`); +if(checkParametersIfPresent(folderPackageArgument, [ + "-source:IisApp=\"'c:/package/folder'\"", + " -dest:iisApp=\"'webapp_name'\"" +])) { + console.log('ARGUMENT WITH FOLDER PACKAGE PASSED'); +} +else { + throw Error('ARGUMENT WITH FOLDER PACKAGE FAILED'); +} + + +var packageWithExcludeAppDataArgument: string = msdeployUtility.getMSDeployCmdArgs('package.zip', 'webapp_name', { + publishUrl: 'http://webapp_name.scm.azurewebsites.net:443', userName: '$webapp_name', userPWD: 'webapp_password' +}, false, true, true, null, null, null, false, false, true); + +console.log(` * ARGUMENT WITh FOLDER AS PACKAGE: ${packageWithExcludeAppDataArgument}`); + +if(checkParametersIfPresent(packageWithExcludeAppDataArgument, ['-skip:Directory=App_Data'])) { + console.log('ARGUMENT WITH EXCLUDE APP DATA PASSED'); +} +else { + throw new Error('ARGUMENT WITH EXCLUDE APP DATA FAILED'); +} + + +var warDeploymentArgument: string = msdeployUtility.getMSDeployCmdArgs('package.war', 'webapp_name', { + publishUrl: 'http://webapp_name.scm.azurewebsites.net:443', userName: '$webapp_name', userPWD: 'webapp_password' +}, false, true, true, null, null, null, false, false, true); + +console.log(` * ARGUMENT WITh WAR FILE AS PACKAGE: ${warDeploymentArgument}`); +if(checkParametersIfPresent(warDeploymentArgument, [ + " -source:contentPath=\"'package.war'\"", + " -dest:contentPath=\"'/site/webapps/package.war'\"" +])) { + console.log('ARGUMENT WITH WAR PACKAGE PASSED'); +} +else { + throw new Error('ARGUMENT WITH WAR PACKAGE FAILED'); +} + +var overrideRetryArgument: string = msdeployUtility.getMSDeployCmdArgs('package.zip', 'webapp_name', { + publishUrl: 'http://webapp_name.scm.azurewebsites.net:443', userName: '$webapp_name', userPWD: 'webapp_password' +}, false, true, true, null, null, '-retryAttempts:11 -retryInterval:5000', false, false, true); + +console.log(` * ARGUMENTS WITH WAR FILE: ${overrideRetryArgument}`); + +if(checkParametersIfPresent(overrideRetryArgument, ['-retryAttempts:11', '-retryInterval:5000'])) { + console.log('ARGUMENT WITH OVERRIDE RETRY FLAG PASSED'); +} +else { + throw new Error('ARGUMENT WITH OVERRIDE RETRY FLAG FAILED'); +} + +// msdeployutility getWebDeployErrorCode +for(var errorMessage in errorMessages) { + if(msdeployUtility.getWebDeployErrorCode(errorMessage) != errorMessages[errorMessage]) { + throw new Error('MSDEPLOY getWebDeployErrorCode failed'); + } +} + +console.log('MSDEPLOY getWebDeployErrorCode passed'); \ No newline at end of file diff --git a/common-npm-packages/webdeployment-common-v2/Tests/L1JSONVarSub/InvalidJSONWithComments.json b/common-npm-packages/webdeployment-common-v2/Tests/L1JSONVarSub/InvalidJSONWithComments.json new file mode 100644 index 000000000000..06b66bd7e555 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/Tests/L1JSONVarSub/InvalidJSONWithComments.json @@ -0,0 +1,76 @@ +{ + \\ JSON Substitution bug fixes + "id": "497D490F-EEA7-4F2B-AB94-48D9C1ACDCB1", + "name": "AzureRmWebAppDeployment", + "friendlyName": "Azure App Service Deploy", + "description": "Update Azure WebApp Services On Windows, Web App On Linux with built-in images or docker containers, ASP.NET, .NET Core, PHP, Python or Node based Web applications, Function Apps, Mobile Apps, Api applications, Web Jobs using Web Deploy / Kudu REST APIs", + "helpMarkDown": "[More Information](https://aka.ms/azurermwebdeployreadme)", + "category": "Deploy", + "visibility": [ + "Build", + "Release" + ], + "runsOn": [ + "Agent" + ], + // "singleLineComment": "OLD_VALUE" + "author": "Microsoft Corporation", + "version": { + "Major": 3, + "Minor": 3, + "Patch": 35 + }, + /* + "MultiLineComment" : { + "name": "AzureRmWebAppDeployment", + }, + + "releaseNotes": "What's new in Version 3.0:
  Supports File Transformations (XDT)
  Supports Variable Substitutions(XML, JSON)
Click [here](https://aka.ms/azurermwebdeployreadme) for more Information.", + "minimumAgentVersion": "2.104.1", /* + "groups": [ + { + /* + "name": "FileTransformsAndVariableSubstitution, + "displayName": "File Transforms & Variable Substitution Options, + "isExpanded": false, + "visibleRule": "WebAppKind != applinux && WebAppKind != \"\"" + */ + }, + { + // "name" : "dsadaflhflk lfhsdflsh asjf (some invalid types) + "name": "AdditionalDeploymentOptions", + "displayName": "Additional Deployment Options", + "isExpanded": false, + "visibleRule": "WebAppKind != applinux && WebAppKind != \"\"" + }, + { + "name": "PostDeploymentAction", + "displayName": "Post Deployment Action", + "isExpanded": false, + "visibleRule": "WebAppKind != \"\"" + }, + { + "name": "output", + "displayName": "Output", + "isExpanded": true, + "visibleRule": "WebAppKind != \"\"" + }, + { + "name": "ApplicationSettings", + "displayName": "Application Settings", + "isExpanded": true, + "visibleRule": "WebAppKind = applinux" + } + ] +} +/* To substitute values in nested levels of the file, concatenate the names with a period (.) in hierarchical order. + +A JSON object may contain an array whose values can be referenced by their index. For example, to substitute the first value in the Users array shown above, use the variable name DBAccess.Users.0. To update the value in NewWelcomeMessage, use the variable name FeatureFlags.Preview.1.NewWelcomeMessage. + +Only String substitution is supported for JSON variable substitution. + +Substitution is supported for only UTF-8 and UTF-16 LE encoded files. + +If the file specification you enter does not match any file, the task will fail. + +Variable name matching is case-sensitive. \ No newline at end of file diff --git a/common-npm-packages/webdeployment-common-v2/Tests/L1JSONVarSub/JSONWithComments.json b/common-npm-packages/webdeployment-common-v2/Tests/L1JSONVarSub/JSONWithComments.json new file mode 100644 index 000000000000..332cb60d8b2f --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/Tests/L1JSONVarSub/JSONWithComments.json @@ -0,0 +1,409 @@ + +{ + // JSON Substitution bug fixes + "id": "497D490F-EEA7-4F2B-AB94-48D9C1ACDCB1", + "name": "AzureRmWebAppDeployment", + "friendlyName": "Azure App Service Deploy", + "description": "Update Azure WebApp Services On Windows, Web App On Linux with built-in images or docker containers, ASP.NET, .NET Core, PHP, Python or Node based Web applications, Function Apps, Mobile Apps, Api applications, Web Jobs using Web Deploy / Kudu REST APIs", + "helpMarkDown": "[More Information](https://aka.ms/azurermwebdeployreadme)", + "category": "Deploy", + "Hello": { + "World": null + }, + /* + To substitute values in nested levels of the file, concatenate the names with a period (.) in hierarchical order. + + A JSON object may contain an array whose values can be referenced by their index. For example, to substitute the first value in the Users array shown above, use the variable name DBAccess.Users.0. To update the value in NewWelcomeMessage, use the variable name FeatureFlags.Preview.1.NewWelcomeMessage. + + Only String substitution is supported for JSON variable substitution. + + Substitution is supported for only UTF-8 and UTF-16 LE encoded files. + + If the file specification you enter does not match any file, the task will fail. + + Variable name matching is case-sensitive. + */ + "dataSourceBindings": [ + { + "target": "WebAppName", + "endpointId": "$(ConnectedServiceName)", + "dataSourceName": "AzureRMWebAppNamesByType", + "parameters": { + "WebAppKind": "$(WebAppKind)" + } + }, + { + "target": "ResourceGroupName", + "endpointId": "$(ConnectedServiceName)", + "dataSourceName": "AzureRMWebAppResourceGroup", + "parameters": { + "WebAppName": "$(WebAppName)" + } + }, + { + "target": "SlotName", + "endpointId": "$(ConnectedServiceName)", + "dataSourceName": "AzureRMWebAppSlotsId", + "parameters": { + "WebAppName": "$(WebAppName)", + "ResourceGroupName": "$(ResourceGroupName)" + }, + "resultTemplate": "{\"Value\":\"{{{ #extractResource slots}}}\",\"DisplayValue\":\"{{{ #extractResource slots}}}\"}" + }, + { + "target": "AzureContainerRegistry", + "endpointId": "$(ConnectedServiceName)", + "dataSourceName": "AzureRMContainerRegistries", + "resultTemplate": "{\"Value\":\"{{{ name }}}\",\"DisplayValue\":\"{{{ name }}}\"}" + }, + { + "target": "AzureContainerRegistryLoginServer", + "endpointId": "$(ConnectedServiceName)", + "dataSourceName": "AzureContainerRegistryLoginServer", + "parameters": { + "AzureContainerRegistry": "$(AzureContainerRegistry)" + }, + "resultTemplate": "{\"Value\":\"{{{ #stringReplace '.azurecr.io' '' loginServer }}}\",\"DisplayValue\":\"{{{ #stringReplace '.azurecr.io' '' loginServer }}}\"}" + }, + { + "target": "AzureContainerRegistryImage", + "endpointId": "$(ConnectedServiceName)", + "dataSourceName": "AzureContainerRegistryImages", + "parameters": { + "AzureContainerRegistryLoginServer": "$(AzureContainerRegistryLoginServer)" + } + }, + { + "target": "AzureContainerRegistryTag", + "endpointId": "$(ConnectedServiceName)", + "dataSourceName": "AzureContainerRegistryTags", + "parameters": { + "AzureContainerRegistryLoginServer": "$(AzureContainerRegistryLoginServer)", + "AzureContainerRegistryImage": "$(AzureContainerRegistryImage)" + } + }, + { + "target": "DockerNamespace", + "endpointId": "$(RegistryConnectedServiceName)", + "dataSourceName": "Namespaces" + }, + { + "target": "DockerRepository", + "endpointId": "$(RegistryConnectedServiceName)", + "dataSourceName": "Repos", + "parameters": { + "namespaces": "$(DockerNamespace)" + } + }, + { + "target": "DockerImageTag", + "endpointId": "$(RegistryConnectedServiceName)", + "dataSourceName": "Tags", + "parameters": { + "DockerNamespace": "$(DockerNamespace)", + "DockerRepository": "$(DockerRepository)" + } + }, + { + "target": "PrivateRegistryImage", + "endpointId": "$(RegistryConnectedServiceName)", + "endpointUrl": "{{endpoint.url}}v2/_catalog", + "resultSelector": "jsonpath:$.repositories[*]", + "authorizationHeader": "Basic {{ #base64 endpoint.username \":\" endpoint.password }}" + }, + { + "target": "PrivateRegistryTag", + "endpointId": "$(RegistryConnectedServiceName)", + "endpointUrl": "{{endpoint.url}}v2/$(PrivateRegistryImage)/tags/list", + "resultSelector": "jsonpath:$.tags[*]", + "authorizationHeader": "Basic {{ #base64 endpoint.username \":\" endpoint.password }}" + } + ], + "visibility": [ + "Build", + "Release" + ], + /* + { + "Data": { + "DefaultConnection": { + "ConnectionString": "Data Source=(LocalDb)\MSDB;AttachDbFilename=aspcore-local.mdf;" + }, + "DebugMode": "enabled", + "DBAccess": { + "Admininstrators": ["Admin-1", "Admin-2"], + "Users": ["Vendor-1", "vendor-3"] + }, + "FeatureFlags": { + "Preview": [ + { + "newUI": "AllAccounts" + }, + { + "NewWelcomeMessage": "Newusers" + } + ] + } + } + } + */ + "runsOn": [ + "Agent" + ], + // "singleLineComment": "OLD_VALUE" + "author": "Microsoft Corporation", + /* + "messages1": { + "Invalidwebapppackageorfolderpathprovided": "Invalid App Service package or folder path provided: %s", + "SetParamFilenotfound0": "Set parameters file not found: %s", + "XDTTransformationsappliedsuccessfully": "XML Transformations applied successfully", + "GotconnectiondetailsforazureRMWebApp0": "Got connection details for Azure App Service:'%s'", + "ErrorNoSuchDeployingMethodExists": "Error : No such deploying method exists", + "UnabletoretrieveconnectiondetailsforazureRMWebApp": "Unable to retrieve connection details for Azure App Service : %s. Status Code: %s (%s)", + "UnabletoretrieveResourceID": "Unable to retrieve connection details for Azure Resource:'%s'. Status Code: %s", + "CouldnotfetchaccesstokenforAzureStatusCode": "Could not fetch access token for Azure. Status Code: %s (%s)", + "Successfullyupdateddeploymenthistory": "Successfully updated deployment History at %s", + "Failedtoupdatedeploymenthistory": "Failed to update deployment history.", + "WARNINGCannotupdatedeploymentstatusSCMendpointisnotenabledforthiswebsite": "WARNING : Cannot update deployment status : SCM endpoint is not enabled for this website", + "Unabletoretrievewebconfigdetails": "Unable to retrieve App Service configuration details. Status Code: '%s'", + "Unabletoretrievewebappsettings": "Unable to retrieve App Service application settings. [Status Code: '%s', Error Message: '%s']", + "Unabletoupdatewebappsettings": "Unable to update App service application settings. Status Code: '%s'", + "CannotupdatedeploymentstatusuniquedeploymentIdCannotBeRetrieved": "Cannot update deployment status : Unique Deployment ID cannot be retrieved", + "PackageDeploymentSuccess": "Successfully deployed web package to App Service.", + "PackageDeploymentFailed": "Failed to deploy web package to App Service.", + "Runningcommand": "Running command: %s", + "Deployingwebapplicationatvirtualpathandphysicalpath": "Deploying web package : %s at virtual path (physical path) : %s (%s)", + "Successfullydeployedpackageusingkuduserviceat": "Successfully deployed package %s using kudu service at %s", + "Failedtodeploywebapppackageusingkuduservice": "Failed to deploy App Service package using kudu service : %s", + "Unabletodeploywebappresponsecode": "Unable to deploy App Service due to error code : %s", + "MSDeploygeneratedpackageareonlysupportedforWindowsplatform": "MSDeploy generated packages are only supported for Windows platform.", + "UnsupportedinstalledversionfoundforMSDeployversionshouldbeatleast3orabove": "Unsupported installed version: %s found for MSDeploy. version should be at least 3 or above", + "UnabletofindthelocationofMSDeployfromregistryonmachineError": "Unable to find the location of MS Deploy from registry on machine (Error : %s)", + "Nopackagefoundwithspecifiedpattern": "No package found with specified pattern", + "MorethanonepackagematchedwithspecifiedpatternPleaserestrainthesearchpattern": "More than one package matched with specified pattern. Please restrain the search pattern.", + "Trytodeploywebappagainwithappofflineoptionselected": "Try to deploy app service again with Take application offline option selected.", + "Trytodeploywebappagainwithrenamefileoptionselected": "Try to deploy app service again with Rename locked files option selected.", + "NOJSONfilematchedwithspecificpattern": "NO JSON file matched with specific pattern: %s.", + "Configfiledoesntexists": "Configuration file %s doesn't exist.", + "Failedtowritetoconfigfilewitherror": "Failed to write to config file %s with error : %s", + "AppOfflineModeenabled": "App offline mode enabled.", + "Failedtoenableappofflinemode": "Failed to enable app offline mode. Status Code: %s (%s)", + "AppOflineModedisabled": "App offline mode disabled.", + "FailedtodisableAppOfflineMode": "Failed to disable App offline mode. Status Code: %s (%s)", + "CannotPerformXdtTransformationOnNonWindowsPlatform": "Cannot perform XML transformations on a non-Windows platform.", + "XdtTransformationErrorWhileTransforming": "XML transformation error while transforming %s using %s.", + "PublishusingwebdeployoptionsaresupportedonlywhenusingWindowsagent": "Publish using webdeploy options are supported only when using Windows agent", + "ResourceDoesntExist": "Resource '%s' doesn't exist. Resource should exist before deployment.", + "EncodeNotSupported": "Detected file encoding of the file %s as %s. Variable substitution is not supported with file encoding %s. Supported encodings are UTF-8 and UTF-16 LE.", + "UnknownFileEncodeError": "Unable to detect encoding of the file %s (typeCode: %s). Supported encodings are UTF-8 and UTF-16 LE.", + "ShortFileBufferError": "File buffer is too short to detect encoding type : %s", + "FailedToUpdateAzureRMWebAppConfigDetails": "Failed to update App Service configuration details. Error: %s", + "SuccessfullyUpdatedAzureRMWebAppConfigDetails": "Successfully updated App Service configuration details", + "RequestedURLforkuduphysicalpath": "Requested URL for kudu physical path : %s", + "Physicalpathalreadyexists": "Physical path '%s' already exists", + "KuduPhysicalpathCreatedSuccessfully": "Kudu physical path created successfully : %s", + "FailedtocreateKuduPhysicalPath": "Failed to create kudu physical path. Error Code: %s", + "FailedtocheckphysicalPath": "Failed to check kudu physical path. Error Code: %s", + "VirtualApplicationDoesNotExist": "Virtual application doesn't exists : %s", + "JSONParseError": "Unable to parse JSON file: %s. Error: %s", + "JSONvariablesubstitutionappliedsuccessfully": "JSON variable substitution applied successfully.", + "XMLvariablesubstitutionappliedsuccessfully": "XML variable substitution applied successfully.", + "failedtoUploadFileToKudu": "Unable to upload file: %s to Kudu (%s). Status Code: %s", + "failedtoUploadFileToKuduError": "Unable to upload file: %s to Kudu (%s). Error: %s", + "ExecuteScriptOnKudu": "Executing given script on Kudu: %s", + "FailedToRunScriptOnKuduError": "Unable to run the script on Kudu: %s. Error: %s", + "FailedToRunScriptOnKudu": "Unable to run the script on Kudu: %s. Status Code: %s", + "ScriptExecutionOnKuduSuccess": "Successfully executed script on Kudu.", + "ScriptExecutionOnKuduFailed": "Executed script returned '%s' as return code. Error: %s", + "FailedtoDeleteFileFromKudu": "Unable to delete file: %s from Kudu (%s). Status Code: %s", + "FailedtoDeleteFileFromKuduError": "Unable to delete file: %s from Kudu (%s). Error: %s", + "ScriptFileNotFound": "Script file '%s' not found.", + "InvalidScriptFile": "Invalid script file '%s' provided. Valid extensions are .bat and .cmd for windows and .sh for linux", + "RetryForTimeoutIssue": "Script execution failed with timeout issue. Retrying once again.", + "stdoutFromScript": "Standard output from script: ", + "stderrFromScript": "Standard error from script: ", + "WebConfigAlreadyExists": "web.config file already exists. Not generating.", + "SuccessfullyGeneratedWebConfig": "Successfully generated web.config file", + "FailedToGenerateWebConfig": "Failed to generate web.config. %s", + "FailedToGetKuduFileContent": "Unable to get file content: %s . Status code: %s (%s)", + "FailedToGetKuduFileContentError": "Unable to get file content: %s. Error: %s", + "ScriptStatusTimeout": "Unable to fetch script status due to timeout.", + "PollingForFileTimeOut": "Unable to fetch script status due to timeout. You can increase the timeout limit by setting 'appservicedeploy.retrytimeout' variable to number of minutes required.", + "InvalidPollOption": "Invalid polling option provided: %s.", + "MissingAppTypeWebConfigParameters": "Attribute '-appType' is missing in the Web.config parameters. Valid values for '-appType' are: 'python_Bottle', 'python_Django', 'python_Flask' and 'node'.
For example, '-appType python_Bottle' (sans-quotes) in case of Python Bottle framework..", + "AutoDetectDjangoSettingsFailed": "Unable to detect DJANGO_SETTINGS_MODULE 'settings.py' file path. Ensure that the 'settings.py' file exists or provide the correct path in Web.config parameter input in the following format '-DJANGO_SETTINGS_MODULE .settings'", + "FailedToApplyTransformation": "Unable to apply transformation for the given package. Verify the following.", + "FailedToApplyTransformationReason1": "1. Whether the Transformation is already applied for the MSBuild generated package during build. If yes, remove the tag for each config in the csproj file and rebuild. ", + "FailedToApplyTransformationReason2": "2. Ensure that the config file and transformation files are present in the same folder inside the package.", + "AutoParameterizationMessage": "ConnectionString attributes in Web.config is parameterized by default. Note that the transformation has no effect on connectionString attributes as the value is overridden during deployment by 'Parameters.xml or 'SetParameters.xml' files. You can disable the auto-parameterization by setting /p:AutoParameterizationWebConfigConnectionStrings=False during MSBuild package generation.", + "UnsupportedAppType": "App type '%s' not supported in Web.config generation. Valid values for '-appType' are: 'python_Bottle', 'python_Django', 'python_Flask' and 'node'", + "UnableToFetchAuthorityURL": "Unable to fetch authority url.", + "UnableToFetchActiveDirectory": "Unable to fetch active directory resource id.", + "SuccessfullyUpdatedRuntimeStackAndStartupCommand": "Successfully updated the Runtime Stack and Startup Command.", + "FailedToUpdateRuntimeStackAndStartupCommand": "Failed to update the Runtime Stack and Startup Command. Error: %s.", + "SuccessfullyUpdatedWebAppSettings": "Successfully updated the App settings.", + "FailedToUpdateAppSettingsInConfigDetails": "Failed to update the App settings. Error: %s.", + "UnableToGetAzureRMWebAppMetadata": "Failed to fetch AzureRM WebApp metadata. ErrorCode: %s", + "UnableToUpdateAzureRMWebAppMetadata": "Unable to update AzureRM WebApp metadata. Error Code: %s", + "Unabletoretrieveazureregistrycredentials": "Unable to retrieve Azure Container Registry credentails.[Status Code: '%s']", + "UnableToReadResponseBody": "Unable to read response body. Error: %s", + "UnableToUpdateWebAppConfigDetails": "Unable to update WebApp config details. StatusCode: '%s'", + "AddingReleaseAnnotation": "Adding release annotation for the Application Insights resource '%s'", + "SuccessfullyAddedReleaseAnnotation": "Successfully added release annotation to the Application Insight : %s", + "FailedAddingReleaseAnnotation": "Failed to add release annotation. %s" + } + */ + "version": { + "Major": 3, + "Minor": 3, + "Patch": 35 + }, + /* + "MultiLineComment" : { + "name": "AzureRmWebAppDeployment", + }, + */ + "releaseNotes": "What's new in Version 3.0:
  Supports File Transformations (XDT)
  Supports Variable Substitutions(XML, JSON)
Click [here](https://aka.ms/azurermwebdeployreadme) for more Information.", + "minimumAgentVersion": "2.104.1", /* */ + "groups": [ + { + /* + "name": "FileTransformsAndVariableSubstitution, + "displayName": "File Transforms & Variable Substitution Options, + "isExpanded": false, + "visibleRule": "WebAppKind != applinux && WebAppKind != \"\"" + */ + }, + { + // "name" : "dsadaflhflk lfhsdflsh asjf (some invalid types) + "name": "AdditionalDeploymentOptions", + "displayName": "Additional Deployment Options", + "isExpanded": false, + "visibleRule": "WebAppKind != applinux && WebAppKind != \"\"" + }, + { + "name": "PostDeploymentAction", + "displayName": "Post Deployment Action", + "isExpanded": false, + "visibleRule": "WebAppKind != \"\"" + }, + { + "name": "output", + "displayName": "Output", + "isExpanded": true, + "visibleRule": "WebAppKind != \"\"" + }, + { + "name": "ApplicationSettings", + "displayName": "Application Settings", + "isExpanded": true, + "visibleRule": "WebAppKind = applinux" + } + ], + "messages": { + "Invalidwebapppackageorfolderpathprovided": "Invalid App Service package or folder path provided: %s", + "SetParamFilenotfound0": "Set parameters file not found: %s", + "XDTTransformationsappliedsuccessfully": "XML Transformations applied successfully", + "GotconnectiondetailsforazureRMWebApp0": "Got connection details for Azure App Service:'%s'", + "ErrorNoSuchDeployingMethodExists": "Error : No such deploying method exists", + "UnabletoretrieveconnectiondetailsforazureRMWebApp": "Unable to retrieve connection details for Azure App Service : %s. Status Code: %s (%s)", + "UnabletoretrieveResourceID": "Unable to retrieve connection details for Azure Resource:'%s'. Status Code: %s", + "CouldnotfetchaccesstokenforAzureStatusCode": "Could not fetch access token for Azure. Status Code: %s (%s)", + "Successfullyupdateddeploymenthistory": "Successfully updated deployment History at %s", + "Failedtoupdatedeploymenthistory": "Failed to update deployment history.", + "WARNINGCannotupdatedeploymentstatusSCMendpointisnotenabledforthiswebsite": "WARNING : Cannot update deployment status : SCM endpoint is not enabled for this website", + "Unabletoretrievewebconfigdetails": "Unable to retrieve App Service configuration details. Status Code: '%s'", + "Unabletoretrievewebappsettings": "Unable to retrieve App Service application settings. [Status Code: '%s', Error Message: '%s']", + "Unabletoupdatewebappsettings": "Unable to update App service application settings. Status Code: '%s'", + "CannotupdatedeploymentstatusuniquedeploymentIdCannotBeRetrieved": "Cannot update deployment status : Unique Deployment ID cannot be retrieved", + "PackageDeploymentSuccess": "Successfully deployed web package to App Service.", + "PackageDeploymentFailed": "Failed to deploy web package to App Service.", + "Runningcommand": "Running command: %s", + "Deployingwebapplicationatvirtualpathandphysicalpath": "Deploying web package : %s at virtual path (physical path) : %s (%s)", + "Successfullydeployedpackageusingkuduserviceat": "Successfully deployed package %s using kudu service at %s", + "Failedtodeploywebapppackageusingkuduservice": "Failed to deploy App Service package using kudu service : %s", + "Unabletodeploywebappresponsecode": "Unable to deploy App Service due to error code : %s", + "MSDeploygeneratedpackageareonlysupportedforWindowsplatform": "MSDeploy generated packages are only supported for Windows platform.", + "UnsupportedinstalledversionfoundforMSDeployversionshouldbeatleast3orabove": "Unsupported installed version: %s found for MSDeploy. version should be at least 3 or above", + "UnabletofindthelocationofMSDeployfromregistryonmachineError": "Unable to find the location of MS Deploy from registry on machine (Error : %s)", + "Nopackagefoundwithspecifiedpattern": "No package found with specified pattern", + "MorethanonepackagematchedwithspecifiedpatternPleaserestrainthesearchpattern": "More than one package matched with specified pattern. Please restrain the search pattern.", + "Trytodeploywebappagainwithappofflineoptionselected": "Try to deploy app service again with Take application offline option selected.", + "Trytodeploywebappagainwithrenamefileoptionselected": "Try to deploy app service again with Rename locked files option selected.", + "NOJSONfilematchedwithspecificpattern": "NO JSON file matched with specific pattern: %s.", + "Configfiledoesntexists": "Configuration file %s doesn't exist.", + "Failedtowritetoconfigfilewitherror": "Failed to write to config file %s with error : %s", + "AppOfflineModeenabled": "App offline mode enabled.", + "Failedtoenableappofflinemode": "Failed to enable app offline mode. Status Code: %s (%s)", + "AppOflineModedisabled": "App offline mode disabled.", + "FailedtodisableAppOfflineMode": "Failed to disable App offline mode. Status Code: %s (%s)", + "CannotPerformXdtTransformationOnNonWindowsPlatform": "Cannot perform XML transformations on a non-Windows platform.", + "XdtTransformationErrorWhileTransforming": "XML transformation error while transforming %s using %s.", + "PublishusingwebdeployoptionsaresupportedonlywhenusingWindowsagent": "Publish using webdeploy options are supported only when using Windows agent", + "ResourceDoesntExist": "Resource '%s' doesn't exist. Resource should exist before deployment.", + "EncodeNotSupported": "Detected file encoding of the file %s as %s. Variable substitution is not supported with file encoding %s. Supported encodings are UTF-8 and UTF-16 LE.", + "UnknownFileEncodeError": "Unable to detect encoding of the file %s (typeCode: %s). Supported encodings are UTF-8 and UTF-16 LE.", + "ShortFileBufferError": "File buffer is too short to detect encoding type : %s", + "FailedToUpdateAzureRMWebAppConfigDetails": "Failed to update App Service configuration details. Error: %s", + "SuccessfullyUpdatedAzureRMWebAppConfigDetails": "Successfully updated App Service configuration details", + "RequestedURLforkuduphysicalpath": "Requested URL for kudu physical path : %s", + "Physicalpathalreadyexists": "Physical path '%s' already exists", + "KuduPhysicalpathCreatedSuccessfully": "Kudu physical path created successfully : %s", + "FailedtocreateKuduPhysicalPath": "Failed to create kudu physical path. Error Code: %s", + "FailedtocheckphysicalPath": "Failed to check kudu physical path. Error Code: %s", + "VirtualApplicationDoesNotExist": "Virtual application doesn't exists : %s", + "JSONParseError": "Unable to parse JSON file: %s. Error: %s", + "JSONvariablesubstitutionappliedsuccessfully": "JSON variable substitution applied successfully.", + "XMLvariablesubstitutionappliedsuccessfully": "XML variable substitution applied successfully.", + "failedtoUploadFileToKudu": "Unable to upload file: %s to Kudu (%s). Status Code: %s", + "failedtoUploadFileToKuduError": "Unable to upload file: %s to Kudu (%s). Error: %s", + "ExecuteScriptOnKudu": "Executing given script on Kudu: %s", + "FailedToRunScriptOnKuduError": "Unable to run the script on Kudu: %s. Error: %s", + "FailedToRunScriptOnKudu": "Unable to run the script on Kudu: %s. Status Code: %s", + "ScriptExecutionOnKuduSuccess": "Successfully executed script on Kudu.", + "ScriptExecutionOnKuduFailed": "Executed script returned '%s' as return code. Error: %s", + "FailedtoDeleteFileFromKudu": "Unable to delete file: %s from Kudu (%s). Status Code: %s", + "FailedtoDeleteFileFromKuduError": "Unable to delete file: %s from Kudu (%s). Error: %s", + "ScriptFileNotFound": "Script file '%s' not found.", + "InvalidScriptFile": "Invalid script file '%s' provided. Valid extensions are .bat and .cmd for windows and .sh for linux", + "RetryForTimeoutIssue": "Script execution failed with timeout issue. Retrying once again.", + "stdoutFromScript": "Standard output from script: ", + "stderrFromScript": "Standard error from script: ", + "WebConfigAlreadyExists": "web.config file already exists. Not generating.", + "SuccessfullyGeneratedWebConfig": "Successfully generated web.config file", + "FailedToGenerateWebConfig": "Failed to generate web.config. %s", + "FailedToGetKuduFileContent": "Unable to get file content: %s . Status code: %s (%s)", + "FailedToGetKuduFileContentError": "Unable to get file content: %s. Error: %s", + "ScriptStatusTimeout": "Unable to fetch script status due to timeout.", + "PollingForFileTimeOut": "Unable to fetch script status due to timeout. You can increase the timeout limit by setting 'appservicedeploy.retrytimeout' variable to number of minutes required.", + "InvalidPollOption": "Invalid polling option provided: %s.", + "MissingAppTypeWebConfigParameters": "Attribute '-appType' is missing in the Web.config parameters. Valid values for '-appType' are: 'python_Bottle', 'python_Django', 'python_Flask' and 'node'.
For example, '-appType python_Bottle' (sans-quotes) in case of Python Bottle framework..", + "AutoDetectDjangoSettingsFailed": "Unable to detect DJANGO_SETTINGS_MODULE 'settings.py' file path. Ensure that the 'settings.py' file exists or provide the correct path in Web.config parameter input in the following format '-DJANGO_SETTINGS_MODULE .settings'", + "FailedToApplyTransformation": "Unable to apply transformation for the given package. Verify the following.", + "FailedToApplyTransformationReason1": "1. Whether the Transformation is already applied for the MSBuild generated package during build. If yes, remove the tag for each config in the csproj file and rebuild. ", + "FailedToApplyTransformationReason2": "2. Ensure that the config file and transformation files are present in the same folder inside the package.", + "AutoParameterizationMessage": "ConnectionString attributes in Web.config is parameterized by default. Note that the transformation has no effect on connectionString attributes as the value is overridden during deployment by 'Parameters.xml or 'SetParameters.xml' files. You can disable the auto-parameterization by setting /p:AutoParameterizationWebConfigConnectionStrings=False during MSBuild package generation.", + "UnsupportedAppType": "App type '%s' not supported in Web.config generation. Valid values for '-appType' are: 'python_Bottle', 'python_Django', 'python_Flask' and 'node'", + "UnableToFetchAuthorityURL": "Unable to fetch authority url.", + "UnableToFetchActiveDirectory": "Unable to fetch active directory resource id.", + "SuccessfullyUpdatedRuntimeStackAndStartupCommand": "Successfully updated the Runtime Stack and Startup Command.", + "FailedToUpdateRuntimeStackAndStartupCommand": "Failed to update the Runtime Stack and Startup Command. Error: %s.", + "SuccessfullyUpdatedWebAppSettings": "Successfully updated the App settings.", + "FailedToUpdateAppSettingsInConfigDetails": "Failed to update the App settings. Error: %s.", + "UnableToGetAzureRMWebAppMetadata": "Failed to fetch AzureRM WebApp metadata. ErrorCode: %s", + "UnableToUpdateAzureRMWebAppMetadata": "Unable to update AzureRM WebApp metadata. Error Code: %s", + "Unabletoretrieveazureregistrycredentials": "Unable to retrieve Azure Container Registry credentails.[Status Code: '%s']", + "UnableToReadResponseBody": "Unable to read response body. Error: %s", + "UnableToUpdateWebAppConfigDetails": "Unable to update WebApp config details. StatusCode: '%s'", + "AddingReleaseAnnotation": "Adding release annotation for the Application Insights resource '%s'", + "SuccessfullyAddedReleaseAnnotation": "Successfully added release annotation to the Application Insight : %s", + "FailedAddingReleaseAnnotation": "Failed to add release annotation. %s" + } + +} +/* +This feature substitutes values in the JSON configuration files. It overrides the values in the specified JSON configuration files +(for example, appsettings.json) with the values matching names of release definition and environment variables. +To substitute variables in specific JSON files, provide newline-separated list of JSON files. File names must be specified relative to the root folder. +For example, if your package has this structure: +*/ \ No newline at end of file diff --git a/common-npm-packages/webdeployment-common-v2/Tests/L1JSONVarSubWithComments.ts b/common-npm-packages/webdeployment-common-v2/Tests/L1JSONVarSubWithComments.ts new file mode 100644 index 000000000000..ea523efb0c4c --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/Tests/L1JSONVarSubWithComments.ts @@ -0,0 +1,52 @@ +var jsonSubUtil = require('webdeployment-common-v2/jsonvariablesubstitutionutility.js'); +import fs = require('fs'); +import path = require('path'); + +var envVarObject = jsonSubUtil.createEnvTree([ + { name: 'dataSourceBindings.0.target', value: 'AppServiceName', secret: false}, + { name: 'name', value: 'App Service Deploy', secret: false}, + { name: 'Hello.World', value: 'Hello World', secret: false}, + { name: 'dataSourceBindings.1.parameters.WebAppName', value: 'App Service Name params', secret: false}, + { name: 'messages.Invalidwebapppackageorfolderpathprovided', value: 'Invalidwebapppackageorfolderpathprovided', secret: true} +]); + +function validateJSONWithComments() { + var fileContent: string = fs.readFileSync(path.join(__dirname, 'L1JSONVarSub', 'JSONWithComments.json'), 'utf-8'); + var jsonContent: string = jsonSubUtil.stripJsonComments(fileContent); + var jsonObject = JSON.parse(jsonContent); + jsonSubUtil.substituteJsonVariable(jsonObject, envVarObject); + + if(jsonObject['dataSourceBindings']['0']['target'] != 'AppServiceName') { + throw new Error('JSON VAR SUB FAIL #1'); + } + if(jsonObject['name'] != 'App Service Deploy') { + throw new Error('JSON VAR SUB FAIL #2'); + } + if(jsonObject['Hello']['World'] != 'Hello World') { + throw new Error('JSON VAR SUB FAIL #3'); + } + if(jsonObject['dataSourceBindings']['1']['parameters']['WebAppName'] != 'App Service Name params') { + throw new Error('JSON VAR SUB FAIL #4'); + } + if(jsonObject['messages']['Invalidwebapppackageorfolderpathprovided'] != 'Invalidwebapppackageorfolderpathprovided') { + throw new Error('JSON VAR SUB FAIL #5'); + } + console.log("VALID JSON COMMENTS TESTS PASSED"); +} + +function validateInvalidJSONWithComments() { + var fileContent: string = fs.readFileSync(path.join(__dirname, 'L1JSONVarSub', 'InvalidJSONWithComments.json'), 'utf-8'); + var jsonContent: string = jsonSubUtil.stripJsonComments(fileContent); + try { + var jsonObject = JSON.parse(jsonContent); + throw new Error('JSON VAR SUB FAIL #6'); + } + catch(error) { + console.log("INVALID JSON COMMENTS TESTS PASSED"); + } +} + +export function validate() { + validateJSONWithComments(); + validateInvalidJSONWithComments(); +} \ No newline at end of file diff --git a/common-npm-packages/webdeployment-common-v2/Tests/L1JsonVarSub.ts b/common-npm-packages/webdeployment-common-v2/Tests/L1JsonVarSub.ts new file mode 100644 index 000000000000..fed0ea6141a8 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/Tests/L1JsonVarSub.ts @@ -0,0 +1,71 @@ +import { validate } from './L1JSONVarSubWithComments'; +var jsonSubUtil = require('webdeployment-common-v2/jsonvariablesubstitutionutility.js'); + +var envVarObject = jsonSubUtil.createEnvTree([ + { name: 'system.debug', value: 'true', secret: false}, + { name: 'data.ConnectionString', value: 'database_connection', secret: false}, + { name: 'data.userName', value: 'db_admin', secret: false}, + { name: 'data.password', value: 'db_pass', secret: true}, + { name: '&pl.ch@r@cter.k^y', value: '*.config', secret: false}, + { name: 'build.sourceDirectory', value: 'DefaultWorkingDirectory', secret: false}, + { name: 'user.profile.name.first', value: 'firstName', secret: false}, + { name: 'user.profile', value: 'replace_all', secret: false}, + { name: 'constructor.name', value: 'newConstructorName', secret: false}, + { name: 'constructor.valueOf', value: 'constructorNewValue', secret: false}, + { name: 'systemsettings.appurl', value: 'https://dev.azure.com/helloworld', secret: false} +]); + +var jsonObject = { + 'User.Profile': 'do_not_replace', + 'data': { + 'ConnectionString' : 'connect_string', + 'userName': 'name', + 'password': 'pass' + }, + '&pl': { + 'ch@r@cter.k^y': 'v@lue' + }, + 'system': { + 'debug' : 'no_change' + }, + 'user.profile': { + 'name.first' : 'fname' + }, + 'constructor.name': 'myconstructorname', + 'constructor': { + 'name': 'myconstructorname', + 'valueOf': 'myconstructorvalue' + }, + 'systemsettings': { + 'appurl': 'https://helloworld.visualstudio.com' + } +} +// Method to be checked for JSON variable substitution +jsonSubUtil.substituteJsonVariable(jsonObject, envVarObject); + +if(typeof jsonObject['user.profile'] === 'object') { + console.log('JSON - eliminating object variables validated'); +} +if(jsonObject['data']['ConnectionString'] === 'database_connection' + && jsonObject['data']['userName'] === 'db_admin' + && jsonObject['systemsettings']['appurl'] == 'https://dev.azure.com/helloworld') { + console.log('JSON - simple string change validated'); +} +if(jsonObject['system']['debug'] === 'no_change') { + console.log('JSON - system variable elimination validated'); +} +if(jsonObject['&pl']['ch@r@cter.k^y'] === '*.config') { + console.log('JSON - special variables validated'); +} +if(jsonObject['user.profile']['name.first'] === 'firstName') { + console.log('JSON - variables with dot character validated'); +} +if(jsonObject['User.Profile'] === 'do_not_replace') { + console.log('JSON - case sensitive variables validated'); +} +if(jsonObject['constructor.name'] === 'newConstructorName' && + jsonObject['constructor']['name'] === 'newConstructorName' && jsonObject['constructor']['valueOf'] === 'constructorNewValue') { + console.log('JSON - substitute inbuilt JSON attributes validated'); +} + +validate(); \ No newline at end of file diff --git a/common-npm-packages/webdeployment-common-v2/Tests/L1JsonVarSubV2.ts b/common-npm-packages/webdeployment-common-v2/Tests/L1JsonVarSubV2.ts new file mode 100644 index 000000000000..33210f3e44f2 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/Tests/L1JsonVarSubV2.ts @@ -0,0 +1,100 @@ +import { validate } from './L1JSONVarSubWithComments'; +var jsonSubUtil = require('webdeployment-common-v2/jsonvariablesubstitutionutility.js'); + +var envVarObject = jsonSubUtil.createEnvTree([ + { name: 'system.debug', value: 'true', secret: false}, + { name: 'data.ConnectionString', value: 'database_connection', secret: false}, + { name: 'data.userName', value: 'db_admin', secret: false}, + { name: 'data.password', value: 'db_pass', secret: true}, + { name: '&pl.ch@r@cter.k^y', value: '*.config', secret: false}, + { name: 'build.sourceDirectory', value: 'DefaultWorkingDirectory', secret: false}, + { name: 'user.profile.name.first', value: 'firstName', secret: false}, + { name: 'user.profile', value: 'replace_all', secret: false}, + { name: 'constructor.name', value: 'newConstructorName', secret: false}, + { name: 'constructor.valueOf', value: 'constructorNewValue', secret: false}, + { name: 'profile.users', value: '["suaggar","rok","asranja", "chaitanya"]', secret: false}, + { name: 'profile.enabled', value: 'false', secret: false}, + { name: 'profile.version', value: '1173', secret: false}, + { name: 'profile.somefloat', value: '97.75', secret: false}, + { name: 'profile.preimum_level', value: '{"suaggar": "V4", "rok": "V5", "asranja": { "type" : "V6"}}', secret: false}, + { name: 'systemsettings.appurl', value: 'https://dev.azure.com/helloworld', secret: false} +]); + +var jsonObject = { + 'User.Profile': 'do_not_replace', + 'data': { + 'ConnectionString' : 'connect_string', + 'userName': 'name', + 'password': 'pass' + }, + '&pl': { + 'ch@r@cter.k^y': 'v@lue' + }, + 'system': { + 'debug' : 'no_change' + }, + 'user.profile': { + 'name.first' : 'fname' + }, + 'constructor.name': 'myconstructorname', + 'constructor': { + 'name': 'myconstructorname', + 'valueOf': 'myconstructorvalue' + }, + 'profile': { + 'users': ['arjgupta', 'raagra', 'muthuk'], + 'preimum_level': { + 'arjgupta': 'V1', + 'raagra': 'V2', + 'muthuk': { + 'type': 'V3' + } + }, + "enabled": true, + "version": 2, + "somefloat": 2.3456 + }, + 'systemsettings': { + 'appurl': 'https://helloworld.visualstudio.com' + } + +} +// Method to be checked for JSON variable substitution +jsonSubUtil.substituteJsonVariableV2(jsonObject, envVarObject); + +if(jsonObject['data']['ConnectionString'] === 'database_connection' + && jsonObject['data']['userName'] === 'db_admin' + && jsonObject['systemsettings']['appurl'] == 'https://dev.azure.com/helloworld') { + console.log('JSON - simple string change validated'); +} +if(jsonObject['system']['debug'] === 'no_change') { + console.log('JSON - system variable elimination validated'); +} +if(jsonObject['&pl']['ch@r@cter.k^y'] === '*.config') { + console.log('JSON - special variables validated'); +} +if(jsonObject['User.Profile'] === 'do_not_replace') { + console.log('JSON - case sensitive variables validated'); +} +if(jsonObject['constructor.name'] === 'newConstructorName' && + jsonObject['constructor']['name'] === 'newConstructorName' && jsonObject['constructor']['valueOf'] === 'constructorNewValue') { + console.log('JSON - substitute inbuilt JSON attributes validated'); +} +let newArray = ["suaggar", "rok", "asranja", "chaitanya"]; +if (jsonObject['profile']['users'].length == 4 && (jsonObject['profile']['users']).every((value, index) => {return value == newArray[index]}) ) { + console.log('JSON - Array Object validated'); +} +if(jsonObject['profile']['enabled'] == false) { + console.log('JSON - Boolean validated'); +} +if(jsonObject['profile']['somefloat'] == 97.75) { + console.log('JSON - Number(float) validated'); +} +if(jsonObject['profile']['version'] == 1173) { + console.log('JSON - Number(int) validated'); +} +if(JSON.stringify(jsonObject['profile']['preimum_level']) == JSON.stringify({"suaggar": "V4", "rok": "V5", "asranja": { "type" : "V6"}})) { + console.log('JSON - Object validated'); +} + +validate(); \ No newline at end of file diff --git a/common-npm-packages/webdeployment-common-v2/Tests/L1ValidateFileEncoding.ts b/common-npm-packages/webdeployment-common-v2/Tests/L1ValidateFileEncoding.ts new file mode 100644 index 000000000000..e49ce87d5d3a --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/Tests/L1ValidateFileEncoding.ts @@ -0,0 +1,77 @@ +var fileEncoding = require('../fileencoding.js'); + +var fileEncodeType = fileEncoding.detectFileEncoding('utf-8.txt', new Buffer([239, 187, 191, 0])); +if(fileEncodeType[0] === 'utf-8' && fileEncodeType[1]) { + console.log('UTF-8 with BOM validated'); +} + +try { + var fileEncodeType = fileEncoding.detectFileEncoding('utf-32le.txt', new Buffer([255, 254, 0, 0])); +} +catch(exception) { + console.log('UTF-32LE with BOM validated'); +} + +try { + var fileEncodeType = fileEncoding.detectFileEncoding('utf-16be.txt', new Buffer([254, 255, 0 ,0])); +} +catch(exception) { + console.log('UTF-16BE with BOM validated'); +} + +var fileEncodeType = fileEncoding.detectFileEncoding('utf-16le.txt', new Buffer([255, 254, 10, 10])); +if(fileEncodeType[0] === 'utf-16le' && fileEncodeType[1]) { + console.log('UTF-16LE with BOM validated'); +} + +try { + var fileEncodeType = fileEncoding.detectFileEncoding('utf-32BE.txt', new Buffer([0, 0, 254, 255])); +} +catch(exception) { + console.log('UTF-32BE with BOM validated'); +} + +var fileEncodeType = fileEncoding.detectFileEncoding('utf-8.txt', new Buffer([10, 11, 12, 13])); +if(fileEncodeType[0] === 'utf-8' && !fileEncodeType[1]) { + console.log('UTF-8 without BOM validated'); +} + +try { + var fileEncodeType = fileEncoding.detectFileEncoding('utf-32le.txt', new Buffer([255, 0, 0, 0])); +} +catch(exception) { + console.log('UTF-32LE without BOM validated'); +} + +try { + var fileEncodeType = fileEncoding.detectFileEncoding('utf-32be.txt', new Buffer([0, 0, 0, 255])); +} +catch(exception) { + console.log('UTF-32BE without BOM validated'); +} + +try { + var fileEncodeType = fileEncoding.detectFileEncoding('utf-16be.txt', new Buffer([0, 10, 0 ,20])); +} +catch(exception) { + console.log('UTF-16BE without BOM validated'); +} + +var fileEncodeType = fileEncoding.detectFileEncoding('utf-16le.txt', new Buffer([20, 0, 10, 0])); +if(fileEncodeType[0] === 'utf-16le' && !fileEncodeType[1]) { + console.log('UTF-16LE without BOM validated'); +} + +try { + fileEncoding.detectFileEncoding('utfShort.txt', new Buffer([20, 0])); +} +catch(exception) { + console.log('Short File Buffer Error'); +} + +try { + fileEncoding.detectFileEncoding('utfUnknown.txt', new Buffer([0, 10, 20, 30])); +} +catch(exception) { + console.log('Unknown encoding type') +} \ No newline at end of file diff --git a/common-npm-packages/webdeployment-common-v2/Tests/L1XdtTransform.ts b/common-npm-packages/webdeployment-common-v2/Tests/L1XdtTransform.ts new file mode 100644 index 000000000000..b688411ee387 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/Tests/L1XdtTransform.ts @@ -0,0 +1,6 @@ +var path = require('path'); +var ltx = require('ltx'); +var xdtTransform = require('webdeployment-common-v2/xdttransformationutility.js'); +process.env["SYSTEM_DEFAULTWORKINGDIRECTORY"] = path.join(__dirname, 'L1XdtTransform'); +xdtTransform.applyXdtTransformation(path.join(__dirname, 'L1XdtTransform', 'Web_test.config'), path.join(__dirname, 'L1XdtTransform', 'Web.Debug.config')); +process.env['SYSTEM_DEFAULTWORKINGDIRECTORY'] = 'DefaultWorkingDirectory'; \ No newline at end of file diff --git a/common-npm-packages/webdeployment-common-v2/Tests/L1XdtTransform/Web.Debug.config b/common-npm-packages/webdeployment-common-v2/Tests/L1XdtTransform/Web.Debug.config new file mode 100644 index 000000000000..e74baa294cb0 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/Tests/L1XdtTransform/Web.Debug.config @@ -0,0 +1,19 @@ + + + + + + + + + + + + + + + + diff --git a/common-npm-packages/webdeployment-common-v2/Tests/L1XdtTransform/Web.config b/common-npm-packages/webdeployment-common-v2/Tests/L1XdtTransform/Web.config new file mode 100644 index 000000000000..26f610d10ad8 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/Tests/L1XdtTransform/Web.config @@ -0,0 +1,97 @@ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/common-npm-packages/webdeployment-common-v2/Tests/L1XdtTransform/Web_Expected.config b/common-npm-packages/webdeployment-common-v2/Tests/L1XdtTransform/Web_Expected.config new file mode 100644 index 000000000000..1a25834f172e --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/Tests/L1XdtTransform/Web_Expected.config @@ -0,0 +1,98 @@ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/common-npm-packages/webdeployment-common-v2/Tests/L1XmlVarSub.ts b/common-npm-packages/webdeployment-common-v2/Tests/L1XmlVarSub.ts new file mode 100644 index 000000000000..7a1ff9d17a4c --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/Tests/L1XmlVarSub.ts @@ -0,0 +1,29 @@ +var xmlSubstitutionUtility = require('webdeployment-common-v2/xmlvariablesubstitutionutility.js'); +var path = require('path'); + +async function xmlVarSub() { + var tags = ["applicationSettings", "appSettings", "connectionStrings", "configSections"]; + var configFiles = [path.join(__dirname, 'L1XmlVarSub/Web_test.config'), path.join(__dirname, 'L1XmlVarSub/Web_test.Debug.config')]; + var variableMap = { + 'conntype' : 'new_connType', + "MyDB": "TestDB", + 'webpages:Version' : '1.1.7.3', + 'xdt:Transform' : 'DelAttributes', + 'xdt:Locator' : 'Match(tag)', + 'DefaultConnection': "Url=https://primary;Database=db1;ApiKey=11111111-1111-1111-1111-111111111111;Failover = {Url:'https://secondary', ApiKey:'11111111-1111-1111-1111-111111111111'}", + 'OtherDefaultConnection': 'connectionStringValue2', + 'ParameterConnection': 'New_Connection_String From xml var subs', + 'connectionString': 'replaced_value', + 'invariantName': 'System.Data.SqlServer', + 'blatvar': 'ApplicationSettingReplacedValue', + 'log_level': 'error,warning', + 'Email:ToOverride': '' + } + + var parameterFilePath = path.join(__dirname, 'L1XmlVarSub/parameters_test.xml'); + for(var configFile of configFiles) { + await xmlSubstitutionUtility.substituteXmlVariables(configFile, tags, variableMap, parameterFilePath); + } +} + +xmlVarSub(); \ No newline at end of file diff --git a/common-npm-packages/webdeployment-common-v2/Tests/L1XmlVarSub/Web.Debug.config b/common-npm-packages/webdeployment-common-v2/Tests/L1XmlVarSub/Web.Debug.config new file mode 100644 index 000000000000..9261bf7f818f --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/Tests/L1XmlVarSub/Web.Debug.config @@ -0,0 +1,6 @@ + + + + + + diff --git a/common-npm-packages/webdeployment-common-v2/Tests/L1XmlVarSub/Web.Release.config b/common-npm-packages/webdeployment-common-v2/Tests/L1XmlVarSub/Web.Release.config new file mode 100644 index 000000000000..2331f0ba75c5 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/Tests/L1XmlVarSub/Web.Release.config @@ -0,0 +1,31 @@ + + + + + + + + + + + + + + + diff --git a/common-npm-packages/webdeployment-common-v2/Tests/L1XmlVarSub/Web.config b/common-npm-packages/webdeployment-common-v2/Tests/L1XmlVarSub/Web.config new file mode 100644 index 000000000000..a4ce83ce3a85 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/Tests/L1XmlVarSub/Web.config @@ -0,0 +1,125 @@ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + blart + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/common-npm-packages/webdeployment-common-v2/Tests/L1XmlVarSub/Web_Expected.Debug.config b/common-npm-packages/webdeployment-common-v2/Tests/L1XmlVarSub/Web_Expected.Debug.config new file mode 100644 index 000000000000..90cd7e7e4cce --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/Tests/L1XmlVarSub/Web_Expected.Debug.config @@ -0,0 +1,6 @@ + + + + + + diff --git a/common-npm-packages/webdeployment-common-v2/Tests/L1XmlVarSub/Web_Expected.config b/common-npm-packages/webdeployment-common-v2/Tests/L1XmlVarSub/Web_Expected.config new file mode 100644 index 000000000000..7b84799fb4ab --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/Tests/L1XmlVarSub/Web_Expected.config @@ -0,0 +1,125 @@ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + ApplicationSettingReplacedValue + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/common-npm-packages/webdeployment-common-v2/Tests/L1XmlVarSub/parameters.xml b/common-npm-packages/webdeployment-common-v2/Tests/L1XmlVarSub/parameters.xml new file mode 100644 index 000000000000..3c8af63af496 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/Tests/L1XmlVarSub/parameters.xml @@ -0,0 +1,7 @@ + + + + + + + \ No newline at end of file diff --git a/common-npm-packages/webdeployment-common-v2/Tests/L1XmlVarSub/parameters_Expected.xml b/common-npm-packages/webdeployment-common-v2/Tests/L1XmlVarSub/parameters_Expected.xml new file mode 100644 index 000000000000..20cf43b38f15 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/Tests/L1XmlVarSub/parameters_Expected.xml @@ -0,0 +1,7 @@ + + + + + + + \ No newline at end of file diff --git a/common-npm-packages/webdeployment-common-v2/WebConfigTemplates/go b/common-npm-packages/webdeployment-common-v2/WebConfigTemplates/go new file mode 100644 index 000000000000..9aaaf22b5302 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/WebConfigTemplates/go @@ -0,0 +1,13 @@ + + + + + + + + + + + diff --git a/common-npm-packages/webdeployment-common-v2/WebConfigTemplates/java_springboot b/common-npm-packages/webdeployment-common-v2/WebConfigTemplates/java_springboot new file mode 100644 index 000000000000..676d615f4418 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/WebConfigTemplates/java_springboot @@ -0,0 +1,14 @@ + + + + + + + + + + + \ No newline at end of file diff --git a/common-npm-packages/webdeployment-common-v2/WebConfigTemplates/node b/common-npm-packages/webdeployment-common-v2/WebConfigTemplates/node new file mode 100644 index 000000000000..9c56cb4d33f4 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/WebConfigTemplates/node @@ -0,0 +1,61 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/common-npm-packages/webdeployment-common-v2/WebConfigTemplates/python_bottle b/common-npm-packages/webdeployment-common-v2/WebConfigTemplates/python_bottle new file mode 100644 index 000000000000..5e4f861ed31c --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/WebConfigTemplates/python_bottle @@ -0,0 +1,32 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/common-npm-packages/webdeployment-common-v2/WebConfigTemplates/python_django b/common-npm-packages/webdeployment-common-v2/WebConfigTemplates/python_django new file mode 100644 index 000000000000..1248213206b5 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/WebConfigTemplates/python_django @@ -0,0 +1,33 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/common-npm-packages/webdeployment-common-v2/WebConfigTemplates/python_flask b/common-npm-packages/webdeployment-common-v2/WebConfigTemplates/python_flask new file mode 100644 index 000000000000..6c4adcf054dc --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/WebConfigTemplates/python_flask @@ -0,0 +1,32 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/common-npm-packages/webdeployment-common-v2/deployusingmsdeploy.ts b/common-npm-packages/webdeployment-common-v2/deployusingmsdeploy.ts new file mode 100644 index 000000000000..708bc26c93f3 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/deployusingmsdeploy.ts @@ -0,0 +1,185 @@ +import tl = require('azure-pipelines-task-lib/task'); +import fs = require('fs'); +import path = require('path'); +import Q = require('q'); +import { WebDeployArguments, WebDeployResult } from './msdeployutility'; + +var msDeployUtility = require('./msdeployutility.js'); +var utility = require('./utility.js'); + +const DEFAULT_RETRY_COUNT = 3; + +/** + * Executes Web Deploy command + * + * @param webDeployPkg Web deploy package + * @param webAppName web App Name + * @param publishingProfile Azure RM Connection Details + * @param removeAdditionalFilesFlag Flag to set DoNotDeleteRule rule + * @param excludeFilesFromAppDataFlag Flag to prevent App Data from publishing + * @param takeAppOfflineFlag Flag to enable AppOffline rule + * @param virtualApplication Virtual Application Name + * @param setParametersFile Set Parameter File path + * @param additionalArguments Arguments provided by user + * + */ +export async function DeployUsingMSDeploy(webDeployPkg, webAppName, publishingProfile, removeAdditionalFilesFlag, + excludeFilesFromAppDataFlag, takeAppOfflineFlag, virtualApplication, setParametersFile, additionalArguments, isFolderBasedDeployment, useWebDeploy) { + + var msDeployPath = await msDeployUtility.getMSDeployFullPath(); + var msDeployDirectory = msDeployPath.slice(0, msDeployPath.lastIndexOf('\\') + 1); + var pathVar = process.env.PATH; + process.env.PATH = msDeployDirectory + ";" + process.env.PATH ; + + setParametersFile = utility.copySetParamFileIfItExists(setParametersFile); + var setParametersFileName = null; + + if(setParametersFile != null) { + setParametersFileName = setParametersFile.slice(setParametersFile.lastIndexOf('\\') + 1, setParametersFile.length); + } + var isParamFilePresentInPackage = isFolderBasedDeployment ? false : await utility.isMSDeployPackage(webDeployPkg); + + var msDeployCmdArgs = msDeployUtility.getMSDeployCmdArgs(webDeployPkg, webAppName, publishingProfile, removeAdditionalFilesFlag, + excludeFilesFromAppDataFlag, takeAppOfflineFlag, virtualApplication, setParametersFileName, additionalArguments, isParamFilePresentInPackage, isFolderBasedDeployment, + useWebDeploy); + + var retryCountParam = tl.getVariable("appservice.msdeployretrycount"); + var retryCount = (retryCountParam && !(isNaN(Number(retryCountParam)))) ? Number(retryCountParam): DEFAULT_RETRY_COUNT; + + try { + while(true) { + try { + retryCount -= 1; + await executeMSDeploy(msDeployCmdArgs); + break; + } + catch (error) { + if(retryCount == 0) { + throw error; + } + console.log(error); + console.log(tl.loc('RetryToDeploy')); + } + } + if(publishingProfile != null) { + console.log(tl.loc('PackageDeploymentSuccess')); + } + } + catch (error) { + tl.error(tl.loc('PackageDeploymentFailed')); + tl.debug(JSON.stringify(error)); + msDeployUtility.redirectMSDeployErrorToConsole(); + throw Error(error.message); + } + finally { + process.env.PATH = pathVar; + if(setParametersFile != null) { + tl.rmRF(setParametersFile); + } + } +} + + +export async function executeWebDeploy(WebDeployArguments: WebDeployArguments, publishingProfile: any): Promise { + var webDeployArguments = await msDeployUtility.getWebDeployArgumentsString(WebDeployArguments, publishingProfile); + try { + var msDeployPath = await msDeployUtility.getMSDeployFullPath(); + var msDeployDirectory = msDeployPath.slice(0, msDeployPath.lastIndexOf('\\') + 1); + var pathVar = process.env.PATH; + process.env.PATH = msDeployDirectory + ";" + process.env.PATH ; + await executeMSDeploy(webDeployArguments); + } + catch(exception) { + var msDeployErrorFilePath = tl.getVariable('System.DefaultWorkingDirectory') + '\\' + 'error.txt'; + var errorFileContent = tl.exist(msDeployErrorFilePath) ? fs.readFileSync(msDeployErrorFilePath, 'utf-8') : ""; + return { + isSuccess: false, + error: errorFileContent, + errorCode: msDeployUtility.getWebDeployErrorCode(errorFileContent) + } as WebDeployResult; + } + + return { isSuccess: true } as WebDeployResult; +} + +function argStringToArray(argString): string[] { + var args = []; + var inQuotes = false; + var escaped = false; + var arg = ''; + var append = function (c) { + // we only escape double quotes. + if (escaped && c !== '"') { + arg += '\\'; + } + arg += c; + escaped = false; + }; + for (var i = 0; i < argString.length; i++) { + var c = argString.charAt(i); + if (c === '"') { + if (!escaped) { + inQuotes = !inQuotes; + } + else { + append(c); + } + continue; + } + if (c === "\\" && inQuotes) { + if(escaped) { + append(c); + } + else { + escaped = true; + } + + continue; + } + if (c === ' ' && !inQuotes) { + if (arg.length > 0) { + args.push(arg); + arg = ''; + } + continue; + } + append(c); + } + if (arg.length > 0) { + args.push(arg.trim()); + } + return args; +} + +async function executeMSDeploy(msDeployCmdArgs) { + var deferred = Q.defer(); + + var msDeployError = null; + var errorFile = path.join(tl.getVariable('System.DefaultWorkingDirectory'),"error.txt"); + var fd = fs.openSync(errorFile, "w"); + var errObj = fs.createWriteStream("", {fd: fd} ); + + errObj.on('finish', async () => { + if(msDeployError) { + deferred.reject(msDeployError); + } + }); + + try { + tl.debug("the argument string is:"); + tl.debug(msDeployCmdArgs); + tl.debug("converting the argument string into an array of arguments"); + msDeployCmdArgs = argStringToArray(msDeployCmdArgs); + tl.debug("the array of arguments is:"); + for(var i = 0 ; i < msDeployCmdArgs.length ; i++ ) { + tl.debug("arg#" + i + ": " + msDeployCmdArgs[i]); + } + await tl.exec("msdeploy", msDeployCmdArgs, {failOnStdErr: true, errStream: errObj, windowsVerbatimArguments: true}); + deferred.resolve("Azure App service successfully deployed"); + } catch (error) { + msDeployError = error; + } finally { + errObj.end(); + } + return deferred.promise; +} diff --git a/common-npm-packages/webdeployment-common-v2/fileTransformationsUtility.ts b/common-npm-packages/webdeployment-common-v2/fileTransformationsUtility.ts new file mode 100644 index 000000000000..984b49f69593 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/fileTransformationsUtility.ts @@ -0,0 +1,171 @@ +import tl = require('azure-pipelines-task-lib/task'); +import * as ParameterParser from './ParameterParserUtility'; + +var jsonSubstitutionUtility = require('webdeployment-common-v2/jsonvariablesubstitutionutility.js'); +var xmlSubstitutionUtility = require('webdeployment-common-v2/xmlvariablesubstitutionutility.js'); +var xdtTransformationUtility = require('webdeployment-common-v2/xdttransformationutility.js'); + +export function fileTransformations(isFolderBasedDeployment: boolean, JSONFiles: any, xmlTransformation: boolean, xmlVariableSubstitution: boolean, folderPath: string, isMSBuildPackage: boolean) { + + if(xmlTransformation) { + if(isMSBuildPackage) { + var debugMode = tl.getVariable('system.debug'); + if(debugMode && debugMode.toLowerCase() == 'true') { + tl.warning(tl.loc('AutoParameterizationMessage')); + } + else { + console.log(tl.loc('AutoParameterizationMessage')); + } + } + var environmentName = tl.getVariable('Release.EnvironmentName'); + if(tl.osType().match(/^Win/)) { + var transformConfigs = ["Release.config"]; + if(environmentName && environmentName.toLowerCase() != 'release') { + transformConfigs.push(environmentName + ".config"); + } + var isTransformationApplied: boolean = xdtTransformationUtility.basicXdtTransformation(folderPath, transformConfigs); + + if(isTransformationApplied) + { + console.log(tl.loc("XDTTransformationsappliedsuccessfully")); + } + + } + else { + throw new Error(tl.loc("CannotPerformXdtTransformationOnNonWindowsPlatform")); + } + } + + if(xmlVariableSubstitution) { + xmlSubstitutionUtility.substituteAppSettingsVariables(folderPath, isFolderBasedDeployment); + console.log(tl.loc('XMLvariablesubstitutionappliedsuccessfully')); + } + + if(JSONFiles.length != 0) { + jsonSubstitutionUtility.jsonVariableSubstitution(folderPath, JSONFiles); + console.log(tl.loc('JSONvariablesubstitutionappliedsuccessfully')); + } +} + +export function advancedFileTransformations(isFolderBasedDeployment: boolean, targetFiles: any, xmlTransformation: boolean, variableSubstitutionFileFormat: string, folderPath: string, transformationRules: any) { + + if(xmlTransformation) { + if(!tl.osType().match(/^Win/)) { + throw Error(tl.loc("CannotPerformXdtTransformationOnNonWindowsPlatform")); + } + else { + let isTransformationApplied: boolean = true; + if(transformationRules.length > 0) { + transformationRules.forEach(function(rule) { + var args = ParameterParser.parse(rule); + if(Object.keys(args).length < 2 || !args["transform"] || !args["xml"]) { + tl.error(tl.loc("MissingArgumentsforXMLTransformation")); + } + else if(Object.keys(args).length > 2) { + isTransformationApplied = xdtTransformationUtility.specialXdtTransformation(folderPath, args["transform"].value, args["xml"].value, args["result"].value) && isTransformationApplied; + } + else { + isTransformationApplied = xdtTransformationUtility.specialXdtTransformation(folderPath, args["transform"].value, args["xml"].value) && isTransformationApplied; + } + }); + } + else{ + var environmentName = tl.getVariable('Release.EnvironmentName'); + let transformConfigs = ["Release.config"]; + if(environmentName && environmentName.toLowerCase() != 'release') { + transformConfigs.push(environmentName + ".config"); + } + isTransformationApplied = xdtTransformationUtility.basicXdtTransformation(folderPath, transformConfigs); + } + + if(isTransformationApplied) { + console.log(tl.loc("XDTTransformationsappliedsuccessfully")); + } + else { + tl.warning(tl.loc('FailedToApplySpecialTransformation')); + } + } + } + + if(variableSubstitutionFileFormat === "xml") { + if(targetFiles.length == 0) { + xmlSubstitutionUtility.substituteAppSettingsVariables(folderPath, isFolderBasedDeployment); + } + else { + targetFiles.forEach(function(fileName) { + xmlSubstitutionUtility.substituteAppSettingsVariables(folderPath, isFolderBasedDeployment, fileName); + }); + } + + console.log(tl.loc('XMLvariablesubstitutionappliedsuccessfully')); + + } + + if(variableSubstitutionFileFormat === "json") { + // For Json variable substitution if no target files are specified file files matching **\*.json + if(!targetFiles || targetFiles.length == 0) { + targetFiles = ["**/*.json"]; + } + jsonSubstitutionUtility.jsonVariableSubstitution(folderPath, targetFiles, true); + console.log(tl.loc('JSONvariablesubstitutionappliedsuccessfully')); + } +} + +export function enhancedFileTransformations(isFolderBasedDeployment: boolean, xmlTransformation: boolean, folderPath: string, transformationRules: any, xmlTargetFiles: any, jsonTargetFiles: any) { + + if(xmlTransformation) { + if(!tl.osType().match(/^Win/)) { + throw Error(tl.loc("CannotPerformXdtTransformationOnNonWindowsPlatform")); + } + else { + let isTransformationApplied: boolean = true; + if(transformationRules.length > 0) { + transformationRules.forEach(function(rule) { + var args = ParameterParser.parse(rule); + if(Object.keys(args).length < 2 || !args["transform"] || !args["xml"]) { + tl.error(tl.loc("MissingArgumentsforXMLTransformation")); + } + else if(Object.keys(args).length > 2) { + isTransformationApplied = xdtTransformationUtility.specialXdtTransformation(folderPath, args["transform"].value, args["xml"].value, args["result"].value) && isTransformationApplied; + } + else { + isTransformationApplied = xdtTransformationUtility.specialXdtTransformation(folderPath, args["transform"].value, args["xml"].value) && isTransformationApplied; + } + }); + } + if(isTransformationApplied) { + console.log(tl.loc("XDTTransformationsappliedsuccessfully")); + } + else { + tl.error(tl.loc('FailedToApplySpecialTransformationReason1')); + } + } + } + + let isSubstitutionApplied: boolean = true; + if(xmlTargetFiles.length > 0) + { + xmlTargetFiles.forEach(function(fileName) { + isSubstitutionApplied = xmlSubstitutionUtility.substituteAppSettingsVariables(folderPath, isFolderBasedDeployment, fileName) || isSubstitutionApplied; + }); + + if(isSubstitutionApplied) { + console.log(tl.loc('XMLvariablesubstitutionappliedsuccessfully')); + } + else { + tl.error(tl.loc('FailedToApplyXMLvariablesubstitutionReason1')); + } + } + + isSubstitutionApplied = true; + if(jsonTargetFiles.length > 0) + { + isSubstitutionApplied = jsonSubstitutionUtility.jsonVariableSubstitution(folderPath, jsonTargetFiles, true); + if(isSubstitutionApplied) { + console.log(tl.loc('JSONvariablesubstitutionappliedsuccessfully')); + } + else { + tl.error(tl.loc('FailedToApplyJSONvariablesubstitutionReason1')); + } + } +} \ No newline at end of file diff --git a/common-npm-packages/webdeployment-common-v2/fileencoding.ts b/common-npm-packages/webdeployment-common-v2/fileencoding.ts new file mode 100644 index 000000000000..cfdcbcf34fbe --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/fileencoding.ts @@ -0,0 +1,58 @@ +//File Encoding detected to be : utf-32be, which is not supported by Node.js +//'Unable to detect encoding of file ' + typeCode +//'File buffer is too short to detect encoding type' +var fs = require('fs'); +import tl = require('azure-pipelines-task-lib'); + +function detectFileEncodingWithBOM(fileName: string, buffer: Buffer) { + tl.debug('Detecting file encoding using BOM'); + if(buffer.slice(0,3).equals(new Buffer([239, 187, 191]))) { + return ['utf-8', true]; + } + else if(buffer.slice(0,4).equals(new Buffer([255, 254, 0, 0]))) { + throw Error(tl.loc('EncodeNotSupported', fileName, 'UTF-32LE', 'UTF-32LE')); + } + else if(buffer.slice(0,2).equals(new Buffer([254, 255]))) { + throw Error(tl.loc('EncodeNotSupported', fileName, 'UTF-16BE', 'UTF-16BE')); + } + else if(buffer.slice(0,2).equals(new Buffer([255, 254]))) { + return ['utf-16le', true]; + } + else if(buffer.slice(0,4).equals(new Buffer([0, 0, 254, 255]))) { + throw Error(tl.loc('EncodeNotSupported', fileName, 'UTF-32BE', 'UTF-32BE')); + } + tl.debug('Unable to detect File encoding using BOM'); + return null; +} + +function detectFileEncodingWithoutBOM(fileName: string, buffer: Buffer) { + tl.debug('Detecting file encoding without BOM'); + + var typeCode = 0; + for(var index = 0; index < 4; index++) { + typeCode = typeCode << 1; + typeCode = typeCode | (buffer[index] > 0 ? 1 : 0); + } + switch(typeCode) { + case 1: + throw Error(tl.loc('EncodeNotSupported', fileName, 'UTF-32BE', 'UTF-32BE')); + case 5: + throw Error(tl.loc('EncodeNotSupported', fileName, 'UTF-16BE', 'UTF-16BE')); + case 8: + throw Error(tl.loc('EncodeNotSupported', fileName, 'UTF-32LE', 'UTF-32LE')); + case 10: + return ['utf-16le', false]; + case 15: + return ['utf-8', false]; + default: + throw Error(tl.loc('UnknownFileEncodeError', fileName, typeCode)); + } +} +export function detectFileEncoding(fileName: string, buffer: Buffer) { + if(buffer.length < 4) { + throw Error(tl.loc('ShortFileBufferError', fileName)); + } + var fileEncoding = detectFileEncodingWithBOM(fileName, buffer) || detectFileEncodingWithoutBOM(fileName, buffer); + return fileEncoding; +} + diff --git a/common-npm-packages/webdeployment-common-v2/jsonvariablesubstitutionutility.ts b/common-npm-packages/webdeployment-common-v2/jsonvariablesubstitutionutility.ts new file mode 100644 index 000000000000..6961fb5548e9 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/jsonvariablesubstitutionutility.ts @@ -0,0 +1,214 @@ +import tl = require('azure-pipelines-task-lib/task'); +import path = require('path'); +import fs = require('fs'); +import { isNumber, isBoolean } from 'util'; + +var varUtility = require ('./variableutility.js'); +var fileEncoding = require('./fileencoding.js'); +var utility = require('./utility.js'); +export function createEnvTree(envVariables) { + // __proto__ is marked as null, so that custom object can be assgined. + // This replacement do not affect the JSON object, as no inbuilt JSON function is referenced. + var envVarTree = { + value: null, + isEnd: false, + child: { + '__proto__': null + } + }; + for(let envVariable of envVariables) { + var envVarTreeIterator = envVarTree; + if(varUtility.isPredefinedVariable(envVariable.name)) { + continue; + } + var envVariableNameArray = (envVariable.name).split('.'); + + for(let variableName of envVariableNameArray) { + if(envVarTreeIterator.child[variableName] === undefined || typeof envVarTreeIterator.child[variableName] === 'function') { + envVarTreeIterator.child[variableName] = { + value: null, + isEnd: false, + child: {} + }; + } + envVarTreeIterator = envVarTreeIterator.child[variableName]; + } + envVarTreeIterator.isEnd = true; + envVarTreeIterator.value = envVariable.value; + } + return envVarTree; +} + +function checkEnvTreePath(jsonObjectKey, index, jsonObjectKeyLength, envVarTree) { + if(index == jsonObjectKeyLength) { + return envVarTree; + } + if(envVarTree.child[ jsonObjectKey[index] ] === undefined || typeof envVarTree.child[ jsonObjectKey[index] ] === 'function') { + return undefined; + } + return checkEnvTreePath(jsonObjectKey, index + 1, jsonObjectKeyLength, envVarTree.child[ jsonObjectKey[index] ]); +} + +export function substituteJsonVariable(jsonObject, envObject) { + let isValueChanged: boolean = false; + for(var jsonChild in jsonObject) { + var jsonChildArray = jsonChild.split('.'); + var resultNode = checkEnvTreePath(jsonChildArray, 0, jsonChildArray.length, envObject); + if(resultNode != undefined) { + if(resultNode.isEnd && (jsonObject[jsonChild] == null || typeof jsonObject[jsonChild] !== "object")) { + console.log(tl.loc('SubstitutingValueonKey', jsonChild)); + jsonObject[jsonChild] = resultNode.value; + isValueChanged = true; + } + else { + isValueChanged = substituteJsonVariable(jsonObject[jsonChild], resultNode) || isValueChanged; + } + } + } + return isValueChanged; +} + +export function substituteJsonVariableV2(jsonObject, envObject) { + let isValueChanged: boolean = false; + for(var jsonChild in jsonObject) { + var jsonChildArray = jsonChild.split('.'); + var resultNode = checkEnvTreePath(jsonChildArray, 0, jsonChildArray.length, envObject); + if(resultNode != undefined) { + if(resultNode.isEnd) { + switch(typeof(jsonObject[jsonChild])) { + case 'number': + console.log(tl.loc('SubstitutingValueonKeyWithNumber', jsonChild , resultNode.value)); + jsonObject[jsonChild] = !isNaN(resultNode.value) ? Number(resultNode.value): resultNode.value; + break; + case 'boolean': + console.log(tl.loc('SubstitutingValueonKeyWithBoolean' , jsonChild , resultNode.value)); + jsonObject[jsonChild] = ( + resultNode.value == 'true' ? true : (resultNode.value == 'false' ? false : resultNode.value) + ) + break; + case 'object': + case null: + try { + console.log(tl.loc('SubstitutingValueonKeyWithObject' , jsonChild , resultNode.value)); + jsonObject[jsonChild] = JSON.parse(resultNode.value); + } + catch(exception) { + tl.debug('unable to substitute the value. falling back to string value'); + jsonObject[jsonChild] = resultNode.value; + } + break; + case 'string': + console.log(tl.loc('SubstitutingValueonKeyWithString' , jsonChild , resultNode.value)); + jsonObject[jsonChild] = resultNode.value; + } + isValueChanged = true; + } + else { + isValueChanged = substituteJsonVariableV2(jsonObject[jsonChild], resultNode) || isValueChanged; + } + } + } + return isValueChanged; +} + +export function stripJsonComments(content) { + if (!content || (content.indexOf("//") < 0 && content.indexOf("/*") < 0)) { + return content; + } + + var currentChar; + var nextChar; + var insideQuotes = false; + var contentWithoutComments = ''; + var insideComment = 0; + var singlelineComment = 1; + var multilineComment = 2; + + for (var i = 0; i < content.length; i++) { + currentChar = content[i]; + nextChar = i + 1 < content.length ? content[i + 1] : ""; + + if (insideComment) { + var update = false; + if (insideComment == singlelineComment && (currentChar + nextChar === '\r\n' || currentChar === '\n')) { + i--; + insideComment = 0; + continue; + } + + if (insideComment == multilineComment && currentChar + nextChar === '*/') { + i++; + insideComment = 0; + continue; + } + + } else { + if (insideQuotes && currentChar == "\\") { + contentWithoutComments += currentChar + nextChar; + i++; // Skipping checks for next char if escaped + continue; + } + else { + if (currentChar == '"') { + insideQuotes = !insideQuotes; + } + + if (!insideQuotes) { + if (currentChar + nextChar === '//') { + insideComment = singlelineComment; + i++; + } + + if (currentChar + nextChar === '/*') { + insideComment = multilineComment; + i++; + } + } + } + } + + if (!insideComment) { + contentWithoutComments += content[i]; + } + } + + return contentWithoutComments; +} + +export function jsonVariableSubstitution(absolutePath, jsonSubFiles, substituteAllTypes?: boolean) { + var envVarObject = createEnvTree(tl.getVariables()); + let isSubstitutionApplied: boolean = false; + for(let jsonSubFile of jsonSubFiles) { + console.log(tl.loc('JSONvariableSubstitution' , jsonSubFile)); + var matchFiles = utility.findfiles(path.join(absolutePath, jsonSubFile)); + if(matchFiles.length === 0) { + throw new Error(tl.loc('NOJSONfilematchedwithspecificpattern', jsonSubFile)); + } + for(let file of matchFiles) { + var fileBuffer: Buffer = fs.readFileSync(file); + var fileEncodeType = fileEncoding.detectFileEncoding(file, fileBuffer); + var fileContent: string = fileBuffer.toString(fileEncodeType[0]); + if(fileEncodeType[1]) { + fileContent = fileContent.slice(1); + } + try { + fileContent = stripJsonComments(fileContent); + var jsonObject = JSON.parse(fileContent); + } + catch(exception) { + throw Error(tl.loc('JSONParseError', file, exception)); + } + console.log(tl.loc('JSONvariableSubstitution' , file)); + if(substituteAllTypes) { + isSubstitutionApplied = substituteJsonVariableV2(jsonObject, envVarObject) || isSubstitutionApplied; + } + else { + isSubstitutionApplied = substituteJsonVariable(jsonObject, envVarObject) || isSubstitutionApplied; + } + + tl.writeFile(file, (fileEncodeType[1] ? '\uFEFF' : '') + JSON.stringify(jsonObject, null, 4), fileEncodeType[0]); + } + } + + return isSubstitutionApplied; +} \ No newline at end of file diff --git a/common-npm-packages/webdeployment-common-v2/ltxdomutility.ts b/common-npm-packages/webdeployment-common-v2/ltxdomutility.ts new file mode 100644 index 000000000000..ef4a9326c170 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/ltxdomutility.ts @@ -0,0 +1,97 @@ +var ltx = require("ltx"); +var varUtility = require("./variableutility.js"); +var Q = require('q'); + +export class LtxDomUtility { + + private xmlDomLookUpTable = {}; + private headerContent; + private xmlDom; + + public constructor(xmlContent) { + this.xmlDomLookUpTable = {}; + this.headerContent = null; + this.xmlDom = ltx.parse(xmlContent); + this.readHeader(xmlContent); + this.buildLookUpTable(this.xmlDom); + } + + public getXmlDom() { + return this.xmlDom; + } + + private readHeader(xmlContent) { + var index = xmlContent.indexOf('\n'); + if(index > -1) { + var firstLine = xmlContent.substring(0,index).trim(); + if(firstLine.startsWith("")) { + this.headerContent = firstLine; + } + } + } + + public getContentWithHeader(xmlDom) { + return xmlDom ? (this.headerContent ? this.headerContent + "\n" : "") + xmlDom.root().toString() : ""; + } + + /** + * Define method to create a lookup for DOM + */ + private buildLookUpTable(node) { + if(node){ + var nodeName = node.name; + if(nodeName){ + nodeName = nodeName.toLowerCase(); + var listOfNodes = this.xmlDomLookUpTable[nodeName]; + if(listOfNodes == null || !(Array.isArray(listOfNodes))) { + listOfNodes = []; + this.xmlDomLookUpTable[nodeName] = listOfNodes; + } + listOfNodes.push(node); + var childNodes = node.children; + for(var i=0 ; i < childNodes.length; i++){ + var childNodeName = childNodes[i].name; + if(childNodeName) { + this.buildLookUpTable(childNodes[i]); + } + } + } + } + } + + /** + * Returns array of nodes which match with the tag name. + */ + public getElementsByTagName(nodeName) { + if(varUtility.isEmpty(nodeName)) + return []; + var selectedElements = this.xmlDomLookUpTable[nodeName.toLowerCase()]; + if(!selectedElements){ + selectedElements = []; + } + return selectedElements; + } + + /** + * Search in subtree with provided node name + */ + public getChildElementsByTagName(node, tagName) { + if(!varUtility.isObject(node) ) + return []; + var children = node.children; + var liveNodes = []; + if(children){ + for( var i=0; i < children.length; i++ ){ + var childName = children[i].name; + if( !varUtility.isEmpty(childName) && tagName == childName){ + liveNodes.push(children[i]); + } + var liveChildNodes = this.getChildElementsByTagName(children[i], tagName); + if(liveChildNodes && liveChildNodes.length > 0){ + liveNodes = liveNodes.concat(liveChildNodes); + } + } + } + return liveNodes; + } +} diff --git a/common-npm-packages/webdeployment-common-v2/make.json b/common-npm-packages/webdeployment-common-v2/make.json new file mode 100644 index 000000000000..ea2c4442de58 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/make.json @@ -0,0 +1,21 @@ +{ + "cp": [ + { + "source": "WebConfigTemplates", + "options": "-R" + } + ], + "externals": { + "archivePackages": [ + { + "archiveName": "MSDeploy.zip", + "url": "https://vstsagenttools.blob.core.windows.net/tools/MSDeploy/3.6/M142/MSDeploy.zip", + "dest": "./" + }, + { + "url": "https://vstsagenttools.blob.core.windows.net/tools/7zip/1/7zip.zip", + "dest": "./" + } + ] + } +} \ No newline at end of file diff --git a/common-npm-packages/webdeployment-common-v2/module.json b/common-npm-packages/webdeployment-common-v2/module.json new file mode 100644 index 000000000000..2463e33ea546 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/module.json @@ -0,0 +1,34 @@ +{ + "messages":{ + "Updatemachinetoenablesecuretlsprotocol" : "Make sure the machine is using TLS 1.2 protocol or higher. Check https://aka.ms/enableTlsv2 for more information on how to enable TLS in your machine.", + "JarPathNotPresent" : "Java jar path is not present", + "JSONvariablesubstitutionappliedsuccessfully": "JSON variable substitution applied successfully.", + "XMLvariablesubstitutionappliedsuccessfully": "XML variable substitution applied successfully.", + "XDTTransformationsappliedsuccessfully": "XML Transformations applied successfully", + "CannotPerformXdtTransformationOnNonWindowsPlatform": "Cannot perform XML transformations on a non-Windows platform.", + "XdtTransformationErrorWhileTransforming": "XML transformation error while transforming %s using %s.", + "JSONParseError": "Unable to parse JSON file: %s. Error: %s", + "NOJSONfilematchedwithspecificpattern": "NO JSON file matched with specific pattern: %s.", + "FailedToApplyTransformation": "Unable to apply transformation for the given package. Verify the following.", + "FailedToApplySpecialTransformation": "Unable to apply transformation for the given package.", + "FailedToApplySpecialTransformationReason1": "Unable to apply transformation for the given package - Changes are already present in the package.", + "FailedToApplyTransformationReason1": "1. Whether the Transformation is already applied for the MSBuild generated package during build. If yes, remove the tag for each config in the csproj file and rebuild. ", + "FailedToApplyTransformationReason2": "2. Ensure that the config file and transformation files are present in the same folder inside the package.", + "FailedToApplyXMLvariablesubstitutionReason1": "Failed to apply XML variable substitution. Changes are already present in the package.", + "MissingArgumentsforXMLTransformation": "Incomplete or missing arguments. Expected format -transform -xml -result . Transformation and source file are mandatory inputs.", + "MorethanonepackagematchedwithspecifiedpatternPleaserestrainthesearchpattern": "More than one package matched with specified pattern: %s. Please restrain the search pattern.", + "JSONvariableSubstitution" : "Applying JSON variable substitution for %s", + "SubstitutingValueonKey" : "Substituting value on key: %s", + "SubstitutingValueonKeyWithNumber" : "Substituting value on key %s with (number) value: %s", + "SubstitutingValueonKeyWithBoolean" : "Substituting value on key %s with (boolean) value: %s", + "SubstitutingValueonKeyWithObject" : "Substituting value on key %s with (object) value: %s", + "SubstitutingValueonKeyWithString" : "Substituting value on key %s with (string) value: %s", + "ApplyingXDTtransformation" : "Applying XDT Transformation from transformation file %s -> source file %s ", + "SubstitutionForXmlNode" : "Processing substitution for xml node : %s", + "UpdatingKeyWithTokenValue" : "Updating value for key= %s with token value: %s", + "SubstitutingConnectionStringValue" : "Substituting connectionString value for connectionString = %s with token value: %s ", + "VariableSubstitutionInitiated" : "Initiated variable substitution in config file : %s", + "ConfigFileUpdated" : "Config file : %s updated.", + "SkippedUpdatingFile" : "Skipped Updating file: %s" + } +} \ No newline at end of file diff --git a/common-npm-packages/webdeployment-common-v2/msdeployutility.ts b/common-npm-packages/webdeployment-common-v2/msdeployutility.ts new file mode 100644 index 000000000000..d36d8ed4e293 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/msdeployutility.ts @@ -0,0 +1,265 @@ +import Q = require('q'); +import tl = require('azure-pipelines-task-lib/task'); +import trm = require('azure-pipelines-task-lib/toolrunner'); +import fs = require('fs'); +import path = require('path'); +import { Package, PackageType } from './packageUtility'; + +var winreg = require('winreg'); +var parseString = require('xml2js').parseString; +const ERROR_FILE_NAME = "error.txt"; + +/** + * Constructs argument for MSDeploy command + * + * @param webAppPackage Web deploy package + * @param webAppName web App Name + * @param publishingProfile Azure RM Connection Details + * @param removeAdditionalFilesFlag Flag to set DoNotDeleteRule rule + * @param excludeFilesFromAppDataFlag Flag to prevent App Data from publishing + * @param takeAppOfflineFlag Flag to enable AppOffline rule + * @param virtualApplication Virtual Application Name + * @param setParametersFile Set Parameter File path + * @param additionalArguments Arguments provided by user + * @param isParamFilePresentInPacakge Flag to check Paramter.xml file + * @param isFolderBasedDeployment Flag to check if given web package path is a folder + * + * @returns string + */ +export function getMSDeployCmdArgs(webAppPackage: string, webAppName: string, publishingProfile, + removeAdditionalFilesFlag: boolean, excludeFilesFromAppDataFlag: boolean, takeAppOfflineFlag: boolean, + virtualApplication: string, setParametersFile: string, additionalArguments: string, isParamFilePresentInPacakge: boolean, + isFolderBasedDeployment: boolean, useWebDeploy: boolean) : string { + + var msDeployCmdArgs: string = " -verb:sync"; + + var webApplicationDeploymentPath = (virtualApplication) ? webAppName + "/" + virtualApplication : webAppName; + + if(isFolderBasedDeployment) { + msDeployCmdArgs += " -source:IisApp=\"'" + webAppPackage + "'\""; + msDeployCmdArgs += " -dest:iisApp=\"'" + webApplicationDeploymentPath + "'\""; + } + else { + if (webAppPackage && webAppPackage.toLowerCase().endsWith('.war')) { + tl.debug('WAR: webAppPackage = ' + webAppPackage); + let warFile = path.basename(webAppPackage.slice(0, webAppPackage.length - '.war'.length)); + let warExt = webAppPackage.slice(webAppPackage.length - '.war'.length) + tl.debug('WAR: warFile = ' + warFile); + warFile = (virtualApplication) ? warFile + "/" + virtualApplication + warExt : warFile + warExt; + tl.debug('WAR: warFile = ' + warFile); + msDeployCmdArgs += " -source:contentPath=\"'" + webAppPackage + "'\""; + // tomcat, jetty location on server => /site/webapps/ + tl.debug('WAR: dest = /site/webapps/' + warFile); + msDeployCmdArgs += " -dest:contentPath=\"'/site/webapps/" + warFile + "'\""; + } else { + msDeployCmdArgs += " -source:package=\"'" + webAppPackage + "'\""; + + if(isParamFilePresentInPacakge) { + msDeployCmdArgs += " -dest:auto"; + } + else { + msDeployCmdArgs += " -dest:contentPath=\"'" + webApplicationDeploymentPath + "'\""; + } + } + } + + if(publishingProfile != null) { + msDeployCmdArgs += ",ComputerName=\"'https://" + publishingProfile.publishUrl + "/msdeploy.axd?site=" + webAppName + "'\","; + msDeployCmdArgs += "UserName=\"'" + publishingProfile.userName + "'\",Password=\"'" + publishingProfile.userPWD + "'\",AuthType=\"'Basic'\""; + } + + if(isParamFilePresentInPacakge) { + msDeployCmdArgs += " -setParam:name=\"'IIS Web Application Name'\",value=\"'" + webApplicationDeploymentPath + "'\""; + } + + if(takeAppOfflineFlag) { + msDeployCmdArgs += ' -enableRule:AppOffline'; + } + + if(useWebDeploy) { + if(setParametersFile) { + msDeployCmdArgs += " -setParamFile=" + setParametersFile + " "; + } + + if(excludeFilesFromAppDataFlag) { + msDeployCmdArgs += ' -skip:Directory=App_Data'; + } + } + + additionalArguments = additionalArguments ? additionalArguments : ' '; + msDeployCmdArgs += ' ' + additionalArguments; + + if(!(removeAdditionalFilesFlag && useWebDeploy)) { + msDeployCmdArgs += " -enableRule:DoNotDeleteRule"; + } + + if(publishingProfile != null) + { + var userAgent = tl.getVariable("AZURE_HTTP_USER_AGENT"); + if(userAgent) + { + msDeployCmdArgs += ' -userAgent:' + userAgent; + } + } + + tl.debug('Constructed msDeploy comamnd line arguments'); + return msDeployCmdArgs; +} + + +export async function getWebDeployArgumentsString(webDeployArguments: WebDeployArguments, publishingProfile: any) { + return getMSDeployCmdArgs(webDeployArguments.package.getPath(), webDeployArguments.appName, publishingProfile, webDeployArguments.removeAdditionalFilesFlag, + webDeployArguments.excludeFilesFromAppDataFlag, webDeployArguments.takeAppOfflineFlag, webDeployArguments.virtualApplication, + webDeployArguments.setParametersFile, webDeployArguments.additionalArguments, await webDeployArguments.package.isMSBuildPackage(), webDeployArguments.package.isFolder(), webDeployArguments.useWebDeploy); +} + +/** + * Gets the full path of MSDeploy.exe + * + * @returns string + */ +export async function getMSDeployFullPath() { + try { + var msDeployInstallPathRegKey = "\\SOFTWARE\\Microsoft\\IIS Extensions\\MSDeploy"; + var msDeployLatestPathRegKey = await getMSDeployLatestRegKey(msDeployInstallPathRegKey); + var msDeployFullPath = await getMSDeployInstallPath(msDeployLatestPathRegKey); + msDeployFullPath = msDeployFullPath + "msdeploy.exe"; + return msDeployFullPath; + } + catch(error) { + tl.debug(error); + return path.join(__dirname, "MSDeploy3.6", "msdeploy.exe"); + } +} + +function getMSDeployLatestRegKey(registryKey: string): Q.Promise { + var defer = Q.defer(); + var regKey = new winreg({ + hive: winreg.HKLM, + key: registryKey + }) + + regKey.keys(function(err, subRegKeys) { + if(err) { + defer.reject(tl.loc("UnabletofindthelocationofMSDeployfromregistryonmachineError", err)); + return; + } + var latestKeyVersion = 0 ; + var latestSubKey; + for(var index in subRegKeys) { + var subRegKey = subRegKeys[index].key; + var subKeyVersion = subRegKey.substr(subRegKey.lastIndexOf('\\') + 1, subRegKey.length - 1); + if(!isNaN(subKeyVersion)){ + var subKeyVersionNumber = parseFloat(subKeyVersion); + if(subKeyVersionNumber > latestKeyVersion) { + latestKeyVersion = subKeyVersionNumber; + latestSubKey = subRegKey; + } + } + } + if(latestKeyVersion < 3) { + defer.reject(tl.loc("UnsupportedinstalledversionfoundforMSDeployversionshouldbeatleast3orabove", latestKeyVersion)); + return; + } + defer.resolve(latestSubKey); + }); + return defer.promise; +} + +function getMSDeployInstallPath(registryKey: string): Q.Promise { + var defer = Q.defer(); + + var regKey = new winreg({ + hive: winreg.HKLM, + key: registryKey + }) + + regKey.get("InstallPath", function(err,item) { + if(err) { + defer.reject(tl.loc("UnabletofindthelocationofMSDeployfromregistryonmachineError", err)); + return; + } + defer.resolve(item.value); + }); + + return defer.promise; +} + +/** + * 1. Checks if msdeploy during execution redirected any error to + * error stream ( saved in error.txt) , display error to console + * 2. Checks if there is file in use error , suggest to try app offline. + */ +export function redirectMSDeployErrorToConsole() { + var msDeployErrorFilePath = tl.getVariable('System.DefaultWorkingDirectory') + '\\' + ERROR_FILE_NAME; + + if(tl.exist(msDeployErrorFilePath)) { + var errorFileContent = fs.readFileSync(msDeployErrorFilePath).toString(); + + if(errorFileContent !== "") { + if(errorFileContent.indexOf("ERROR_INSUFFICIENT_ACCESS_TO_SITE_FOLDER") !== -1) { + tl.warning(tl.loc("Trytodeploywebappagainwithappofflineoptionselected")); + } + else if(errorFileContent.indexOf("An error was encountered when processing operation 'Delete Directory' on 'D:\\home\\site\\wwwroot\\app_data\\jobs'") !== -1) { + tl.warning(tl.loc('WebJobsInProgressIssue')); + } + else if(errorFileContent.indexOf("FILE_IN_USE") !== -1) { + tl.warning(tl.loc("Trytodeploywebappagainwithrenamefileoptionselected")); + } + else if(errorFileContent.indexOf("transport connection") != -1){ + errorFileContent = errorFileContent + tl.loc("Updatemachinetoenablesecuretlsprotocol"); + } + + tl.error(errorFileContent); + } + + tl.rmRF(msDeployErrorFilePath); + } +} + +export function getWebDeployErrorCode(errorMessage): string { + if(errorMessage !== "") { + if(errorMessage.indexOf("ERROR_INSUFFICIENT_ACCESS_TO_SITE_FOLDER") !== -1) { + return "ERROR_INSUFFICIENT_ACCESS_TO_SITE_FOLDER"; + } + else if(errorMessage.indexOf("An error was encountered when processing operation 'Delete Directory' on 'D:\\home\\site\\wwwroot\\app_data\\jobs") !== -1) { + return "WebJobsInProgressIssue"; + } + else if(errorMessage.indexOf("FILE_IN_USE") !== -1) { + return "FILE_IN_USE"; + } + else if(errorMessage.indexOf("transport connection") != -1){ + return "transport connection"; + } + else if(errorMessage.indexOf("ERROR_CONNECTION_TERMINATED") != -1) { + return "ERROR_CONNECTION_TERMINATED" + } + else if(errorMessage.indexOf("ERROR_CERTIFICATE_VALIDATION_FAILED") != -1) { + return "ERROR_CERTIFICATE_VALIDATION_FAILED"; + } + } + + return ""; +} + +export interface WebDeployArguments { + package: Package; + appName: string; + publishUrl?: string; + userName?: string; + password?: string; + removeAdditionalFilesFlag?: boolean; + excludeFilesFromAppDataFlag?: boolean; + takeAppOfflineFlag?: boolean; + virtualApplication?: string; + setParametersFile?: string + additionalArguments?: string; + useWebDeploy?: boolean; +} + + +export interface WebDeployResult { + isSuccess: boolean; + errorCode?: string; + error?: string; +} \ No newline at end of file diff --git a/common-npm-packages/webdeployment-common-v2/npm-shrinkwrap.json b/common-npm-packages/webdeployment-common-v2/npm-shrinkwrap.json new file mode 100644 index 000000000000..aae97514aa67 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/npm-shrinkwrap.json @@ -0,0 +1,498 @@ +{ + "name": "webdeployment-common-v2", + "version": "2.0.0", + "lockfileVersion": 1, + "requires": true, + "dependencies": { + "archiver": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/archiver/-/archiver-1.2.0.tgz", + "integrity": "sha1-+1xq9UQ7P6akJjRHU7rSp7REqt0=", + "requires": { + "archiver-utils": "^1.3.0", + "async": "^2.0.0", + "buffer-crc32": "^0.2.1", + "glob": "^7.0.0", + "lodash": "^4.8.0", + "readable-stream": "^2.0.0", + "tar-stream": "^1.5.0", + "zip-stream": "^1.1.0" + }, + "dependencies": { + "archiver-utils": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/archiver-utils/-/archiver-utils-1.3.0.tgz", + "integrity": "sha1-5QtMCccL89aA4y/xt5lOn52JUXQ=", + "requires": { + "glob": "^7.0.0", + "graceful-fs": "^4.1.0", + "lazystream": "^1.0.0", + "lodash": "^4.8.0", + "normalize-path": "^2.0.0", + "readable-stream": "^2.0.0" + } + }, + "async": { + "version": "2.6.0", + "resolved": "https://registry.npmjs.org/async/-/async-2.6.0.tgz", + "integrity": "sha512-xAfGg1/NTLBBKlHFmnd7PlmUW9KhVQIUuSrYem9xzFUZy13ScvtyGGejaae9iAVRiRq9+Cx7DPFaAAhCpyxyPw==", + "requires": { + "lodash": "^4.14.0" + } + }, + "balanced-match": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.0.tgz", + "integrity": "sha1-ibTRmasr7kneFk6gK4nORi1xt2c=" + }, + "bl": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/bl/-/bl-1.2.1.tgz", + "integrity": "sha1-ysMo977kVzDUBLaSID/LWQ4XLV4=", + "requires": { + "readable-stream": "^2.0.5" + } + }, + "brace-expansion": { + "version": "1.1.11", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", + "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", + "requires": { + "balanced-match": "^1.0.0", + "concat-map": "0.0.1" + } + }, + "buffer-crc32": { + "version": "0.2.13", + "resolved": "https://registry.npmjs.org/buffer-crc32/-/buffer-crc32-0.2.13.tgz", + "integrity": "sha1-DTM+PwDqxQqhRUq9MO+MKl2ackI=" + }, + "compress-commons": { + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/compress-commons/-/compress-commons-1.2.2.tgz", + "integrity": "sha1-UkqfEJA/OoEzibAiXSfEi7dRiQ8=", + "requires": { + "buffer-crc32": "^0.2.1", + "crc32-stream": "^2.0.0", + "normalize-path": "^2.0.0", + "readable-stream": "^2.0.0" + } + }, + "concat-map": { + "version": "0.0.1", + "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", + "integrity": "sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=" + }, + "core-util-is": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.2.tgz", + "integrity": "sha1-tf1UIgqivFq1eqtxQMlAdUUDwac=" + }, + "crc32-stream": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/crc32-stream/-/crc32-stream-2.0.0.tgz", + "integrity": "sha1-483TtN8xaN10494/u8t7KX/pCPQ=", + "requires": { + "crc": "^3.4.4", + "readable-stream": "^2.0.0" + } + }, + "end-of-stream": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/end-of-stream/-/end-of-stream-1.4.1.tgz", + "integrity": "sha512-1MkrZNvWTKCaigbn+W15elq2BB/L22nqrSY5DKlo3X6+vclJm8Bb5djXJBmEX6fS3+zCh/F4VBK5Z2KxJt4s2Q==", + "requires": { + "once": "^1.4.0" + } + }, + "fs.realpath": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", + "integrity": "sha1-FQStJSMVjKpA20onh8sBQRmU6k8=" + }, + "glob": { + "version": "7.1.2", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.2.tgz", + "integrity": "sha512-MJTUg1kjuLeQCJ+ccE4Vpa6kKVXkPYJ2mOCQyUuKLcLQsdrMCpBPUi8qVE6+YuaJkozeA9NusTAw3hLr8Xe5EQ==", + "requires": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.0.4", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" + } + }, + "graceful-fs": { + "version": "4.1.11", + "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.1.11.tgz", + "integrity": "sha1-Dovf5NHduIVNZOBOp8AOKgJuVlg=" + }, + "inflight": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", + "integrity": "sha1-Sb1jMdfQLQwJvJEKEHW6gWW1bfk=", + "requires": { + "once": "^1.3.0", + "wrappy": "1" + } + }, + "inherits": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.3.tgz", + "integrity": "sha1-Yzwsg+PaQqUC9SRmAiSA9CCCYd4=" + }, + "isarray": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz", + "integrity": "sha1-u5NdSFgsuhaMBoNJV6VKPgcSTxE=" + }, + "lazystream": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/lazystream/-/lazystream-1.0.0.tgz", + "integrity": "sha1-9plf4PggOS9hOWvolGJAe7dxaOQ=", + "requires": { + "readable-stream": "^2.0.5" + } + }, + "lodash": { + "version": "4.17.5", + "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.5.tgz", + "integrity": "sha512-svL3uiZf1RwhH+cWrfZn3A4+U58wbP0tGVTLQPbjplZxZ8ROD9VLuNgsRniTlLe7OlSqR79RUehXgpBW/s0IQw==" + }, + "minimatch": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz", + "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==", + "requires": { + "brace-expansion": "^1.1.7" + } + }, + "normalize-path": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-2.1.1.tgz", + "integrity": "sha1-GrKLVW4Zg2Oowab35vogE3/mrtk=", + "requires": { + "remove-trailing-separator": "^1.0.1" + } + }, + "once": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", + "integrity": "sha1-WDsap3WWHUsROsF9nFC6753Xa9E=", + "requires": { + "wrappy": "1" + } + }, + "path-is-absolute": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", + "integrity": "sha1-F0uSaHNVNP+8es5r9TpanhtcX18=" + }, + "process-nextick-args": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/process-nextick-args/-/process-nextick-args-2.0.0.tgz", + "integrity": "sha512-MtEC1TqN0EU5nephaJ4rAtThHtC86dNN9qCuEhtshvpVBkAW5ZO7BASN9REnF9eoXGcRub+pFuKEpOHE+HbEMw==" + }, + "readable-stream": { + "version": "2.3.4", + "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.3.4.tgz", + "integrity": "sha512-vuYxeWYM+fde14+rajzqgeohAI7YoJcHE7kXDAc4Nk0EbuKnJfqtY9YtRkLo/tqkuF7MsBQRhPnPeyjYITp3ZQ==", + "requires": { + "core-util-is": "~1.0.0", + "inherits": "~2.0.3", + "isarray": "~1.0.0", + "process-nextick-args": "~2.0.0", + "safe-buffer": "~5.1.1", + "string_decoder": "~1.0.3", + "util-deprecate": "~1.0.1" + } + }, + "string_decoder": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.0.3.tgz", + "integrity": "sha512-4AH6Z5fzNNBcH+6XDMfA/BTt87skxqJlO0lAh3Dker5zThcAxG6mKz+iGu308UKoPPQ8Dcqx/4JhujzltRa+hQ==", + "requires": { + "safe-buffer": "~5.1.0" + } + }, + "tar-stream": { + "version": "1.5.5", + "resolved": "https://registry.npmjs.org/tar-stream/-/tar-stream-1.5.5.tgz", + "integrity": "sha512-mQdgLPc/Vjfr3VWqWbfxW8yQNiJCbAZ+Gf6GDu1Cy0bdb33ofyiNGBtAY96jHFhDuivCwgW1H9DgTON+INiXgg==", + "requires": { + "bl": "^1.0.0", + "end-of-stream": "^1.0.0", + "readable-stream": "^2.0.0", + "xtend": "^4.0.0" + } + }, + "util-deprecate": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz", + "integrity": "sha1-RQ1Nyfpw3nMnYvvS1KKJgUGaDM8=" + }, + "wrappy": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", + "integrity": "sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8=" + }, + "xtend": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/xtend/-/xtend-4.0.1.tgz", + "integrity": "sha1-pcbVMr5lbiPbgg77lDofBJmNY68=" + }, + "zip-stream": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/zip-stream/-/zip-stream-1.2.0.tgz", + "integrity": "sha1-qLxF9MG0lpnGuQGYuqyqzbzUugQ=", + "requires": { + "archiver-utils": "^1.3.0", + "compress-commons": "^1.2.0", + "lodash": "^4.8.0", + "readable-stream": "^2.0.0" + } + } + } + }, + "azure-pipelines-task-lib": { + "version": "2.8.0", + "resolved": "https://registry.npmjs.org/azure-pipelines-task-lib/-/azure-pipelines-task-lib-2.8.0.tgz", + "integrity": "sha512-PR8oap9z2j+o455W3PwAfB4SX1p4GdJc9OHQaQV0V+iQS1IBY6dVgcNSQMkHAXb0V1bbuLOFBLanXPe5eSgGTQ==", + "requires": { + "minimatch": "3.0.4", + "mockery": "^1.7.0", + "q": "^1.1.2", + "semver": "^5.1.0", + "shelljs": "^0.3.0", + "uuid": "^3.0.1" + } + }, + "balanced-match": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.0.tgz", + "integrity": "sha1-ibTRmasr7kneFk6gK4nORi1xt2c=" + }, + "brace-expansion": { + "version": "1.1.11", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", + "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", + "requires": { + "balanced-match": "^1.0.0", + "concat-map": "0.0.1" + } + }, + "concat-map": { + "version": "0.0.1", + "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", + "integrity": "sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=" + }, + "crc": { + "version": "3.5.0", + "resolved": "https://registry.npmjs.org/crc/-/crc-3.5.0.tgz", + "integrity": "sha1-mLi6fUiWZbo5efWbITgTdBAaGWQ=" + }, + "decompress-zip": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/decompress-zip/-/decompress-zip-0.3.0.tgz", + "integrity": "sha1-rjvLfjTGWHmt/nfhnDD4ZgK0vbA=", + "requires": { + "binary": "^0.3.0", + "graceful-fs": "^4.1.3", + "mkpath": "^0.1.0", + "nopt": "^3.0.1", + "q": "^1.1.2", + "readable-stream": "^1.1.8", + "touch": "0.0.3" + }, + "dependencies": { + "abbrev": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/abbrev/-/abbrev-1.1.1.tgz", + "integrity": "sha512-nne9/IiQ/hzIhY6pdDnbBtz7DjPTKrY00P/zvPSm5pOFkl6xuGrGnXn/VtTNNfNtAfZ9/1RtehkszU9qcTii0Q==" + }, + "binary": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/binary/-/binary-0.3.0.tgz", + "integrity": "sha1-n2BVO8XOjDOG87VTz/R0Yq3sqnk=", + "requires": { + "buffers": "~0.1.1", + "chainsaw": "~0.1.0" + } + }, + "buffers": { + "version": "0.1.1", + "resolved": "https://registry.npmjs.org/buffers/-/buffers-0.1.1.tgz", + "integrity": "sha1-skV5w77U1tOWru5tmorn9Ugqt7s=" + }, + "chainsaw": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/chainsaw/-/chainsaw-0.1.0.tgz", + "integrity": "sha1-XqtQsor+WAdNDVgpE4iCi15fvJg=", + "requires": { + "traverse": ">=0.3.0 <0.4" + } + }, + "core-util-is": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.2.tgz", + "integrity": "sha1-tf1UIgqivFq1eqtxQMlAdUUDwac=" + }, + "graceful-fs": { + "version": "4.1.11", + "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.1.11.tgz", + "integrity": "sha1-Dovf5NHduIVNZOBOp8AOKgJuVlg=" + }, + "inherits": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.3.tgz", + "integrity": "sha1-Yzwsg+PaQqUC9SRmAiSA9CCCYd4=" + }, + "isarray": { + "version": "0.0.1", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-0.0.1.tgz", + "integrity": "sha1-ihis/Kmo9Bd+Cav8YDiTmwXR7t8=" + }, + "mkpath": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/mkpath/-/mkpath-0.1.0.tgz", + "integrity": "sha1-dVSm+Nhxg0zJe1RisSLEwSTW3pE=" + }, + "nopt": { + "version": "3.0.6", + "resolved": "https://registry.npmjs.org/nopt/-/nopt-3.0.6.tgz", + "integrity": "sha1-xkZdvwirzU2zWTF/eaxopkayj/k=", + "requires": { + "abbrev": "1" + } + }, + "readable-stream": { + "version": "1.1.14", + "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-1.1.14.tgz", + "integrity": "sha1-fPTFTvZI44EwhMY23SB54WbAgdk=", + "requires": { + "core-util-is": "~1.0.0", + "inherits": "~2.0.1", + "isarray": "0.0.1", + "string_decoder": "~0.10.x" + } + }, + "string_decoder": { + "version": "0.10.31", + "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-0.10.31.tgz", + "integrity": "sha1-YuIDvEF2bGwoyfyEMB2rHFMQ+pQ=" + }, + "touch": { + "version": "0.0.3", + "resolved": "https://registry.npmjs.org/touch/-/touch-0.0.3.tgz", + "integrity": "sha1-Ua7z1ElXHU8oel2Hyci0kYGg2x0=", + "requires": { + "nopt": "~1.0.10" + }, + "dependencies": { + "nopt": { + "version": "1.0.10", + "resolved": "https://registry.npmjs.org/nopt/-/nopt-1.0.10.tgz", + "integrity": "sha1-bd0hvSoxQXuScn3Vhfim83YI6+4=", + "requires": { + "abbrev": "1" + } + } + } + }, + "traverse": { + "version": "0.3.9", + "resolved": "https://registry.npmjs.org/traverse/-/traverse-0.3.9.tgz", + "integrity": "sha1-cXuPIgzAu3tE5AUUwisui7xw2Lk=" + } + } + }, + "inherits": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.3.tgz", + "integrity": "sha1-Yzwsg+PaQqUC9SRmAiSA9CCCYd4=" + }, + "ltx": { + "version": "2.8.0", + "resolved": "https://registry.npmjs.org/ltx/-/ltx-2.8.0.tgz", + "integrity": "sha512-SJJUrmDgXP0gkUzgErfkaeD+pugM8GYxerTALQa1gTUb5W1wrC4k07GZU+QNZd7MpFqJSYWXTQSUy8Ps03hx5Q==", + "requires": { + "inherits": "^2.0.1" + } + }, + "minimatch": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz", + "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==", + "requires": { + "brace-expansion": "^1.1.7" + } + }, + "mockery": { + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/mockery/-/mockery-1.7.0.tgz", + "integrity": "sha1-9O3g2HUMHJcnwnLqLGBiniyaHE8=" + }, + "q": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/q/-/q-1.4.1.tgz", + "integrity": "sha1-VXBbzZPF82c1MMLCy8DCs63cKG4=" + }, + "remove-trailing-separator": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/remove-trailing-separator/-/remove-trailing-separator-1.1.0.tgz", + "integrity": "sha1-wkvOKig62tW8P1jg1IJJuSN52O8=" + }, + "safe-buffer": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.1.tgz", + "integrity": "sha512-kKvNJn6Mm93gAczWVJg7wH+wGYWNrDHdWvpUmHyEsgCtIwwo3bqPtV4tR5tuPaUhTOo/kvhVwd8XwwOllGYkbg==" + }, + "semver": { + "version": "5.7.0", + "resolved": "https://registry.npmjs.org/semver/-/semver-5.7.0.tgz", + "integrity": "sha512-Ya52jSX2u7QKghxeoFGpLwCtGlt7j0oY9DYb5apt9nPlJ42ID+ulTXESnt/qAQcoSERyZ5sl3LDIOw0nAn/5DA==" + }, + "shelljs": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/shelljs/-/shelljs-0.3.0.tgz", + "integrity": "sha1-NZbmMHp4FUT1kfN9phg2DzHbV7E=" + }, + "uuid": { + "version": "3.3.2", + "resolved": "https://registry.npmjs.org/uuid/-/uuid-3.3.2.tgz", + "integrity": "sha512-yXJmeNaw3DnnKAOKJE51sL/ZaYfWJRl1pK9dr19YFCu0ObS231AB1/LbqTKRAQ5kw8A90rA6fr4riOUpTZvQZA==" + }, + "winreg": { + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/winreg/-/winreg-1.2.2.tgz", + "integrity": "sha1-hQmvo7ccW70RCm18YkfsZ3NsWY8=" + }, + "xml2js": { + "version": "0.4.13", + "resolved": "https://registry.npmjs.org/xml2js/-/xml2js-0.4.13.tgz", + "integrity": "sha1-+EQ+B0Oeb/ktmVKPSbvTScyfMGs=", + "requires": { + "sax": ">=0.6.0", + "xmlbuilder": ">=2.4.6" + }, + "dependencies": { + "sax": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/sax/-/sax-1.2.4.tgz", + "integrity": "sha512-NqVDv9TpANUjFm0N8uM5GxL36UgKi9/atZw+x7YFnQ8ckwFGKrl4xX4yWtrey3UJm5nP1kUbnYgLopqWNSRhWw==" + }, + "xmlbuilder": { + "version": "9.0.7", + "resolved": "https://registry.npmjs.org/xmlbuilder/-/xmlbuilder-9.0.7.tgz", + "integrity": "sha1-Ey7mPS7FVlxVfiD0wi35rKaGsQ0=" + } + } + }, + "xmldom": { + "version": "0.1.31", + "resolved": "https://registry.npmjs.org/xmldom/-/xmldom-0.1.31.tgz", + "integrity": "sha512-yS2uJflVQs6n+CyjHoaBmVSqIDevTAWrzMmjG1Gc7h1qQ7uVozNhEPJAwZXWyGQ/Gafo3fCwrcaokezLPupVyQ==" + } + } +} diff --git a/common-npm-packages/webdeployment-common-v2/npmdomutility.ts b/common-npm-packages/webdeployment-common-v2/npmdomutility.ts new file mode 100644 index 000000000000..ef1dfe199e1c --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/npmdomutility.ts @@ -0,0 +1,81 @@ +var varUtility = require("./variableutility.js"); +var DOMParser = require('xmldom').DOMParser; + +export class NpmDomUtility { + + private xmlDomLookUpTable = {}; + private xmlDom; + + public constructor(xmlContent) { + this.xmlDomLookUpTable = {}; + this.xmlDom = new DOMParser().parseFromString(xmlContent,"text/xml"); + this.buildLookUpTable(this.xmlDom); + } + + public getXmlDom() { + return this.xmlDom; + } + + public getContentWithHeader(xmlDom) { + return xmlDom ? xmlDom.toString() : ""; + } + + /** + * Define method to create a lookup for DOM + */ + private buildLookUpTable(node) { + if(node){ + let nodeName = node.nodeName; + if(nodeName){ + nodeName = nodeName.toLowerCase(); + let listOfNodes = this.xmlDomLookUpTable[nodeName]; + if(listOfNodes == null || !(Array.isArray(listOfNodes))) { + this.xmlDomLookUpTable[nodeName] = []; + } + (this.xmlDomLookUpTable[nodeName]).push(node); + if(node.childNodes) { + let children = node.childNodes; + for(let i=0 ; i < children.length; i++) { + this.buildLookUpTable(children[i]); + } + } + } + } + } + + /** + * Returns array of nodes which match with the tag name. + */ + public getElementsByTagName(nodeName) { + if(varUtility.isEmpty(nodeName)) + return []; + let selectedElements = this.xmlDomLookUpTable[nodeName.toLowerCase()]; + if(!selectedElements){ + selectedElements = []; + } + return selectedElements; + } + + /** + * Search in subtree with provided node name + */ + public getChildElementsByTagName(node, tagName) { + if(!varUtility.isObject(node) ) + return []; + var liveNodes = []; + if(node.childNodes){ + var children = node.childNodes; + for(let i=0; i < children.length; i++ ){ + let childName = children[i].nodeName; + if( !varUtility.isEmpty(childName) && tagName == childName){ + liveNodes.push(children[i]); + } + let liveChildNodes = this.getChildElementsByTagName(children[i], tagName); + if(liveChildNodes && liveChildNodes.length > 0){ + liveNodes = liveNodes.concat(liveChildNodes); + } + } + } + return liveNodes; + } +} diff --git a/common-npm-packages/webdeployment-common-v2/package.json b/common-npm-packages/webdeployment-common-v2/package.json new file mode 100644 index 000000000000..6a022ee2134c --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/package.json @@ -0,0 +1,25 @@ +{ + "name": "webdeployment-common-v2", + "version": "2.0.0", + "description": "Common Lib for MSDeploy Utility", + "repository": { + "type": "git", + "url": "git+ssh://git@github.com/Microsoft/azure-pipelines-tasks.git" + }, + "author": "Microsoft Corporation", + "license": "MIT", + "bugs": { + "url": "https://github.com/Microsoft/azure-pipelines-tasks/issues" + }, + "homepage": "https://github.com/Microsoft/azure-pipelines-tasks#readme", + "dependencies": { + "archiver": "1.2.0", + "decompress-zip": "0.3.0", + "ltx": "2.8.0", + "q": "1.4.1", + "azure-pipelines-task-lib": "2.8.0", + "winreg": "1.2.2", + "xml2js": "0.4.13", + "xmldom": "^0.1.27" + } +} diff --git a/common-npm-packages/webdeployment-common-v2/packageUtility.ts b/common-npm-packages/webdeployment-common-v2/packageUtility.ts new file mode 100644 index 000000000000..8de6103d27b3 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/packageUtility.ts @@ -0,0 +1,127 @@ +import tl = require('azure-pipelines-task-lib/task'); +import utility = require('./utility'); +var zipUtility = require('webdeployment-common-v2/ziputility.js'); +import path = require('path'); + +export enum PackageType { + war, + zip, + jar, + folder +} + +export class PackageUtility { + public static getPackagePath(packagePath: string): string { + var availablePackages: string[] = utility.findfiles(packagePath); + if(availablePackages.length == 0) { + throw new Error(tl.loc('Nopackagefoundwithspecifiedpattern', packagePath)); + } + + if(availablePackages.length > 1) { + throw new Error(tl.loc('MorethanonepackagematchedwithspecifiedpatternPleaserestrainthesearchpattern', packagePath)); + } + + return availablePackages[0]; + } + + public static getArtifactAlias(packagePath: string): string { + let artifactAlias = null; + if (tl.getVariable('release.releaseId')) { + // Determine artifact alias from package path if task is running in release. + let workingDirectory = tl.getVariable("system.defaultworkingdirectory"); + try { + if (workingDirectory && packagePath.indexOf(workingDirectory) == 0) { + let relativePackagePath = packagePath.substring(workingDirectory.length); + if (relativePackagePath.indexOf(path.sep) == 0) { + relativePackagePath = relativePackagePath.substring(1); + } + let endIndex = relativePackagePath.indexOf(path.sep); + endIndex = endIndex >= 0 ? endIndex : relativePackagePath.length; + artifactAlias = relativePackagePath.substring(0, endIndex); + if(!tl.getVariable(`release.artifacts.${artifactAlias}.definitionId`)) { + // Artifact alias determined is not correct, set it to null + tl.debug(`Incorrect artifact alias ${artifactAlias} determined for package path ${packagePath}`); + artifactAlias = null; + } + } + } + catch (error) { + artifactAlias = null; + tl.debug(`Error in determining artifact alias of package. Error: ${error}`); + } + } + tl.debug("Artifact alias of package is: " + artifactAlias); + return artifactAlias; + } +} + +export class Package { + constructor(packagePath: string) { + this._path = PackageUtility.getPackagePath(packagePath); + this._isMSBuildPackage = undefined; + } + + public getPath(): string { + return this._path; + } + + public async isMSBuildPackage(): Promise { + if(this._isMSBuildPackage == undefined) { + this._isMSBuildPackage = false; + if(this.getPackageType() != PackageType.folder) { + var pacakgeComponent = await zipUtility.getArchivedEntries(this._path); + if (((pacakgeComponent["entries"].indexOf("parameters.xml") > -1) || (pacakgeComponent["entries"].indexOf("Parameters.xml") > -1)) && + ((pacakgeComponent["entries"].indexOf("systemInfo.xml") > -1) || (pacakgeComponent["entries"].indexOf("systeminfo.xml") > -1) + || (pacakgeComponent["entries"].indexOf("SystemInfo.xml") > -1))) { + this._isMSBuildPackage = true; + } + } + + tl.debug("Is the package an msdeploy package : " + this._isMSBuildPackage); + } + + return this._isMSBuildPackage; + } + + public getPackageType(): PackageType { + if (this._packageType == undefined) { + if (!tl.exist(this._path)) { + throw new Error(tl.loc('Invalidwebapppackageorfolderpathprovided', this._path)); + } else{ + if (this._path.toLowerCase().endsWith('.war')) { + this._packageType = PackageType.war; + tl.debug("This is war package "); + } else if(this._path.toLowerCase().endsWith('.jar')){ + this._packageType = PackageType.jar; + tl.debug("This is jar package "); + } else if (this._path.toLowerCase().endsWith('.zip')){ + this._packageType = PackageType.zip; + tl.debug("This is zip package "); + } else if(!tl.stats(this._path).isFile()){ + this._packageType = PackageType.folder; + tl.debug("This is folder package "); + }else{ + throw new Error(tl.loc('Invalidwebapppackageorfolderpathprovided', this._path)); + } + } + } + return this._packageType; + } + + public isFolder(): boolean { + if(this._isFolder == undefined) { + if (!tl.exist(this._path)) { + throw new Error(tl.loc('Invalidwebapppackageorfolderpathprovided', this._path)); + } + + this._isFolder = !tl.stats(this._path).isFile(); + } + + return this._isFolder; + } + + private _isFolder?: boolean; + private _path: string; + private _isMSBuildPackage?: boolean; + private _packageType?: PackageType; +} diff --git a/common-npm-packages/webdeployment-common-v2/tsconfig.json b/common-npm-packages/webdeployment-common-v2/tsconfig.json new file mode 100644 index 000000000000..bf3139d06f75 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/tsconfig.json @@ -0,0 +1,9 @@ +{ + "compilerOptions": { + "module": "commonjs", + "target": "es6", + "declaration": true, + "noImplicitAny": false, + "sourceMap": false + } +} \ No newline at end of file diff --git a/common-npm-packages/webdeployment-common-v2/typings.json b/common-npm-packages/webdeployment-common-v2/typings.json new file mode 100644 index 000000000000..995a03c36d3e --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/typings.json @@ -0,0 +1,7 @@ +{ + "globalDependencies": { + "mocha": "registry:dt/mocha#2.2.5+20160720003353", + "node": "registry:dt/node#6.0.0+20160920093002", + "q": "registry:dt/q#0.0.0+20160613154756" + } +} diff --git a/common-npm-packages/webdeployment-common-v2/typings/globals/mocha/index.d.ts b/common-npm-packages/webdeployment-common-v2/typings/globals/mocha/index.d.ts new file mode 100644 index 000000000000..ae7de0faa03c --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/typings/globals/mocha/index.d.ts @@ -0,0 +1,202 @@ +// Generated by typings +// Source: https://raw.githubusercontent.com/DefinitelyTyped/DefinitelyTyped/a361a8ab3c327f208d3f82ad206971d4a63d8c25/mocha/mocha.d.ts +interface MochaSetupOptions { + //milliseconds to wait before considering a test slow + slow?: number; + + // timeout in milliseconds + timeout?: number; + + // ui name "bdd", "tdd", "exports" etc + ui?: string; + + //array of accepted globals + globals?: any[]; + + // reporter instance (function or string), defaults to `mocha.reporters.Spec` + reporter?: any; + + // bail on the first test failure + bail?: boolean; + + // ignore global leaks + ignoreLeaks?: boolean; + + // grep string or regexp to filter tests with + grep?: any; +} + +declare var mocha: Mocha; +declare var describe: Mocha.IContextDefinition; +declare var xdescribe: Mocha.IContextDefinition; +// alias for `describe` +declare var context: Mocha.IContextDefinition; +// alias for `describe` +declare var suite: Mocha.IContextDefinition; +declare var it: Mocha.ITestDefinition; +declare var xit: Mocha.ITestDefinition; +// alias for `it` +declare var test: Mocha.ITestDefinition; +declare var specify: Mocha.ITestDefinition; + +interface MochaDone { + (error?: any): any; +} + +interface ActionFunction { + (done: MochaDone): any | PromiseLike +} + +declare function setup(action: ActionFunction): void; +declare function teardown(action: ActionFunction): void; +declare function suiteSetup(action: ActionFunction): void; +declare function suiteTeardown(action: ActionFunction): void; +declare function before(action: ActionFunction): void; +declare function before(description: string, action: ActionFunction): void; +declare function after(action: ActionFunction): void; +declare function after(description: string, action: ActionFunction): void; +declare function beforeEach(action: ActionFunction): void; +declare function beforeEach(description: string, action: ActionFunction): void; +declare function afterEach(action: ActionFunction): void; +declare function afterEach(description: string, action: ActionFunction): void; + +declare class Mocha { + currentTest: Mocha.ITestDefinition; + constructor(options?: { + grep?: RegExp; + ui?: string; + reporter?: string; + timeout?: number; + bail?: boolean; + }); + + /** Setup mocha with the given options. */ + setup(options: MochaSetupOptions): Mocha; + bail(value?: boolean): Mocha; + addFile(file: string): Mocha; + /** Sets reporter by name, defaults to "spec". */ + reporter(name: string): Mocha; + /** Sets reporter constructor, defaults to mocha.reporters.Spec. */ + reporter(reporter: (runner: Mocha.IRunner, options: any) => any): Mocha; + ui(value: string): Mocha; + grep(value: string): Mocha; + grep(value: RegExp): Mocha; + invert(): Mocha; + ignoreLeaks(value: boolean): Mocha; + checkLeaks(): Mocha; + /** + * Function to allow assertion libraries to throw errors directly into mocha. + * This is useful when running tests in a browser because window.onerror will + * only receive the 'message' attribute of the Error. + */ + throwError(error: Error): void; + /** Enables growl support. */ + growl(): Mocha; + globals(value: string): Mocha; + globals(values: string[]): Mocha; + useColors(value: boolean): Mocha; + useInlineDiffs(value: boolean): Mocha; + timeout(value: number): Mocha; + slow(value: number): Mocha; + enableTimeouts(value: boolean): Mocha; + asyncOnly(value: boolean): Mocha; + noHighlighting(value: boolean): Mocha; + /** Runs tests and invokes `onComplete()` when finished. */ + run(onComplete?: (failures: number) => void): Mocha.IRunner; +} + +// merge the Mocha class declaration with a module +declare namespace Mocha { + /** Partial interface for Mocha's `Runnable` class. */ + interface IRunnable { + title: string; + fn: Function; + async: boolean; + sync: boolean; + timedOut: boolean; + } + + /** Partial interface for Mocha's `Suite` class. */ + interface ISuite { + parent: ISuite; + title: string; + + fullTitle(): string; + } + + /** Partial interface for Mocha's `Test` class. */ + interface ITest extends IRunnable { + parent: ISuite; + pending: boolean; + + fullTitle(): string; + } + + /** Partial interface for Mocha's `Runner` class. */ + interface IRunner {} + + interface IContextDefinition { + (description: string, spec: () => void): ISuite; + only(description: string, spec: () => void): ISuite; + skip(description: string, spec: () => void): void; + timeout(ms: number): void; + } + + interface ITestDefinition { + (expectation: string, assertion?: ActionFunction): ITest; + only(expectation: string, assertion?: ActionFunction): ITest; + skip(expectation: string, assertion?: ActionFunction): void; + timeout(ms: number): void; + state: "failed" | "passed"; + } + + export module reporters { + export class Base { + stats: { + suites: number; + tests: number; + passes: number; + pending: number; + failures: number; + }; + + constructor(runner: IRunner); + } + + export class Doc extends Base {} + export class Dot extends Base {} + export class HTML extends Base {} + export class HTMLCov extends Base {} + export class JSON extends Base {} + export class JSONCov extends Base {} + export class JSONStream extends Base {} + export class Landing extends Base {} + export class List extends Base {} + export class Markdown extends Base {} + export class Min extends Base {} + export class Nyan extends Base {} + export class Progress extends Base { + /** + * @param options.open String used to indicate the start of the progress bar. + * @param options.complete String used to indicate a complete test on the progress bar. + * @param options.incomplete String used to indicate an incomplete test on the progress bar. + * @param options.close String used to indicate the end of the progress bar. + */ + constructor(runner: IRunner, options?: { + open?: string; + complete?: string; + incomplete?: string; + close?: string; + }); + } + export class Spec extends Base {} + export class TAP extends Base {} + export class XUnit extends Base { + constructor(runner: IRunner, options?: any); + } + } +} + +declare module "mocha" { + export = Mocha; +} diff --git a/common-npm-packages/webdeployment-common-v2/typings/globals/mocha/typings.json b/common-npm-packages/webdeployment-common-v2/typings/globals/mocha/typings.json new file mode 100644 index 000000000000..aab9d1c1302c --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/typings/globals/mocha/typings.json @@ -0,0 +1,8 @@ +{ + "resolution": "main", + "tree": { + "src": "https://raw.githubusercontent.com/DefinitelyTyped/DefinitelyTyped/a361a8ab3c327f208d3f82ad206971d4a63d8c25/mocha/mocha.d.ts", + "raw": "registry:dt/mocha#2.2.5+20160720003353", + "typings": "https://raw.githubusercontent.com/DefinitelyTyped/DefinitelyTyped/a361a8ab3c327f208d3f82ad206971d4a63d8c25/mocha/mocha.d.ts" + } +} diff --git a/common-npm-packages/webdeployment-common-v2/typings/globals/node/index.d.ts b/common-npm-packages/webdeployment-common-v2/typings/globals/node/index.d.ts new file mode 100644 index 000000000000..1dc54b352d88 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/typings/globals/node/index.d.ts @@ -0,0 +1,3350 @@ +// Generated by typings +// Source: https://raw.githubusercontent.com/DefinitelyTyped/DefinitelyTyped/ab8d917787092fdfb16390f2bee6de8ab5c1783c/node/node.d.ts +interface Error { + stack?: string; +} + +interface ErrorConstructor { + captureStackTrace(targetObject: Object, constructorOpt?: Function): void; + stackTraceLimit: number; +} + +// compat for TypeScript 1.8 +// if you use with --target es3 or --target es5 and use below definitions, +// use the lib.es6.d.ts that is bundled with TypeScript 1.8. +interface MapConstructor { } +interface WeakMapConstructor { } +interface SetConstructor { } +interface WeakSetConstructor { } + +/************************************************ +* * +* GLOBAL * +* * +************************************************/ +declare var process: NodeJS.Process; +declare var global: NodeJS.Global; + +declare var __filename: string; +declare var __dirname: string; + +declare function setTimeout(callback: (...args: any[]) => void, ms: number, ...args: any[]): NodeJS.Timer; +declare function clearTimeout(timeoutId: NodeJS.Timer): void; +declare function setInterval(callback: (...args: any[]) => void, ms: number, ...args: any[]): NodeJS.Timer; +declare function clearInterval(intervalId: NodeJS.Timer): void; +declare function setImmediate(callback: (...args: any[]) => void, ...args: any[]): any; +declare function clearImmediate(immediateId: any): void; + +interface NodeRequireFunction { + (id: string): any; +} + +interface NodeRequire extends NodeRequireFunction { + resolve(id: string): string; + cache: any; + extensions: any; + main: any; +} + +declare var require: NodeRequire; + +interface NodeModule { + exports: any; + require: NodeRequireFunction; + id: string; + filename: string; + loaded: boolean; + parent: any; + children: any[]; +} + +declare var module: NodeModule; + +// Same as module.exports +declare var exports: any; +declare var SlowBuffer: { + new (str: string, encoding?: string): Buffer; + new (size: number): Buffer; + new (size: Uint8Array): Buffer; + new (array: any[]): Buffer; + prototype: Buffer; + isBuffer(obj: any): boolean; + byteLength(string: string, encoding?: string): number; + concat(list: Buffer[], totalLength?: number): Buffer; +}; + + +// Buffer class +type BufferEncoding = "ascii" | "utf8" | "utf16le" | "ucs2" | "binary" | "hex"; +interface Buffer extends NodeBuffer { } + +/** + * Raw data is stored in instances of the Buffer class. + * A Buffer is similar to an array of integers but corresponds to a raw memory allocation outside the V8 heap. A Buffer cannot be resized. + * Valid string encodings: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'binary'(deprecated)|'hex' + */ +declare var Buffer: { + /** + * Allocates a new buffer containing the given {str}. + * + * @param str String to store in buffer. + * @param encoding encoding to use, optional. Default is 'utf8' + */ + new (str: string, encoding?: string): Buffer; + /** + * Allocates a new buffer of {size} octets. + * + * @param size count of octets to allocate. + */ + new (size: number): Buffer; + /** + * Allocates a new buffer containing the given {array} of octets. + * + * @param array The octets to store. + */ + new (array: Uint8Array): Buffer; + /** + * Produces a Buffer backed by the same allocated memory as + * the given {ArrayBuffer}. + * + * + * @param arrayBuffer The ArrayBuffer with which to share memory. + */ + new (arrayBuffer: ArrayBuffer): Buffer; + /** + * Allocates a new buffer containing the given {array} of octets. + * + * @param array The octets to store. + */ + new (array: any[]): Buffer; + /** + * Copies the passed {buffer} data onto a new {Buffer} instance. + * + * @param buffer The buffer to copy. + */ + new (buffer: Buffer): Buffer; + prototype: Buffer; + /** + * Allocates a new Buffer using an {array} of octets. + * + * @param array + */ + from(array: any[]): Buffer; + /** + * When passed a reference to the .buffer property of a TypedArray instance, + * the newly created Buffer will share the same allocated memory as the TypedArray. + * The optional {byteOffset} and {length} arguments specify a memory range + * within the {arrayBuffer} that will be shared by the Buffer. + * + * @param arrayBuffer The .buffer property of a TypedArray or a new ArrayBuffer() + * @param byteOffset + * @param length + */ + from(arrayBuffer: ArrayBuffer, byteOffset?: number, length?: number): Buffer; + /** + * Copies the passed {buffer} data onto a new Buffer instance. + * + * @param buffer + */ + from(buffer: Buffer): Buffer; + /** + * Creates a new Buffer containing the given JavaScript string {str}. + * If provided, the {encoding} parameter identifies the character encoding. + * If not provided, {encoding} defaults to 'utf8'. + * + * @param str + */ + from(str: string, encoding?: string): Buffer; + /** + * Returns true if {obj} is a Buffer + * + * @param obj object to test. + */ + isBuffer(obj: any): obj is Buffer; + /** + * Returns true if {encoding} is a valid encoding argument. + * Valid string encodings in Node 0.12: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'binary'(deprecated)|'hex' + * + * @param encoding string to test. + */ + isEncoding(encoding: string): boolean; + /** + * Gives the actual byte length of a string. encoding defaults to 'utf8'. + * This is not the same as String.prototype.length since that returns the number of characters in a string. + * + * @param string string to test. + * @param encoding encoding used to evaluate (defaults to 'utf8') + */ + byteLength(string: string, encoding?: string): number; + /** + * Returns a buffer which is the result of concatenating all the buffers in the list together. + * + * If the list has no items, or if the totalLength is 0, then it returns a zero-length buffer. + * If the list has exactly one item, then the first item of the list is returned. + * If the list has more than one item, then a new Buffer is created. + * + * @param list An array of Buffer objects to concatenate + * @param totalLength Total length of the buffers when concatenated. + * If totalLength is not provided, it is read from the buffers in the list. However, this adds an additional loop to the function, so it is faster to provide the length explicitly. + */ + concat(list: Buffer[], totalLength?: number): Buffer; + /** + * The same as buf1.compare(buf2). + */ + compare(buf1: Buffer, buf2: Buffer): number; + /** + * Allocates a new buffer of {size} octets. + * + * @param size count of octets to allocate. + * @param fill if specified, buffer will be initialized by calling buf.fill(fill). + * If parameter is omitted, buffer will be filled with zeros. + * @param encoding encoding used for call to buf.fill while initalizing + */ + alloc(size: number, fill?: string | Buffer | number, encoding?: string): Buffer; + /** + * Allocates a new buffer of {size} octets, leaving memory not initialized, so the contents + * of the newly created Buffer are unknown and may contain sensitive data. + * + * @param size count of octets to allocate + */ + allocUnsafe(size: number): Buffer; + /** + * Allocates a new non-pooled buffer of {size} octets, leaving memory not initialized, so the contents + * of the newly created Buffer are unknown and may contain sensitive data. + * + * @param size count of octets to allocate + */ + allocUnsafeSlow(size: number): Buffer; +}; + +/************************************************ +* * +* GLOBAL INTERFACES * +* * +************************************************/ +declare namespace NodeJS { + export interface ErrnoException extends Error { + errno?: string; + code?: string; + path?: string; + syscall?: string; + stack?: string; + } + + export class EventEmitter { + addListener(event: string|symbol, listener: Function): this; + on(event: string|symbol, listener: Function): this; + once(event: string|symbol, listener: Function): this; + removeListener(event: string|symbol, listener: Function): this; + removeAllListeners(event?: string|symbol): this; + setMaxListeners(n: number): this; + getMaxListeners(): number; + listeners(event: string|symbol): Function[]; + emit(event: string|symbol, ...args: any[]): boolean; + listenerCount(type: string|symbol): number; + // Added in Node 6... + prependListener(event: string|symbol, listener: Function): this; + prependOnceListener(event: string|symbol, listener: Function): this; + eventNames(): (string|symbol)[]; + } + + export interface ReadableStream extends EventEmitter { + readable: boolean; + read(size?: number): string | Buffer; + setEncoding(encoding: string): void; + pause(): ReadableStream; + resume(): ReadableStream; + pipe(destination: T, options?: { end?: boolean; }): T; + unpipe(destination?: T): void; + unshift(chunk: string): void; + unshift(chunk: Buffer): void; + wrap(oldStream: ReadableStream): ReadableStream; + } + + export interface WritableStream extends EventEmitter { + writable: boolean; + write(buffer: Buffer | string, cb?: Function): boolean; + write(str: string, encoding?: string, cb?: Function): boolean; + end(): void; + end(buffer: Buffer, cb?: Function): void; + end(str: string, cb?: Function): void; + end(str: string, encoding?: string, cb?: Function): void; + } + + export interface ReadWriteStream extends ReadableStream, WritableStream { + pause(): ReadWriteStream; + resume(): ReadWriteStream; + } + + export interface Events extends EventEmitter { } + + export interface Domain extends Events { + run(fn: Function): void; + add(emitter: Events): void; + remove(emitter: Events): void; + bind(cb: (err: Error, data: any) => any): any; + intercept(cb: (data: any) => any): any; + dispose(): void; + + addListener(event: string, listener: Function): this; + on(event: string, listener: Function): this; + once(event: string, listener: Function): this; + removeListener(event: string, listener: Function): this; + removeAllListeners(event?: string): this; + } + + export interface MemoryUsage { + rss: number; + heapTotal: number; + heapUsed: number; + } + + export interface ProcessVersions { + http_parser: string; + node: string; + v8: string; + ares: string; + uv: string; + zlib: string; + modules: string; + openssl: string; + } + + export interface Process extends EventEmitter { + stdout: WritableStream; + stderr: WritableStream; + stdin: ReadableStream; + argv: string[]; + execArgv: string[]; + execPath: string; + abort(): void; + chdir(directory: string): void; + cwd(): string; + env: any; + exit(code?: number): void; + exitCode: number; + getgid(): number; + setgid(id: number): void; + setgid(id: string): void; + getuid(): number; + setuid(id: number): void; + setuid(id: string): void; + version: string; + versions: ProcessVersions; + config: { + target_defaults: { + cflags: any[]; + default_configuration: string; + defines: string[]; + include_dirs: string[]; + libraries: string[]; + }; + variables: { + clang: number; + host_arch: string; + node_install_npm: boolean; + node_install_waf: boolean; + node_prefix: string; + node_shared_openssl: boolean; + node_shared_v8: boolean; + node_shared_zlib: boolean; + node_use_dtrace: boolean; + node_use_etw: boolean; + node_use_openssl: boolean; + target_arch: string; + v8_no_strict_aliasing: number; + v8_use_snapshot: boolean; + visibility: string; + }; + }; + kill(pid: number, signal?: string | number): void; + pid: number; + title: string; + arch: string; + platform: string; + memoryUsage(): MemoryUsage; + nextTick(callback: Function, ...args: any[]): void; + umask(mask?: number): number; + uptime(): number; + hrtime(time?: number[]): number[]; + domain: Domain; + + // Worker + send?(message: any, sendHandle?: any): void; + disconnect(): void; + connected: boolean; + } + + export interface Global { + Array: typeof Array; + ArrayBuffer: typeof ArrayBuffer; + Boolean: typeof Boolean; + Buffer: typeof Buffer; + DataView: typeof DataView; + Date: typeof Date; + Error: typeof Error; + EvalError: typeof EvalError; + Float32Array: typeof Float32Array; + Float64Array: typeof Float64Array; + Function: typeof Function; + GLOBAL: Global; + Infinity: typeof Infinity; + Int16Array: typeof Int16Array; + Int32Array: typeof Int32Array; + Int8Array: typeof Int8Array; + Intl: typeof Intl; + JSON: typeof JSON; + Map: MapConstructor; + Math: typeof Math; + NaN: typeof NaN; + Number: typeof Number; + Object: typeof Object; + Promise: Function; + RangeError: typeof RangeError; + ReferenceError: typeof ReferenceError; + RegExp: typeof RegExp; + Set: SetConstructor; + String: typeof String; + Symbol: Function; + SyntaxError: typeof SyntaxError; + TypeError: typeof TypeError; + URIError: typeof URIError; + Uint16Array: typeof Uint16Array; + Uint32Array: typeof Uint32Array; + Uint8Array: typeof Uint8Array; + Uint8ClampedArray: Function; + WeakMap: WeakMapConstructor; + WeakSet: WeakSetConstructor; + clearImmediate: (immediateId: any) => void; + clearInterval: (intervalId: NodeJS.Timer) => void; + clearTimeout: (timeoutId: NodeJS.Timer) => void; + console: typeof console; + decodeURI: typeof decodeURI; + decodeURIComponent: typeof decodeURIComponent; + encodeURI: typeof encodeURI; + encodeURIComponent: typeof encodeURIComponent; + escape: (str: string) => string; + eval: typeof eval; + global: Global; + isFinite: typeof isFinite; + isNaN: typeof isNaN; + parseFloat: typeof parseFloat; + parseInt: typeof parseInt; + process: Process; + root: Global; + setImmediate: (callback: (...args: any[]) => void, ...args: any[]) => any; + setInterval: (callback: (...args: any[]) => void, ms: number, ...args: any[]) => NodeJS.Timer; + setTimeout: (callback: (...args: any[]) => void, ms: number, ...args: any[]) => NodeJS.Timer; + undefined: typeof undefined; + unescape: (str: string) => string; + gc: () => void; + v8debug?: any; + } + + export interface Timer { + ref(): void; + unref(): void; + } +} + +interface IterableIterator { } + +/** + * @deprecated + */ +interface NodeBuffer extends Uint8Array { + write(string: string, offset?: number, length?: number, encoding?: string): number; + toString(encoding?: string, start?: number, end?: number): string; + toJSON(): {type: 'Buffer', data: any[]}; + equals(otherBuffer: Buffer): boolean; + compare(otherBuffer: Buffer, targetStart?: number, targetEnd?: number, sourceStart?: number, sourceEnd?: number): number; + copy(targetBuffer: Buffer, targetStart?: number, sourceStart?: number, sourceEnd?: number): number; + slice(start?: number, end?: number): Buffer; + writeUIntLE(value: number, offset: number, byteLength: number, noAssert?: boolean): number; + writeUIntBE(value: number, offset: number, byteLength: number, noAssert?: boolean): number; + writeIntLE(value: number, offset: number, byteLength: number, noAssert?: boolean): number; + writeIntBE(value: number, offset: number, byteLength: number, noAssert?: boolean): number; + readUIntLE(offset: number, byteLength: number, noAssert?: boolean): number; + readUIntBE(offset: number, byteLength: number, noAssert?: boolean): number; + readIntLE(offset: number, byteLength: number, noAssert?: boolean): number; + readIntBE(offset: number, byteLength: number, noAssert?: boolean): number; + readUInt8(offset: number, noAssert?: boolean): number; + readUInt16LE(offset: number, noAssert?: boolean): number; + readUInt16BE(offset: number, noAssert?: boolean): number; + readUInt32LE(offset: number, noAssert?: boolean): number; + readUInt32BE(offset: number, noAssert?: boolean): number; + readInt8(offset: number, noAssert?: boolean): number; + readInt16LE(offset: number, noAssert?: boolean): number; + readInt16BE(offset: number, noAssert?: boolean): number; + readInt32LE(offset: number, noAssert?: boolean): number; + readInt32BE(offset: number, noAssert?: boolean): number; + readFloatLE(offset: number, noAssert?: boolean): number; + readFloatBE(offset: number, noAssert?: boolean): number; + readDoubleLE(offset: number, noAssert?: boolean): number; + readDoubleBE(offset: number, noAssert?: boolean): number; + swap16(): Buffer; + swap32(): Buffer; + swap64(): Buffer; + writeUInt8(value: number, offset: number, noAssert?: boolean): number; + writeUInt16LE(value: number, offset: number, noAssert?: boolean): number; + writeUInt16BE(value: number, offset: number, noAssert?: boolean): number; + writeUInt32LE(value: number, offset: number, noAssert?: boolean): number; + writeUInt32BE(value: number, offset: number, noAssert?: boolean): number; + writeInt8(value: number, offset: number, noAssert?: boolean): number; + writeInt16LE(value: number, offset: number, noAssert?: boolean): number; + writeInt16BE(value: number, offset: number, noAssert?: boolean): number; + writeInt32LE(value: number, offset: number, noAssert?: boolean): number; + writeInt32BE(value: number, offset: number, noAssert?: boolean): number; + writeFloatLE(value: number, offset: number, noAssert?: boolean): number; + writeFloatBE(value: number, offset: number, noAssert?: boolean): number; + writeDoubleLE(value: number, offset: number, noAssert?: boolean): number; + writeDoubleBE(value: number, offset: number, noAssert?: boolean): number; + fill(value: any, offset?: number, end?: number): this; + indexOf(value: string | number | Buffer, byteOffset?: number, encoding?: string): number; + lastIndexOf(value: string | number | Buffer, byteOffset?: number, encoding?: string): number; + entries(): IterableIterator<[number, number]>; + includes(value: string | number | Buffer, byteOffset?: number, encoding?: string): boolean; + keys(): IterableIterator; + values(): IterableIterator; +} + +/************************************************ +* * +* MODULES * +* * +************************************************/ +declare module "buffer" { + export var INSPECT_MAX_BYTES: number; + var BuffType: typeof Buffer; + var SlowBuffType: typeof SlowBuffer; + export { BuffType as Buffer, SlowBuffType as SlowBuffer }; +} + +declare module "querystring" { + export interface StringifyOptions { + encodeURIComponent?: Function; + } + + export interface ParseOptions { + maxKeys?: number; + decodeURIComponent?: Function; + } + + export function stringify(obj: T, sep?: string, eq?: string, options?: StringifyOptions): string; + export function parse(str: string, sep?: string, eq?: string, options?: ParseOptions): any; + export function parse(str: string, sep?: string, eq?: string, options?: ParseOptions): T; + export function escape(str: string): string; + export function unescape(str: string): string; +} + +declare module "events" { + export class EventEmitter extends NodeJS.EventEmitter { + static EventEmitter: EventEmitter; + static listenerCount(emitter: EventEmitter, event: string|symbol): number; // deprecated + static defaultMaxListeners: number; + + addListener(event: string|symbol, listener: Function): this; + on(event: string|symbol, listener: Function): this; + once(event: string|symbol, listener: Function): this; + prependListener(event: string|symbol, listener: Function): this; + prependOnceListener(event: string|symbol, listener: Function): this; + removeListener(event: string|symbol, listener: Function): this; + removeAllListeners(event?: string|symbol): this; + setMaxListeners(n: number): this; + getMaxListeners(): number; + listeners(event: string|symbol): Function[]; + emit(event: string|symbol, ...args: any[]): boolean; + eventNames(): (string|symbol)[]; + listenerCount(type: string|symbol): number; + } +} + +declare module "http" { + import * as events from "events"; + import * as net from "net"; + import * as stream from "stream"; + + export interface RequestOptions { + protocol?: string; + host?: string; + hostname?: string; + family?: number; + port?: number; + localAddress?: string; + socketPath?: string; + method?: string; + path?: string; + headers?: { [key: string]: any }; + auth?: string; + agent?: Agent | boolean; + } + + export interface Server extends net.Server { + setTimeout(msecs: number, callback: Function): void; + maxHeadersCount: number; + timeout: number; + listening: boolean; + } + /** + * @deprecated Use IncomingMessage + */ + export interface ServerRequest extends IncomingMessage { + connection: net.Socket; + } + export interface ServerResponse extends stream.Writable { + // Extended base methods + write(buffer: Buffer): boolean; + write(buffer: Buffer, cb?: Function): boolean; + write(str: string, cb?: Function): boolean; + write(str: string, encoding?: string, cb?: Function): boolean; + write(str: string, encoding?: string, fd?: string): boolean; + + writeContinue(): void; + writeHead(statusCode: number, reasonPhrase?: string, headers?: any): void; + writeHead(statusCode: number, headers?: any): void; + statusCode: number; + statusMessage: string; + headersSent: boolean; + setHeader(name: string, value: string | string[]): void; + setTimeout(msecs: number, callback: Function): ServerResponse; + sendDate: boolean; + getHeader(name: string): string; + removeHeader(name: string): void; + write(chunk: any, encoding?: string): any; + addTrailers(headers: any): void; + finished: boolean; + + // Extended base methods + end(): void; + end(buffer: Buffer, cb?: Function): void; + end(str: string, cb?: Function): void; + end(str: string, encoding?: string, cb?: Function): void; + end(data?: any, encoding?: string): void; + } + export interface ClientRequest extends stream.Writable { + // Extended base methods + write(buffer: Buffer): boolean; + write(buffer: Buffer, cb?: Function): boolean; + write(str: string, cb?: Function): boolean; + write(str: string, encoding?: string, cb?: Function): boolean; + write(str: string, encoding?: string, fd?: string): boolean; + + write(chunk: any, encoding?: string): void; + abort(): void; + setTimeout(timeout: number, callback?: Function): void; + setNoDelay(noDelay?: boolean): void; + setSocketKeepAlive(enable?: boolean, initialDelay?: number): void; + + setHeader(name: string, value: string | string[]): void; + getHeader(name: string): string; + removeHeader(name: string): void; + addTrailers(headers: any): void; + + // Extended base methods + end(): void; + end(buffer: Buffer, cb?: Function): void; + end(str: string, cb?: Function): void; + end(str: string, encoding?: string, cb?: Function): void; + end(data?: any, encoding?: string): void; + } + export interface IncomingMessage extends stream.Readable { + httpVersion: string; + httpVersionMajor: string; + httpVersionMinor: string; + connection: net.Socket; + headers: any; + rawHeaders: string[]; + trailers: any; + rawTrailers: any; + setTimeout(msecs: number, callback: Function): NodeJS.Timer; + /** + * Only valid for request obtained from http.Server. + */ + method?: string; + /** + * Only valid for request obtained from http.Server. + */ + url?: string; + /** + * Only valid for response obtained from http.ClientRequest. + */ + statusCode?: number; + /** + * Only valid for response obtained from http.ClientRequest. + */ + statusMessage?: string; + socket: net.Socket; + destroy(error?: Error): void; + } + /** + * @deprecated Use IncomingMessage + */ + export interface ClientResponse extends IncomingMessage { } + + export interface AgentOptions { + /** + * Keep sockets around in a pool to be used by other requests in the future. Default = false + */ + keepAlive?: boolean; + /** + * When using HTTP KeepAlive, how often to send TCP KeepAlive packets over sockets being kept alive. Default = 1000. + * Only relevant if keepAlive is set to true. + */ + keepAliveMsecs?: number; + /** + * Maximum number of sockets to allow per host. Default for Node 0.10 is 5, default for Node 0.12 is Infinity + */ + maxSockets?: number; + /** + * Maximum number of sockets to leave open in a free state. Only relevant if keepAlive is set to true. Default = 256. + */ + maxFreeSockets?: number; + } + + export class Agent { + maxSockets: number; + sockets: any; + requests: any; + + constructor(opts?: AgentOptions); + + /** + * Destroy any sockets that are currently in use by the agent. + * It is usually not necessary to do this. However, if you are using an agent with KeepAlive enabled, + * then it is best to explicitly shut down the agent when you know that it will no longer be used. Otherwise, + * sockets may hang open for quite a long time before the server terminates them. + */ + destroy(): void; + } + + export var METHODS: string[]; + + export var STATUS_CODES: { + [errorCode: number]: string; + [errorCode: string]: string; + }; + export function createServer(requestListener?: (request: IncomingMessage, response: ServerResponse) => void): Server; + export function createClient(port?: number, host?: string): any; + export function request(options: RequestOptions, callback?: (res: IncomingMessage) => void): ClientRequest; + export function get(options: any, callback?: (res: IncomingMessage) => void): ClientRequest; + export var globalAgent: Agent; +} + +declare module "cluster" { + import * as child from "child_process"; + import * as events from "events"; + import * as net from "net"; + + // interfaces + export interface ClusterSettings { + execArgv?: string[]; // default: process.execArgv + exec?: string; + args?: string[]; + silent?: boolean; + stdio?: any[]; + uid?: number; + gid?: number; + } + + export interface ClusterSetupMasterSettings { + exec?: string; // default: process.argv[1] + args?: string[]; // default: process.argv.slice(2) + silent?: boolean; // default: false + stdio?: any[]; + } + + export interface Address { + address: string; + port: number; + addressType: number | "udp4" | "udp6"; // 4, 6, -1, "udp4", "udp6" + } + + export class Worker extends events.EventEmitter { + id: string; + process: child.ChildProcess; + suicide: boolean; + send(message: any, sendHandle?: any): boolean; + kill(signal?: string): void; + destroy(signal?: string): void; + disconnect(): void; + isConnected(): boolean; + isDead(): boolean; + exitedAfterDisconnect: boolean; + + /** + * events.EventEmitter + * 1. disconnect + * 2. error + * 3. exit + * 4. listening + * 5. message + * 6. online + */ + addListener(event: string, listener: Function): this; + addListener(event: "disconnect", listener: () => void): this; + addListener(event: "error", listener: (code: number, signal: string) => void): this; + addListener(event: "exit", listener: (code: number, signal: string) => void): this; + addListener(event: "listening", listener: (address: Address) => void): this; + addListener(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. + addListener(event: "online", listener: () => void): this; + + on(event: string, listener: Function): this; + on(event: "disconnect", listener: () => void): this; + on(event: "error", listener: (code: number, signal: string) => void): this; + on(event: "exit", listener: (code: number, signal: string) => void): this; + on(event: "listening", listener: (address: Address) => void): this; + on(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. + on(event: "online", listener: () => void): this; + + once(event: string, listener: Function): this; + once(event: "disconnect", listener: () => void): this; + once(event: "error", listener: (code: number, signal: string) => void): this; + once(event: "exit", listener: (code: number, signal: string) => void): this; + once(event: "listening", listener: (address: Address) => void): this; + once(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. + once(event: "online", listener: () => void): this; + + prependListener(event: string, listener: Function): this; + prependListener(event: "disconnect", listener: () => void): this; + prependListener(event: "error", listener: (code: number, signal: string) => void): this; + prependListener(event: "exit", listener: (code: number, signal: string) => void): this; + prependListener(event: "listening", listener: (address: Address) => void): this; + prependListener(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. + prependListener(event: "online", listener: () => void): this; + + prependOnceListener(event: string, listener: Function): this; + prependOnceListener(event: "disconnect", listener: () => void): this; + prependOnceListener(event: "error", listener: (code: number, signal: string) => void): this; + prependOnceListener(event: "exit", listener: (code: number, signal: string) => void): this; + prependOnceListener(event: "listening", listener: (address: Address) => void): this; + prependOnceListener(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. + prependOnceListener(event: "online", listener: () => void): this; + } + + export interface Cluster extends events.EventEmitter { + Worker: Worker; + disconnect(callback?: Function): void; + fork(env?: any): Worker; + isMaster: boolean; + isWorker: boolean; + // TODO: cluster.schedulingPolicy + settings: ClusterSettings; + setupMaster(settings?: ClusterSetupMasterSettings): void; + worker: Worker; + workers: { + [index: string]: Worker + }; + + /** + * events.EventEmitter + * 1. disconnect + * 2. exit + * 3. fork + * 4. listening + * 5. message + * 6. online + * 7. setup + */ + addListener(event: string, listener: Function): this; + addListener(event: "disconnect", listener: (worker: Worker) => void): this; + addListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): this; + addListener(event: "fork", listener: (worker: Worker) => void): this; + addListener(event: "listening", listener: (worker: Worker, address: Address) => void): this; + addListener(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. + addListener(event: "online", listener: (worker: Worker) => void): this; + addListener(event: "setup", listener: (settings: any) => void): this; + + on(event: string, listener: Function): this; + on(event: "disconnect", listener: (worker: Worker) => void): this; + on(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): this; + on(event: "fork", listener: (worker: Worker) => void): this; + on(event: "listening", listener: (worker: Worker, address: Address) => void): this; + on(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. + on(event: "online", listener: (worker: Worker) => void): this; + on(event: "setup", listener: (settings: any) => void): this; + + once(event: string, listener: Function): this; + once(event: "disconnect", listener: (worker: Worker) => void): this; + once(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): this; + once(event: "fork", listener: (worker: Worker) => void): this; + once(event: "listening", listener: (worker: Worker, address: Address) => void): this; + once(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. + once(event: "online", listener: (worker: Worker) => void): this; + once(event: "setup", listener: (settings: any) => void): this; + + prependListener(event: string, listener: Function): this; + prependListener(event: "disconnect", listener: (worker: Worker) => void): this; + prependListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): this; + prependListener(event: "fork", listener: (worker: Worker) => void): this; + prependListener(event: "listening", listener: (worker: Worker, address: Address) => void): this; + prependListener(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. + prependListener(event: "online", listener: (worker: Worker) => void): this; + prependListener(event: "setup", listener: (settings: any) => void): this; + + prependOnceListener(event: string, listener: Function): this; + prependOnceListener(event: "disconnect", listener: (worker: Worker) => void): this; + prependOnceListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): this; + prependOnceListener(event: "fork", listener: (worker: Worker) => void): this; + prependOnceListener(event: "listening", listener: (worker: Worker, address: Address) => void): this; + prependOnceListener(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. + prependOnceListener(event: "online", listener: (worker: Worker) => void): this; + prependOnceListener(event: "setup", listener: (settings: any) => void): this; + + } + + export function disconnect(callback ?: Function): void; + export function fork(env?: any): Worker; + export var isMaster: boolean; + export var isWorker: boolean; + // TODO: cluster.schedulingPolicy + export var settings: ClusterSettings; + export function setupMaster(settings?: ClusterSetupMasterSettings): void; + export var worker: Worker; + export var workers: { + [index: string]: Worker + }; + + /** + * events.EventEmitter + * 1. disconnect + * 2. exit + * 3. fork + * 4. listening + * 5. message + * 6. online + * 7. setup + */ + export function addListener(event: string, listener: Function): Cluster; + export function addListener(event: "disconnect", listener: (worker: Worker) => void): Cluster; + export function addListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): Cluster; + export function addListener(event: "fork", listener: (worker: Worker) => void): Cluster; + export function addListener(event: "listening", listener: (worker: Worker, address: Address) => void): Cluster; + export function addListener(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): Cluster; // the handle is a net.Socket or net.Server object, or undefined. + export function addListener(event: "online", listener: (worker: Worker) => void): Cluster; + export function addListener(event: "setup", listener: (settings: any) => void): Cluster; + + export function on(event: string, listener: Function): Cluster; + export function on(event: "disconnect", listener: (worker: Worker) => void): Cluster; + export function on(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): Cluster; + export function on(event: "fork", listener: (worker: Worker) => void): Cluster; + export function on(event: "listening", listener: (worker: Worker, address: Address) => void): Cluster; + export function on(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): Cluster; // the handle is a net.Socket or net.Server object, or undefined. + export function on(event: "online", listener: (worker: Worker) => void): Cluster; + export function on(event: "setup", listener: (settings: any) => void): Cluster; + + export function once(event: string, listener: Function): Cluster; + export function once(event: "disconnect", listener: (worker: Worker) => void): Cluster; + export function once(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): Cluster; + export function once(event: "fork", listener: (worker: Worker) => void): Cluster; + export function once(event: "listening", listener: (worker: Worker, address: Address) => void): Cluster; + export function once(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): Cluster; // the handle is a net.Socket or net.Server object, or undefined. + export function once(event: "online", listener: (worker: Worker) => void): Cluster; + export function once(event: "setup", listener: (settings: any) => void): Cluster; + + export function removeListener(event: string, listener: Function): Cluster; + export function removeAllListeners(event?: string): Cluster; + export function setMaxListeners(n: number): Cluster; + export function getMaxListeners(): number; + export function listeners(event: string): Function[]; + export function emit(event: string, ...args: any[]): boolean; + export function listenerCount(type: string): number; + + export function prependListener(event: string, listener: Function): Cluster; + export function prependListener(event: "disconnect", listener: (worker: Worker) => void): Cluster; + export function prependListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): Cluster; + export function prependListener(event: "fork", listener: (worker: Worker) => void): Cluster; + export function prependListener(event: "listening", listener: (worker: Worker, address: Address) => void): Cluster; + export function prependListener(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): Cluster; // the handle is a net.Socket or net.Server object, or undefined. + export function prependListener(event: "online", listener: (worker: Worker) => void): Cluster; + export function prependListener(event: "setup", listener: (settings: any) => void): Cluster; + + export function prependOnceListener(event: string, listener: Function): Cluster; + export function prependOnceListener(event: "disconnect", listener: (worker: Worker) => void): Cluster; + export function prependOnceListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): Cluster; + export function prependOnceListener(event: "fork", listener: (worker: Worker) => void): Cluster; + export function prependOnceListener(event: "listening", listener: (worker: Worker, address: Address) => void): Cluster; + export function prependOnceListener(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): Cluster; // the handle is a net.Socket or net.Server object, or undefined. + export function prependOnceListener(event: "online", listener: (worker: Worker) => void): Cluster; + export function prependOnceListener(event: "setup", listener: (settings: any) => void): Cluster; + + export function eventNames(): string[]; +} + +declare module "zlib" { + import * as stream from "stream"; + export interface ZlibOptions { chunkSize?: number; windowBits?: number; level?: number; memLevel?: number; strategy?: number; dictionary?: any; } + + export interface Gzip extends stream.Transform { } + export interface Gunzip extends stream.Transform { } + export interface Deflate extends stream.Transform { } + export interface Inflate extends stream.Transform { } + export interface DeflateRaw extends stream.Transform { } + export interface InflateRaw extends stream.Transform { } + export interface Unzip extends stream.Transform { } + + export function createGzip(options?: ZlibOptions): Gzip; + export function createGunzip(options?: ZlibOptions): Gunzip; + export function createDeflate(options?: ZlibOptions): Deflate; + export function createInflate(options?: ZlibOptions): Inflate; + export function createDeflateRaw(options?: ZlibOptions): DeflateRaw; + export function createInflateRaw(options?: ZlibOptions): InflateRaw; + export function createUnzip(options?: ZlibOptions): Unzip; + + export function deflate(buf: Buffer, callback: (error: Error, result: any) => void): void; + export function deflateSync(buf: Buffer, options?: ZlibOptions): any; + export function deflateRaw(buf: Buffer, callback: (error: Error, result: any) => void): void; + export function deflateRawSync(buf: Buffer, options?: ZlibOptions): any; + export function gzip(buf: Buffer, callback: (error: Error, result: any) => void): void; + export function gzipSync(buf: Buffer, options?: ZlibOptions): any; + export function gunzip(buf: Buffer, callback: (error: Error, result: any) => void): void; + export function gunzipSync(buf: Buffer, options?: ZlibOptions): any; + export function inflate(buf: Buffer, callback: (error: Error, result: any) => void): void; + export function inflateSync(buf: Buffer, options?: ZlibOptions): any; + export function inflateRaw(buf: Buffer, callback: (error: Error, result: any) => void): void; + export function inflateRawSync(buf: Buffer, options?: ZlibOptions): any; + export function unzip(buf: Buffer, callback: (error: Error, result: any) => void): void; + export function unzipSync(buf: Buffer, options?: ZlibOptions): any; + + // Constants + export var Z_NO_FLUSH: number; + export var Z_PARTIAL_FLUSH: number; + export var Z_SYNC_FLUSH: number; + export var Z_FULL_FLUSH: number; + export var Z_FINISH: number; + export var Z_BLOCK: number; + export var Z_TREES: number; + export var Z_OK: number; + export var Z_STREAM_END: number; + export var Z_NEED_DICT: number; + export var Z_ERRNO: number; + export var Z_STREAM_ERROR: number; + export var Z_DATA_ERROR: number; + export var Z_MEM_ERROR: number; + export var Z_BUF_ERROR: number; + export var Z_VERSION_ERROR: number; + export var Z_NO_COMPRESSION: number; + export var Z_BEST_SPEED: number; + export var Z_BEST_COMPRESSION: number; + export var Z_DEFAULT_COMPRESSION: number; + export var Z_FILTERED: number; + export var Z_HUFFMAN_ONLY: number; + export var Z_RLE: number; + export var Z_FIXED: number; + export var Z_DEFAULT_STRATEGY: number; + export var Z_BINARY: number; + export var Z_TEXT: number; + export var Z_ASCII: number; + export var Z_UNKNOWN: number; + export var Z_DEFLATED: number; + export var Z_NULL: number; +} + +declare module "os" { + export interface CpuInfo { + model: string; + speed: number; + times: { + user: number; + nice: number; + sys: number; + idle: number; + irq: number; + }; + } + + export interface NetworkInterfaceInfo { + address: string; + netmask: string; + family: string; + mac: string; + internal: boolean; + } + + export function hostname(): string; + export function loadavg(): number[]; + export function uptime(): number; + export function freemem(): number; + export function totalmem(): number; + export function cpus(): CpuInfo[]; + export function type(): string; + export function release(): string; + export function networkInterfaces(): { [index: string]: NetworkInterfaceInfo[] }; + export function homedir(): string; + export function userInfo(options?: { encoding: string }): { username: string, uid: number, gid: number, shell: any, homedir: string } + export var constants: { + UV_UDP_REUSEADDR: number, + errno: { + SIGHUP: number; + SIGINT: number; + SIGQUIT: number; + SIGILL: number; + SIGTRAP: number; + SIGABRT: number; + SIGIOT: number; + SIGBUS: number; + SIGFPE: number; + SIGKILL: number; + SIGUSR1: number; + SIGSEGV: number; + SIGUSR2: number; + SIGPIPE: number; + SIGALRM: number; + SIGTERM: number; + SIGCHLD: number; + SIGSTKFLT: number; + SIGCONT: number; + SIGSTOP: number; + SIGTSTP: number; + SIGTTIN: number; + SIGTTOU: number; + SIGURG: number; + SIGXCPU: number; + SIGXFSZ: number; + SIGVTALRM: number; + SIGPROF: number; + SIGWINCH: number; + SIGIO: number; + SIGPOLL: number; + SIGPWR: number; + SIGSYS: number; + SIGUNUSED: number; + }, + signals: { + E2BIG: number; + EACCES: number; + EADDRINUSE: number; + EADDRNOTAVAIL: number; + EAFNOSUPPORT: number; + EAGAIN: number; + EALREADY: number; + EBADF: number; + EBADMSG: number; + EBUSY: number; + ECANCELED: number; + ECHILD: number; + ECONNABORTED: number; + ECONNREFUSED: number; + ECONNRESET: number; + EDEADLK: number; + EDESTADDRREQ: number; + EDOM: number; + EDQUOT: number; + EEXIST: number; + EFAULT: number; + EFBIG: number; + EHOSTUNREACH: number; + EIDRM: number; + EILSEQ: number; + EINPROGRESS: number; + EINTR: number; + EINVAL: number; + EIO: number; + EISCONN: number; + EISDIR: number; + ELOOP: number; + EMFILE: number; + EMLINK: number; + EMSGSIZE: number; + EMULTIHOP: number; + ENAMETOOLONG: number; + ENETDOWN: number; + ENETRESET: number; + ENETUNREACH: number; + ENFILE: number; + ENOBUFS: number; + ENODATA: number; + ENODEV: number; + ENOENT: number; + ENOEXEC: number; + ENOLCK: number; + ENOLINK: number; + ENOMEM: number; + ENOMSG: number; + ENOPROTOOPT: number; + ENOSPC: number; + ENOSR: number; + ENOSTR: number; + ENOSYS: number; + ENOTCONN: number; + ENOTDIR: number; + ENOTEMPTY: number; + ENOTSOCK: number; + ENOTSUP: number; + ENOTTY: number; + ENXIO: number; + EOPNOTSUPP: number; + EOVERFLOW: number; + EPERM: number; + EPIPE: number; + EPROTO: number; + EPROTONOSUPPORT: number; + EPROTOTYPE: number; + ERANGE: number; + EROFS: number; + ESPIPE: number; + ESRCH: number; + ESTALE: number; + ETIME: number; + ETIMEDOUT: number; + ETXTBSY: number; + EWOULDBLOCK: number; + EXDEV: number; + }, + }; + export function arch(): string; + export function platform(): string; + export function tmpdir(): string; + export var EOL: string; + export function endianness(): "BE" | "LE"; +} + +declare module "https" { + import * as tls from "tls"; + import * as events from "events"; + import * as http from "http"; + + export interface ServerOptions { + pfx?: any; + key?: any; + passphrase?: string; + cert?: any; + ca?: any; + crl?: any; + ciphers?: string; + honorCipherOrder?: boolean; + requestCert?: boolean; + rejectUnauthorized?: boolean; + NPNProtocols?: any; + SNICallback?: (servername: string, cb: (err: Error, ctx: tls.SecureContext) => any) => any; + } + + export interface RequestOptions extends http.RequestOptions { + pfx?: any; + key?: any; + passphrase?: string; + cert?: any; + ca?: any; + ciphers?: string; + rejectUnauthorized?: boolean; + secureProtocol?: string; + } + + export interface Agent extends http.Agent { } + + export interface AgentOptions extends http.AgentOptions { + pfx?: any; + key?: any; + passphrase?: string; + cert?: any; + ca?: any; + ciphers?: string; + rejectUnauthorized?: boolean; + secureProtocol?: string; + maxCachedSessions?: number; + } + + export var Agent: { + new (options?: AgentOptions): Agent; + }; + export interface Server extends tls.Server { } + export function createServer(options: ServerOptions, requestListener?: Function): Server; + export function request(options: RequestOptions, callback?: (res: http.IncomingMessage) => void): http.ClientRequest; + export function get(options: RequestOptions, callback?: (res: http.IncomingMessage) => void): http.ClientRequest; + export var globalAgent: Agent; +} + +declare module "punycode" { + export function decode(string: string): string; + export function encode(string: string): string; + export function toUnicode(domain: string): string; + export function toASCII(domain: string): string; + export var ucs2: ucs2; + interface ucs2 { + decode(string: string): number[]; + encode(codePoints: number[]): string; + } + export var version: any; +} + +declare module "repl" { + import * as stream from "stream"; + import * as readline from "readline"; + + export interface ReplOptions { + prompt?: string; + input?: NodeJS.ReadableStream; + output?: NodeJS.WritableStream; + terminal?: boolean; + eval?: Function; + useColors?: boolean; + useGlobal?: boolean; + ignoreUndefined?: boolean; + writer?: Function; + completer?: Function; + replMode?: any; + breakEvalOnSigint?: any; + } + + export interface REPLServer extends readline.ReadLine { + defineCommand(keyword: string, cmd: Function | { help: string, action: Function }): void; + displayPrompt(preserveCursor?: boolean): void + } + + export function start(options: ReplOptions): REPLServer; +} + +declare module "readline" { + import * as events from "events"; + import * as stream from "stream"; + + export interface Key { + sequence?: string; + name?: string; + ctrl?: boolean; + meta?: boolean; + shift?: boolean; + } + + export interface ReadLine extends events.EventEmitter { + setPrompt(prompt: string): void; + prompt(preserveCursor?: boolean): void; + question(query: string, callback: (answer: string) => void): void; + pause(): ReadLine; + resume(): ReadLine; + close(): void; + write(data: string | Buffer, key?: Key): void; + } + + export interface Completer { + (line: string): CompleterResult; + (line: string, callback: (err: any, result: CompleterResult) => void): any; + } + + export interface CompleterResult { + completions: string[]; + line: string; + } + + export interface ReadLineOptions { + input: NodeJS.ReadableStream; + output?: NodeJS.WritableStream; + completer?: Completer; + terminal?: boolean; + historySize?: number; + } + + export function createInterface(input: NodeJS.ReadableStream, output?: NodeJS.WritableStream, completer?: Completer, terminal?: boolean): ReadLine; + export function createInterface(options: ReadLineOptions): ReadLine; + + export function cursorTo(stream: NodeJS.WritableStream, x: number, y: number): void; + export function moveCursor(stream: NodeJS.WritableStream, dx: number | string, dy: number | string): void; + export function clearLine(stream: NodeJS.WritableStream, dir: number): void; + export function clearScreenDown(stream: NodeJS.WritableStream): void; +} + +declare module "vm" { + export interface Context { } + export interface ScriptOptions { + filename?: string; + lineOffset?: number; + columnOffset?: number; + displayErrors?: boolean; + timeout?: number; + cachedData?: Buffer; + produceCachedData?: boolean; + } + export interface RunningScriptOptions { + filename?: string; + lineOffset?: number; + columnOffset?: number; + displayErrors?: boolean; + timeout?: number; + } + export class Script { + constructor(code: string, options?: ScriptOptions); + runInContext(contextifiedSandbox: Context, options?: RunningScriptOptions): any; + runInNewContext(sandbox?: Context, options?: RunningScriptOptions): any; + runInThisContext(options?: RunningScriptOptions): any; + } + export function createContext(sandbox?: Context): Context; + export function isContext(sandbox: Context): boolean; + export function runInContext(code: string, contextifiedSandbox: Context, options?: RunningScriptOptions): any; + export function runInDebugContext(code: string): any; + export function runInNewContext(code: string, sandbox?: Context, options?: RunningScriptOptions): any; + export function runInThisContext(code: string, options?: RunningScriptOptions): any; +} + +declare module "child_process" { + import * as events from "events"; + import * as stream from "stream"; + + export interface ChildProcess extends events.EventEmitter { + stdin: stream.Writable; + stdout: stream.Readable; + stderr: stream.Readable; + stdio: [stream.Writable, stream.Readable, stream.Readable]; + pid: number; + kill(signal?: string): void; + send(message: any, sendHandle?: any): boolean; + connected: boolean; + disconnect(): void; + unref(): void; + ref(): void; + } + + export interface SpawnOptions { + cwd?: string; + env?: any; + stdio?: any; + detached?: boolean; + uid?: number; + gid?: number; + shell?: boolean | string; + } + export function spawn(command: string, args?: string[], options?: SpawnOptions): ChildProcess; + + export interface ExecOptions { + cwd?: string; + env?: any; + shell?: string; + timeout?: number; + maxBuffer?: number; + killSignal?: string; + uid?: number; + gid?: number; + } + export interface ExecOptionsWithStringEncoding extends ExecOptions { + encoding: BufferEncoding; + } + export interface ExecOptionsWithBufferEncoding extends ExecOptions { + encoding: string; // specify `null`. + } + export function exec(command: string, callback?: (error: Error, stdout: string, stderr: string) => void): ChildProcess; + export function exec(command: string, options: ExecOptionsWithStringEncoding, callback?: (error: Error, stdout: string, stderr: string) => void): ChildProcess; + // usage. child_process.exec("tsc", {encoding: null as string}, (err, stdout, stderr) => {}); + export function exec(command: string, options: ExecOptionsWithBufferEncoding, callback?: (error: Error, stdout: Buffer, stderr: Buffer) => void): ChildProcess; + export function exec(command: string, options: ExecOptions, callback?: (error: Error, stdout: string, stderr: string) => void): ChildProcess; + + export interface ExecFileOptions { + cwd?: string; + env?: any; + timeout?: number; + maxBuffer?: number; + killSignal?: string; + uid?: number; + gid?: number; + } + export interface ExecFileOptionsWithStringEncoding extends ExecFileOptions { + encoding: BufferEncoding; + } + export interface ExecFileOptionsWithBufferEncoding extends ExecFileOptions { + encoding: string; // specify `null`. + } + export function execFile(file: string, callback?: (error: Error, stdout: string, stderr: string) => void): ChildProcess; + export function execFile(file: string, options?: ExecFileOptionsWithStringEncoding, callback?: (error: Error, stdout: string, stderr: string) => void): ChildProcess; + // usage. child_process.execFile("file.sh", {encoding: null as string}, (err, stdout, stderr) => {}); + export function execFile(file: string, options?: ExecFileOptionsWithBufferEncoding, callback?: (error: Error, stdout: Buffer, stderr: Buffer) => void): ChildProcess; + export function execFile(file: string, options?: ExecFileOptions, callback?: (error: Error, stdout: string, stderr: string) => void): ChildProcess; + export function execFile(file: string, args?: string[], callback?: (error: Error, stdout: string, stderr: string) => void): ChildProcess; + export function execFile(file: string, args?: string[], options?: ExecFileOptionsWithStringEncoding, callback?: (error: Error, stdout: string, stderr: string) => void): ChildProcess; + // usage. child_process.execFile("file.sh", ["foo"], {encoding: null as string}, (err, stdout, stderr) => {}); + export function execFile(file: string, args?: string[], options?: ExecFileOptionsWithBufferEncoding, callback?: (error: Error, stdout: Buffer, stderr: Buffer) => void): ChildProcess; + export function execFile(file: string, args?: string[], options?: ExecFileOptions, callback?: (error: Error, stdout: string, stderr: string) => void): ChildProcess; + + export interface ForkOptions { + cwd?: string; + env?: any; + execPath?: string; + execArgv?: string[]; + silent?: boolean; + uid?: number; + gid?: number; + } + export function fork(modulePath: string, args?: string[], options?: ForkOptions): ChildProcess; + + export interface SpawnSyncOptions { + cwd?: string; + input?: string | Buffer; + stdio?: any; + env?: any; + uid?: number; + gid?: number; + timeout?: number; + killSignal?: string; + maxBuffer?: number; + encoding?: string; + shell?: boolean | string; + } + export interface SpawnSyncOptionsWithStringEncoding extends SpawnSyncOptions { + encoding: BufferEncoding; + } + export interface SpawnSyncOptionsWithBufferEncoding extends SpawnSyncOptions { + encoding: string; // specify `null`. + } + export interface SpawnSyncReturns { + pid: number; + output: string[]; + stdout: T; + stderr: T; + status: number; + signal: string; + error: Error; + } + export function spawnSync(command: string): SpawnSyncReturns; + export function spawnSync(command: string, options?: SpawnSyncOptionsWithStringEncoding): SpawnSyncReturns; + export function spawnSync(command: string, options?: SpawnSyncOptionsWithBufferEncoding): SpawnSyncReturns; + export function spawnSync(command: string, options?: SpawnSyncOptions): SpawnSyncReturns; + export function spawnSync(command: string, args?: string[], options?: SpawnSyncOptionsWithStringEncoding): SpawnSyncReturns; + export function spawnSync(command: string, args?: string[], options?: SpawnSyncOptionsWithBufferEncoding): SpawnSyncReturns; + export function spawnSync(command: string, args?: string[], options?: SpawnSyncOptions): SpawnSyncReturns; + + export interface ExecSyncOptions { + cwd?: string; + input?: string | Buffer; + stdio?: any; + env?: any; + shell?: string; + uid?: number; + gid?: number; + timeout?: number; + killSignal?: string; + maxBuffer?: number; + encoding?: string; + } + export interface ExecSyncOptionsWithStringEncoding extends ExecSyncOptions { + encoding: BufferEncoding; + } + export interface ExecSyncOptionsWithBufferEncoding extends ExecSyncOptions { + encoding: string; // specify `null`. + } + export function execSync(command: string): Buffer; + export function execSync(command: string, options?: ExecSyncOptionsWithStringEncoding): string; + export function execSync(command: string, options?: ExecSyncOptionsWithBufferEncoding): Buffer; + export function execSync(command: string, options?: ExecSyncOptions): Buffer; + + export interface ExecFileSyncOptions { + cwd?: string; + input?: string | Buffer; + stdio?: any; + env?: any; + uid?: number; + gid?: number; + timeout?: number; + killSignal?: string; + maxBuffer?: number; + encoding?: string; + } + export interface ExecFileSyncOptionsWithStringEncoding extends ExecFileSyncOptions { + encoding: BufferEncoding; + } + export interface ExecFileSyncOptionsWithBufferEncoding extends ExecFileSyncOptions { + encoding: string; // specify `null`. + } + export function execFileSync(command: string): Buffer; + export function execFileSync(command: string, options?: ExecFileSyncOptionsWithStringEncoding): string; + export function execFileSync(command: string, options?: ExecFileSyncOptionsWithBufferEncoding): Buffer; + export function execFileSync(command: string, options?: ExecFileSyncOptions): Buffer; + export function execFileSync(command: string, args?: string[], options?: ExecFileSyncOptionsWithStringEncoding): string; + export function execFileSync(command: string, args?: string[], options?: ExecFileSyncOptionsWithBufferEncoding): Buffer; + export function execFileSync(command: string, args?: string[], options?: ExecFileSyncOptions): Buffer; +} + +declare module "url" { + export interface Url { + href?: string; + protocol?: string; + auth?: string; + hostname?: string; + port?: string; + host?: string; + pathname?: string; + search?: string; + query?: string | any; + slashes?: boolean; + hash?: string; + path?: string; + } + + export function parse(urlStr: string, parseQueryString?: boolean, slashesDenoteHost?: boolean): Url; + export function format(url: Url): string; + export function resolve(from: string, to: string): string; +} + +declare module "dns" { + export interface MxRecord { + exchange: string, + priority: number + } + + export function lookup(domain: string, family: number, callback: (err: Error, address: string, family: number) => void): string; + export function lookup(domain: string, callback: (err: Error, address: string, family: number) => void): string; + export function resolve(domain: string, rrtype: string, callback: (err: Error, addresses: string[]) => void): string[]; + export function resolve(domain: string, callback: (err: Error, addresses: string[]) => void): string[]; + export function resolve4(domain: string, callback: (err: Error, addresses: string[]) => void): string[]; + export function resolve6(domain: string, callback: (err: Error, addresses: string[]) => void): string[]; + export function resolveMx(domain: string, callback: (err: Error, addresses: MxRecord[]) =>void ): string[]; + export function resolveTxt(domain: string, callback: (err: Error, addresses: string[]) => void): string[]; + export function resolveSrv(domain: string, callback: (err: Error, addresses: string[]) => void): string[]; + export function resolveNs(domain: string, callback: (err: Error, addresses: string[]) => void): string[]; + export function resolveCname(domain: string, callback: (err: Error, addresses: string[]) => void): string[]; + export function reverse(ip: string, callback: (err: Error, domains: string[]) => void): string[]; + export function setServers(servers: string[]): void; + + //Error codes + export var NODATA: string; + export var FORMERR: string; + export var SERVFAIL: string; + export var NOTFOUND: string; + export var NOTIMP: string; + export var REFUSED: string; + export var BADQUERY: string; + export var BADNAME: string; + export var BADFAMILY: string; + export var BADRESP: string; + export var CONNREFUSED: string; + export var TIMEOUT: string; + export var EOF: string; + export var FILE: string; + export var NOMEM: string; + export var DESTRUCTION: string; + export var BADSTR: string; + export var BADFLAGS: string; + export var NONAME: string; + export var BADHINTS: string; + export var NOTINITIALIZED: string; + export var LOADIPHLPAPI: string; + export var ADDRGETNETWORKPARAMS: string; + export var CANCELLED: string; +} + +declare module "net" { + import * as stream from "stream"; + + export interface Socket extends stream.Duplex { + // Extended base methods + write(buffer: Buffer): boolean; + write(buffer: Buffer, cb?: Function): boolean; + write(str: string, cb?: Function): boolean; + write(str: string, encoding?: string, cb?: Function): boolean; + write(str: string, encoding?: string, fd?: string): boolean; + + connect(port: number, host?: string, connectionListener?: Function): void; + connect(path: string, connectionListener?: Function): void; + bufferSize: number; + setEncoding(encoding?: string): void; + write(data: any, encoding?: string, callback?: Function): void; + destroy(): void; + pause(): Socket; + resume(): Socket; + setTimeout(timeout: number, callback?: Function): void; + setNoDelay(noDelay?: boolean): void; + setKeepAlive(enable?: boolean, initialDelay?: number): void; + address(): { port: number; family: string; address: string; }; + unref(): void; + ref(): void; + + remoteAddress: string; + remoteFamily: string; + remotePort: number; + localAddress: string; + localPort: number; + bytesRead: number; + bytesWritten: number; + + // Extended base methods + end(): void; + end(buffer: Buffer, cb?: Function): void; + end(str: string, cb?: Function): void; + end(str: string, encoding?: string, cb?: Function): void; + end(data?: any, encoding?: string): void; + } + + export var Socket: { + new (options?: { fd?: string; type?: string; allowHalfOpen?: boolean; }): Socket; + }; + + export interface ListenOptions { + port?: number; + host?: string; + backlog?: number; + path?: string; + exclusive?: boolean; + } + + export interface Server extends Socket { + listen(port: number, hostname?: string, backlog?: number, listeningListener?: Function): Server; + listen(port: number, hostname?: string, listeningListener?: Function): Server; + listen(port: number, backlog?: number, listeningListener?: Function): Server; + listen(port: number, listeningListener?: Function): Server; + listen(path: string, backlog?: number, listeningListener?: Function): Server; + listen(path: string, listeningListener?: Function): Server; + listen(handle: any, backlog?: number, listeningListener?: Function): Server; + listen(handle: any, listeningListener?: Function): Server; + listen(options: ListenOptions, listeningListener?: Function): Server; + close(callback?: Function): Server; + address(): { port: number; family: string; address: string; }; + getConnections(cb: (error: Error, count: number) => void): void; + ref(): Server; + unref(): Server; + maxConnections: number; + connections: number; + } + export function createServer(connectionListener?: (socket: Socket) => void): Server; + export function createServer(options?: { allowHalfOpen?: boolean; }, connectionListener?: (socket: Socket) => void): Server; + export function connect(options: { port: number, host?: string, localAddress?: string, localPort?: string, family?: number, allowHalfOpen?: boolean; }, connectionListener?: Function): Socket; + export function connect(port: number, host?: string, connectionListener?: Function): Socket; + export function connect(path: string, connectionListener?: Function): Socket; + export function createConnection(options: { port: number, host?: string, localAddress?: string, localPort?: string, family?: number, allowHalfOpen?: boolean; }, connectionListener?: Function): Socket; + export function createConnection(port: number, host?: string, connectionListener?: Function): Socket; + export function createConnection(path: string, connectionListener?: Function): Socket; + export function isIP(input: string): number; + export function isIPv4(input: string): boolean; + export function isIPv6(input: string): boolean; +} + +declare module "dgram" { + import * as events from "events"; + + interface RemoteInfo { + address: string; + port: number; + size: number; + } + + interface AddressInfo { + address: string; + family: string; + port: number; + } + + interface BindOptions { + port: number; + address?: string; + exclusive?: boolean; + } + + interface SocketOptions { + type: "udp4" | "udp6"; + reuseAddr?: boolean; + } + + export function createSocket(type: string, callback?: (msg: Buffer, rinfo: RemoteInfo) => void): Socket; + export function createSocket(options: SocketOptions, callback?: (msg: Buffer, rinfo: RemoteInfo) => void): Socket; + + export interface Socket extends events.EventEmitter { + send(msg: Buffer | String | any[], port: number, address: string, callback?: (error: Error, bytes: number) => void): void; + send(msg: Buffer | String | any[], offset: number, length: number, port: number, address: string, callback?: (error: Error, bytes: number) => void): void; + bind(port?: number, address?: string, callback?: () => void): void; + bind(options: BindOptions, callback?: Function): void; + close(callback?: any): void; + address(): AddressInfo; + setBroadcast(flag: boolean): void; + setTTL(ttl: number): void; + setMulticastTTL(ttl: number): void; + setMulticastLoopback(flag: boolean): void; + addMembership(multicastAddress: string, multicastInterface?: string): void; + dropMembership(multicastAddress: string, multicastInterface?: string): void; + ref(): void; + unref(): void; + } +} + +declare module "fs" { + import * as stream from "stream"; + import * as events from "events"; + + interface Stats { + isFile(): boolean; + isDirectory(): boolean; + isBlockDevice(): boolean; + isCharacterDevice(): boolean; + isSymbolicLink(): boolean; + isFIFO(): boolean; + isSocket(): boolean; + dev: number; + ino: number; + mode: number; + nlink: number; + uid: number; + gid: number; + rdev: number; + size: number; + blksize: number; + blocks: number; + atime: Date; + mtime: Date; + ctime: Date; + birthtime: Date; + } + + interface FSWatcher extends events.EventEmitter { + close(): void; + + /** + * events.EventEmitter + * 1. change + * 2. error + */ + addListener(event: string, listener: Function): this; + addListener(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this; + addListener(event: "error", listener: (code: number, signal: string) => void): this; + + on(event: string, listener: Function): this; + on(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this; + on(event: "error", listener: (code: number, signal: string) => void): this; + + once(event: string, listener: Function): this; + once(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this; + once(event: "error", listener: (code: number, signal: string) => void): this; + + prependListener(event: string, listener: Function): this; + prependListener(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this; + prependListener(event: "error", listener: (code: number, signal: string) => void): this; + + prependOnceListener(event: string, listener: Function): this; + prependOnceListener(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this; + prependOnceListener(event: "error", listener: (code: number, signal: string) => void): this; + } + + export interface ReadStream extends stream.Readable { + close(): void; + destroy(): void; + + /** + * events.EventEmitter + * 1. open + * 2. close + */ + addListener(event: string, listener: Function): this; + addListener(event: "open", listener: (fd: number) => void): this; + addListener(event: "close", listener: () => void): this; + + on(event: string, listener: Function): this; + on(event: "open", listener: (fd: number) => void): this; + on(event: "close", listener: () => void): this; + + once(event: string, listener: Function): this; + once(event: "open", listener: (fd: number) => void): this; + once(event: "close", listener: () => void): this; + + prependListener(event: string, listener: Function): this; + prependListener(event: "open", listener: (fd: number) => void): this; + prependListener(event: "close", listener: () => void): this; + + prependOnceListener(event: string, listener: Function): this; + prependOnceListener(event: "open", listener: (fd: number) => void): this; + prependOnceListener(event: "close", listener: () => void): this; + } + + export interface WriteStream extends stream.Writable { + close(): void; + bytesWritten: number; + path: string | Buffer; + + /** + * events.EventEmitter + * 1. open + * 2. close + */ + addListener(event: string, listener: Function): this; + addListener(event: "open", listener: (fd: number) => void): this; + addListener(event: "close", listener: () => void): this; + + on(event: string, listener: Function): this; + on(event: "open", listener: (fd: number) => void): this; + on(event: "close", listener: () => void): this; + + once(event: string, listener: Function): this; + once(event: "open", listener: (fd: number) => void): this; + once(event: "close", listener: () => void): this; + + prependListener(event: string, listener: Function): this; + prependListener(event: "open", listener: (fd: number) => void): this; + prependListener(event: "close", listener: () => void): this; + + prependOnceListener(event: string, listener: Function): this; + prependOnceListener(event: "open", listener: (fd: number) => void): this; + prependOnceListener(event: "close", listener: () => void): this; + } + + /** + * Asynchronous rename. + * @param oldPath + * @param newPath + * @param callback No arguments other than a possible exception are given to the completion callback. + */ + export function rename(oldPath: string, newPath: string, callback?: (err?: NodeJS.ErrnoException) => void): void; + /** + * Synchronous rename + * @param oldPath + * @param newPath + */ + export function renameSync(oldPath: string, newPath: string): void; + export function truncate(path: string | Buffer, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function truncate(path: string | Buffer, len: number, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function truncateSync(path: string | Buffer, len?: number): void; + export function ftruncate(fd: number, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function ftruncate(fd: number, len: number, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function ftruncateSync(fd: number, len?: number): void; + export function chown(path: string | Buffer, uid: number, gid: number, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function chownSync(path: string | Buffer, uid: number, gid: number): void; + export function fchown(fd: number, uid: number, gid: number, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function fchownSync(fd: number, uid: number, gid: number): void; + export function lchown(path: string | Buffer, uid: number, gid: number, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function lchownSync(path: string | Buffer, uid: number, gid: number): void; + export function chmod(path: string | Buffer, mode: number, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function chmod(path: string | Buffer, mode: string, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function chmodSync(path: string | Buffer, mode: number): void; + export function chmodSync(path: string | Buffer, mode: string): void; + export function fchmod(fd: number, mode: number, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function fchmod(fd: number, mode: string, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function fchmodSync(fd: number, mode: number): void; + export function fchmodSync(fd: number, mode: string): void; + export function lchmod(path: string | Buffer, mode: number, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function lchmod(path: string | Buffer, mode: string, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function lchmodSync(path: string | Buffer, mode: number): void; + export function lchmodSync(path: string | Buffer, mode: string): void; + export function stat(path: string | Buffer, callback?: (err: NodeJS.ErrnoException, stats: Stats) => any): void; + export function lstat(path: string | Buffer, callback?: (err: NodeJS.ErrnoException, stats: Stats) => any): void; + export function fstat(fd: number, callback?: (err: NodeJS.ErrnoException, stats: Stats) => any): void; + export function statSync(path: string | Buffer): Stats; + export function lstatSync(path: string | Buffer): Stats; + export function fstatSync(fd: number): Stats; + export function link(srcpath: string | Buffer, dstpath: string | Buffer, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function linkSync(srcpath: string | Buffer, dstpath: string | Buffer): void; + export function symlink(srcpath: string | Buffer, dstpath: string | Buffer, type?: string, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function symlinkSync(srcpath: string | Buffer, dstpath: string | Buffer, type?: string): void; + export function readlink(path: string | Buffer, callback?: (err: NodeJS.ErrnoException, linkString: string) => any): void; + export function readlinkSync(path: string | Buffer): string; + export function realpath(path: string | Buffer, callback?: (err: NodeJS.ErrnoException, resolvedPath: string) => any): void; + export function realpath(path: string | Buffer, cache: { [path: string]: string }, callback: (err: NodeJS.ErrnoException, resolvedPath: string) => any): void; + export function realpathSync(path: string | Buffer, cache?: { [path: string]: string }): string; + /* + * Asynchronous unlink - deletes the file specified in {path} + * + * @param path + * @param callback No arguments other than a possible exception are given to the completion callback. + */ + export function unlink(path: string | Buffer, callback?: (err?: NodeJS.ErrnoException) => void): void; + /* + * Synchronous unlink - deletes the file specified in {path} + * + * @param path + */ + export function unlinkSync(path: string | Buffer): void; + /* + * Asynchronous rmdir - removes the directory specified in {path} + * + * @param path + * @param callback No arguments other than a possible exception are given to the completion callback. + */ + export function rmdir(path: string | Buffer, callback?: (err?: NodeJS.ErrnoException) => void): void; + /* + * Synchronous rmdir - removes the directory specified in {path} + * + * @param path + */ + export function rmdirSync(path: string | Buffer): void; + /* + * Asynchronous mkdir - creates the directory specified in {path}. Parameter {mode} defaults to 0777. + * + * @param path + * @param callback No arguments other than a possible exception are given to the completion callback. + */ + export function mkdir(path: string | Buffer, callback?: (err?: NodeJS.ErrnoException) => void): void; + /* + * Asynchronous mkdir - creates the directory specified in {path}. Parameter {mode} defaults to 0777. + * + * @param path + * @param mode + * @param callback No arguments other than a possible exception are given to the completion callback. + */ + export function mkdir(path: string | Buffer, mode: number, callback?: (err?: NodeJS.ErrnoException) => void): void; + /* + * Asynchronous mkdir - creates the directory specified in {path}. Parameter {mode} defaults to 0777. + * + * @param path + * @param mode + * @param callback No arguments other than a possible exception are given to the completion callback. + */ + export function mkdir(path: string | Buffer, mode: string, callback?: (err?: NodeJS.ErrnoException) => void): void; + /* + * Synchronous mkdir - creates the directory specified in {path}. Parameter {mode} defaults to 0777. + * + * @param path + * @param mode + * @param callback No arguments other than a possible exception are given to the completion callback. + */ + export function mkdirSync(path: string | Buffer, mode?: number): void; + /* + * Synchronous mkdir - creates the directory specified in {path}. Parameter {mode} defaults to 0777. + * + * @param path + * @param mode + * @param callback No arguments other than a possible exception are given to the completion callback. + */ + export function mkdirSync(path: string | Buffer, mode?: string): void; + /* + * Asynchronous mkdtemp - Creates a unique temporary directory. Generates six random characters to be appended behind a required prefix to create a unique temporary directory. + * + * @param prefix + * @param callback The created folder path is passed as a string to the callback's second parameter. + */ + export function mkdtemp(prefix: string, callback?: (err: NodeJS.ErrnoException, folder: string) => void): void; + /* + * Synchronous mkdtemp - Creates a unique temporary directory. Generates six random characters to be appended behind a required prefix to create a unique temporary directory. + * + * @param prefix + * @returns Returns the created folder path. + */ + export function mkdtempSync(prefix: string): string; + export function readdir(path: string | Buffer, callback?: (err: NodeJS.ErrnoException, files: string[]) => void): void; + export function readdirSync(path: string | Buffer): string[]; + export function close(fd: number, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function closeSync(fd: number): void; + export function open(path: string | Buffer, flags: string | number, callback: (err: NodeJS.ErrnoException, fd: number) => void): void; + export function open(path: string | Buffer, flags: string | number, mode: number, callback: (err: NodeJS.ErrnoException, fd: number) => void): void; + export function openSync(path: string | Buffer, flags: string | number, mode?: number): number; + export function utimes(path: string | Buffer, atime: number, mtime: number, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function utimes(path: string | Buffer, atime: Date, mtime: Date, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function utimesSync(path: string | Buffer, atime: number, mtime: number): void; + export function utimesSync(path: string | Buffer, atime: Date, mtime: Date): void; + export function futimes(fd: number, atime: number, mtime: number, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function futimes(fd: number, atime: Date, mtime: Date, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function futimesSync(fd: number, atime: number, mtime: number): void; + export function futimesSync(fd: number, atime: Date, mtime: Date): void; + export function fsync(fd: number, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function fsyncSync(fd: number): void; + export function write(fd: number, buffer: Buffer, offset: number, length: number, position: number, callback?: (err: NodeJS.ErrnoException, written: number, buffer: Buffer) => void): void; + export function write(fd: number, buffer: Buffer, offset: number, length: number, callback?: (err: NodeJS.ErrnoException, written: number, buffer: Buffer) => void): void; + export function write(fd: number, data: any, callback?: (err: NodeJS.ErrnoException, written: number, str: string) => void): void; + export function write(fd: number, data: any, offset: number, callback?: (err: NodeJS.ErrnoException, written: number, str: string) => void): void; + export function write(fd: number, data: any, offset: number, encoding: string, callback?: (err: NodeJS.ErrnoException, written: number, str: string) => void): void; + export function writeSync(fd: number, buffer: Buffer, offset: number, length: number, position?: number): number; + export function writeSync(fd: number, data: any, position?: number, enconding?: string): number; + export function read(fd: number, buffer: Buffer, offset: number, length: number, position: number, callback?: (err: NodeJS.ErrnoException, bytesRead: number, buffer: Buffer) => void): void; + export function readSync(fd: number, buffer: Buffer, offset: number, length: number, position: number): number; + /* + * Asynchronous readFile - Asynchronously reads the entire contents of a file. + * + * @param fileName + * @param encoding + * @param callback - The callback is passed two arguments (err, data), where data is the contents of the file. + */ + export function readFile(filename: string, encoding: string, callback: (err: NodeJS.ErrnoException, data: string) => void): void; + /* + * Asynchronous readFile - Asynchronously reads the entire contents of a file. + * + * @param fileName + * @param options An object with optional {encoding} and {flag} properties. If {encoding} is specified, readFile returns a string; otherwise it returns a Buffer. + * @param callback - The callback is passed two arguments (err, data), where data is the contents of the file. + */ + export function readFile(filename: string, options: { encoding: string; flag?: string; }, callback: (err: NodeJS.ErrnoException, data: string) => void): void; + /* + * Asynchronous readFile - Asynchronously reads the entire contents of a file. + * + * @param fileName + * @param options An object with optional {encoding} and {flag} properties. If {encoding} is specified, readFile returns a string; otherwise it returns a Buffer. + * @param callback - The callback is passed two arguments (err, data), where data is the contents of the file. + */ + export function readFile(filename: string, options: { flag?: string; }, callback: (err: NodeJS.ErrnoException, data: Buffer) => void): void; + /* + * Asynchronous readFile - Asynchronously reads the entire contents of a file. + * + * @param fileName + * @param callback - The callback is passed two arguments (err, data), where data is the contents of the file. + */ + export function readFile(filename: string, callback: (err: NodeJS.ErrnoException, data: Buffer) => void): void; + /* + * Synchronous readFile - Synchronously reads the entire contents of a file. + * + * @param fileName + * @param encoding + */ + export function readFileSync(filename: string, encoding: string): string; + /* + * Synchronous readFile - Synchronously reads the entire contents of a file. + * + * @param fileName + * @param options An object with optional {encoding} and {flag} properties. If {encoding} is specified, readFileSync returns a string; otherwise it returns a Buffer. + */ + export function readFileSync(filename: string, options: { encoding: string; flag?: string; }): string; + /* + * Synchronous readFile - Synchronously reads the entire contents of a file. + * + * @param fileName + * @param options An object with optional {encoding} and {flag} properties. If {encoding} is specified, readFileSync returns a string; otherwise it returns a Buffer. + */ + export function readFileSync(filename: string, options?: { flag?: string; }): Buffer; + export function writeFile(filename: string, data: any, callback?: (err: NodeJS.ErrnoException) => void): void; + export function writeFile(filename: string, data: any, options: { encoding?: string; mode?: number; flag?: string; }, callback?: (err: NodeJS.ErrnoException) => void): void; + export function writeFile(filename: string, data: any, options: { encoding?: string; mode?: string; flag?: string; }, callback?: (err: NodeJS.ErrnoException) => void): void; + export function writeFileSync(filename: string, data: any, options?: { encoding?: string; mode?: number; flag?: string; }): void; + export function writeFileSync(filename: string, data: any, options?: { encoding?: string; mode?: string; flag?: string; }): void; + export function appendFile(filename: string, data: any, options: { encoding?: string; mode?: number; flag?: string; }, callback?: (err: NodeJS.ErrnoException) => void): void; + export function appendFile(filename: string, data: any, options: { encoding?: string; mode?: string; flag?: string; }, callback?: (err: NodeJS.ErrnoException) => void): void; + export function appendFile(filename: string, data: any, callback?: (err: NodeJS.ErrnoException) => void): void; + export function appendFileSync(filename: string, data: any, options?: { encoding?: string; mode?: number; flag?: string; }): void; + export function appendFileSync(filename: string, data: any, options?: { encoding?: string; mode?: string; flag?: string; }): void; + export function watchFile(filename: string, listener: (curr: Stats, prev: Stats) => void): void; + export function watchFile(filename: string, options: { persistent?: boolean; interval?: number; }, listener: (curr: Stats, prev: Stats) => void): void; + export function unwatchFile(filename: string, listener?: (curr: Stats, prev: Stats) => void): void; + export function watch(filename: string, listener?: (event: string, filename: string) => any): FSWatcher; + export function watch(filename: string, encoding: string, listener?: (event: string, filename: string | Buffer) => any): FSWatcher; + export function watch(filename: string, options: { persistent?: boolean; recursive?: boolean; encoding?: string }, listener?: (event: string, filename: string | Buffer) => any): FSWatcher; + export function exists(path: string | Buffer, callback?: (exists: boolean) => void): void; + export function existsSync(path: string | Buffer): boolean; + + interface Constants { + /** Constant for fs.access(). File is visible to the calling process. */ + F_OK: number; + + /** Constant for fs.access(). File can be read by the calling process. */ + R_OK: number; + + /** Constant for fs.access(). File can be written by the calling process. */ + W_OK: number; + + /** Constant for fs.access(). File can be executed by the calling process. */ + X_OK: number; + } + + export const constants: Constants; + + /** Tests a user's permissions for the file specified by path. */ + export function access(path: string | Buffer, callback: (err: NodeJS.ErrnoException) => void): void; + export function access(path: string | Buffer, mode: number, callback: (err: NodeJS.ErrnoException) => void): void; + /** Synchronous version of fs.access. This throws if any accessibility checks fail, and does nothing otherwise. */ + export function accessSync(path: string | Buffer, mode?: number): void; + export function createReadStream(path: string | Buffer, options?: { + flags?: string; + encoding?: string; + fd?: number; + mode?: number; + autoClose?: boolean; + start?: number; + end?: number; + }): ReadStream; + export function createWriteStream(path: string | Buffer, options?: { + flags?: string; + encoding?: string; + fd?: number; + mode?: number; + }): WriteStream; + export function fdatasync(fd: number, callback: Function): void; + export function fdatasyncSync(fd: number): void; +} + +declare module "path" { + + /** + * A parsed path object generated by path.parse() or consumed by path.format(). + */ + export interface ParsedPath { + /** + * The root of the path such as '/' or 'c:\' + */ + root: string; + /** + * The full directory path such as '/home/user/dir' or 'c:\path\dir' + */ + dir: string; + /** + * The file name including extension (if any) such as 'index.html' + */ + base: string; + /** + * The file extension (if any) such as '.html' + */ + ext: string; + /** + * The file name without extension (if any) such as 'index' + */ + name: string; + } + + /** + * Normalize a string path, reducing '..' and '.' parts. + * When multiple slashes are found, they're replaced by a single one; when the path contains a trailing slash, it is preserved. On Windows backslashes are used. + * + * @param p string path to normalize. + */ + export function normalize(p: string): string; + /** + * Join all arguments together and normalize the resulting path. + * Arguments must be strings. In v0.8, non-string arguments were silently ignored. In v0.10 and up, an exception is thrown. + * + * @param paths string paths to join. + */ + export function join(...paths: any[]): string; + /** + * Join all arguments together and normalize the resulting path. + * Arguments must be strings. In v0.8, non-string arguments were silently ignored. In v0.10 and up, an exception is thrown. + * + * @param paths string paths to join. + */ + export function join(...paths: string[]): string; + /** + * The right-most parameter is considered {to}. Other parameters are considered an array of {from}. + * + * Starting from leftmost {from} paramter, resolves {to} to an absolute path. + * + * If {to} isn't already absolute, {from} arguments are prepended in right to left order, until an absolute path is found. If after using all {from} paths still no absolute path is found, the current working directory is used as well. The resulting path is normalized, and trailing slashes are removed unless the path gets resolved to the root directory. + * + * @param pathSegments string paths to join. Non-string arguments are ignored. + */ + export function resolve(...pathSegments: any[]): string; + /** + * Determines whether {path} is an absolute path. An absolute path will always resolve to the same location, regardless of the working directory. + * + * @param path path to test. + */ + export function isAbsolute(path: string): boolean; + /** + * Solve the relative path from {from} to {to}. + * At times we have two absolute paths, and we need to derive the relative path from one to the other. This is actually the reverse transform of path.resolve. + * + * @param from + * @param to + */ + export function relative(from: string, to: string): string; + /** + * Return the directory name of a path. Similar to the Unix dirname command. + * + * @param p the path to evaluate. + */ + export function dirname(p: string): string; + /** + * Return the last portion of a path. Similar to the Unix basename command. + * Often used to extract the file name from a fully qualified path. + * + * @param p the path to evaluate. + * @param ext optionally, an extension to remove from the result. + */ + export function basename(p: string, ext?: string): string; + /** + * Return the extension of the path, from the last '.' to end of string in the last portion of the path. + * If there is no '.' in the last portion of the path or the first character of it is '.', then it returns an empty string + * + * @param p the path to evaluate. + */ + export function extname(p: string): string; + /** + * The platform-specific file separator. '\\' or '/'. + */ + export var sep: string; + /** + * The platform-specific file delimiter. ';' or ':'. + */ + export var delimiter: string; + /** + * Returns an object from a path string - the opposite of format(). + * + * @param pathString path to evaluate. + */ + export function parse(pathString: string): ParsedPath; + /** + * Returns a path string from an object - the opposite of parse(). + * + * @param pathString path to evaluate. + */ + export function format(pathObject: ParsedPath): string; + + export module posix { + export function normalize(p: string): string; + export function join(...paths: any[]): string; + export function resolve(...pathSegments: any[]): string; + export function isAbsolute(p: string): boolean; + export function relative(from: string, to: string): string; + export function dirname(p: string): string; + export function basename(p: string, ext?: string): string; + export function extname(p: string): string; + export var sep: string; + export var delimiter: string; + export function parse(p: string): ParsedPath; + export function format(pP: ParsedPath): string; + } + + export module win32 { + export function normalize(p: string): string; + export function join(...paths: any[]): string; + export function resolve(...pathSegments: any[]): string; + export function isAbsolute(p: string): boolean; + export function relative(from: string, to: string): string; + export function dirname(p: string): string; + export function basename(p: string, ext?: string): string; + export function extname(p: string): string; + export var sep: string; + export var delimiter: string; + export function parse(p: string): ParsedPath; + export function format(pP: ParsedPath): string; + } +} + +declare module "string_decoder" { + export interface NodeStringDecoder { + write(buffer: Buffer): string; + end(buffer?: Buffer): string; + } + export var StringDecoder: { + new (encoding?: string): NodeStringDecoder; + }; +} + +declare module "tls" { + import * as crypto from "crypto"; + import * as net from "net"; + import * as stream from "stream"; + + var CLIENT_RENEG_LIMIT: number; + var CLIENT_RENEG_WINDOW: number; + + export interface Certificate { + /** + * Country code. + */ + C: string; + /** + * Street. + */ + ST: string; + /** + * Locality. + */ + L: string; + /** + * Organization. + */ + O: string; + /** + * Organizational unit. + */ + OU: string; + /** + * Common name. + */ + CN: string; + } + + export interface CipherNameAndProtocol { + /** + * The cipher name. + */ + name: string; + /** + * SSL/TLS protocol version. + */ + version: string; + } + + export class TLSSocket extends stream.Duplex { + /** + * Returns the bound address, the address family name and port of the underlying socket as reported by + * the operating system. + * @returns {any} - An object with three properties, e.g. { port: 12346, family: 'IPv4', address: '127.0.0.1' }. + */ + address(): { port: number; family: string; address: string }; + /** + * A boolean that is true if the peer certificate was signed by one of the specified CAs, otherwise false. + */ + authorized: boolean; + /** + * The reason why the peer's certificate has not been verified. + * This property becomes available only when tlsSocket.authorized === false. + */ + authorizationError: Error; + /** + * Static boolean value, always true. + * May be used to distinguish TLS sockets from regular ones. + */ + encrypted: boolean; + /** + * Returns an object representing the cipher name and the SSL/TLS protocol version of the current connection. + * @returns {CipherNameAndProtocol} - Returns an object representing the cipher name + * and the SSL/TLS protocol version of the current connection. + */ + getCipher(): CipherNameAndProtocol; + /** + * Returns an object representing the peer's certificate. + * The returned object has some properties corresponding to the field of the certificate. + * If detailed argument is true the full chain with issuer property will be returned, + * if false only the top certificate without issuer property. + * If the peer does not provide a certificate, it returns null or an empty object. + * @param {boolean} detailed - If true; the full chain with issuer property will be returned. + * @returns {any} - An object representing the peer's certificate. + */ + getPeerCertificate(detailed?: boolean): { + subject: Certificate; + issuerInfo: Certificate; + issuer: Certificate; + raw: any; + valid_from: string; + valid_to: string; + fingerprint: string; + serialNumber: string; + }; + /** + * Could be used to speed up handshake establishment when reconnecting to the server. + * @returns {any} - ASN.1 encoded TLS session or undefined if none was negotiated. + */ + getSession(): any; + /** + * NOTE: Works only with client TLS sockets. + * Useful only for debugging, for session reuse provide session option to tls.connect(). + * @returns {any} - TLS session ticket or undefined if none was negotiated. + */ + getTLSTicket(): any; + /** + * The string representation of the local IP address. + */ + localAddress: string; + /** + * The numeric representation of the local port. + */ + localPort: string; + /** + * The string representation of the remote IP address. + * For example, '74.125.127.100' or '2001:4860:a005::68'. + */ + remoteAddress: string; + /** + * The string representation of the remote IP family. 'IPv4' or 'IPv6'. + */ + remoteFamily: string; + /** + * The numeric representation of the remote port. For example, 443. + */ + remotePort: number; + /** + * Initiate TLS renegotiation process. + * + * NOTE: Can be used to request peer's certificate after the secure connection has been established. + * ANOTHER NOTE: When running as the server, socket will be destroyed with an error after handshakeTimeout timeout. + * @param {TlsOptions} options - The options may contain the following fields: rejectUnauthorized, + * requestCert (See tls.createServer() for details). + * @param {Function} callback - callback(err) will be executed with null as err, once the renegotiation + * is successfully completed. + */ + renegotiate(options: TlsOptions, callback: (err: Error) => any): any; + /** + * Set maximum TLS fragment size (default and maximum value is: 16384, minimum is: 512). + * Smaller fragment size decreases buffering latency on the client: large fragments are buffered by + * the TLS layer until the entire fragment is received and its integrity is verified; + * large fragments can span multiple roundtrips, and their processing can be delayed due to packet + * loss or reordering. However, smaller fragments add extra TLS framing bytes and CPU overhead, + * which may decrease overall server throughput. + * @param {number} size - TLS fragment size (default and maximum value is: 16384, minimum is: 512). + * @returns {boolean} - Returns true on success, false otherwise. + */ + setMaxSendFragment(size: number): boolean; + } + + export interface TlsOptions { + host?: string; + port?: number; + pfx?: string | Buffer[]; + key?: string | string[] | Buffer | any[]; + passphrase?: string; + cert?: string | string[] | Buffer | Buffer[]; + ca?: string | string[] | Buffer | Buffer[]; + crl?: string | string[]; + ciphers?: string; + honorCipherOrder?: boolean; + requestCert?: boolean; + rejectUnauthorized?: boolean; + NPNProtocols?: string[] | Buffer; + SNICallback?: (servername: string, cb: (err: Error, ctx: SecureContext) => any) => any; + ecdhCurve?: string; + dhparam?: string | Buffer; + handshakeTimeout?: number; + ALPNProtocols?: string[] | Buffer; + sessionTimeout?: number; + ticketKeys?: any; + sessionIdContext?: string; + secureProtocol?: string; + } + + export interface ConnectionOptions { + host?: string; + port?: number; + socket?: net.Socket; + pfx?: string | Buffer + key?: string | string[] | Buffer | Buffer[]; + passphrase?: string; + cert?: string | string[] | Buffer | Buffer[]; + ca?: string | Buffer | (string | Buffer)[]; + rejectUnauthorized?: boolean; + NPNProtocols?: (string | Buffer)[]; + servername?: string; + path?: string; + ALPNProtocols?: (string | Buffer)[]; + checkServerIdentity?: (servername: string, cert: string | Buffer | (string | Buffer)[]) => any; + secureProtocol?: string; + secureContext?: Object; + session?: Buffer; + minDHSize?: number; + } + + export interface Server extends net.Server { + close(): Server; + address(): { port: number; family: string; address: string; }; + addContext(hostName: string, credentials: { + key: string; + cert: string; + ca: string; + }): void; + maxConnections: number; + connections: number; + } + + export interface ClearTextStream extends stream.Duplex { + authorized: boolean; + authorizationError: Error; + getPeerCertificate(): any; + getCipher: { + name: string; + version: string; + }; + address: { + port: number; + family: string; + address: string; + }; + remoteAddress: string; + remotePort: number; + } + + export interface SecurePair { + encrypted: any; + cleartext: any; + } + + export interface SecureContextOptions { + pfx?: string | Buffer; + key?: string | Buffer; + passphrase?: string; + cert?: string | Buffer; + ca?: string | Buffer; + crl?: string | string[] + ciphers?: string; + honorCipherOrder?: boolean; + } + + export interface SecureContext { + context: any; + } + + export function createServer(options: TlsOptions, secureConnectionListener?: (cleartextStream: ClearTextStream) => void): Server; + export function connect(options: ConnectionOptions, secureConnectionListener?: () => void): ClearTextStream; + export function connect(port: number, host?: string, options?: ConnectionOptions, secureConnectListener?: () => void): ClearTextStream; + export function connect(port: number, options?: ConnectionOptions, secureConnectListener?: () => void): ClearTextStream; + export function createSecurePair(credentials?: crypto.Credentials, isServer?: boolean, requestCert?: boolean, rejectUnauthorized?: boolean): SecurePair; + export function createSecureContext(details: SecureContextOptions): SecureContext; +} + +declare module "crypto" { + export interface Certificate { + exportChallenge(spkac: string | Buffer): Buffer; + exportPublicKey(spkac: string | Buffer): Buffer; + verifySpkac(spkac: Buffer): boolean; + } + export var Certificate: { + new (): Certificate; + (): Certificate; + } + + export var fips: boolean; + + export interface CredentialDetails { + pfx: string; + key: string; + passphrase: string; + cert: string; + ca: string | string[]; + crl: string | string[]; + ciphers: string; + } + export interface Credentials { context?: any; } + export function createCredentials(details: CredentialDetails): Credentials; + export function createHash(algorithm: string): Hash; + export function createHmac(algorithm: string, key: string | Buffer): Hmac; + + type Utf8AsciiLatin1Encoding = "utf8" | "ascii" | "latin1"; + type HexBase64Latin1Encoding = "latin1" | "hex" | "base64"; + type Utf8AsciiBinaryEncoding = "utf8" | "ascii" | "binary"; + type HexBase64BinaryEncoding = "binary" | "base64" | "hex"; + type ECDHKeyFormat = "compressed" | "uncompressed" | "hybrid"; + + export interface Hash extends NodeJS.ReadWriteStream { + update(data: string | Buffer): Hash; + update(data: string | Buffer, input_encoding: Utf8AsciiLatin1Encoding): Hash; + digest(): Buffer; + digest(encoding: HexBase64Latin1Encoding): string; + } + export interface Hmac extends NodeJS.ReadWriteStream { + update(data: string | Buffer): Hmac; + update(data: string | Buffer, input_encoding: Utf8AsciiLatin1Encoding): Hmac; + digest(): Buffer; + digest(encoding: HexBase64Latin1Encoding): string; + } + export function createCipher(algorithm: string, password: any): Cipher; + export function createCipheriv(algorithm: string, key: any, iv: any): Cipher; + export interface Cipher extends NodeJS.ReadWriteStream { + update(data: Buffer): Buffer; + update(data: string, input_encoding: Utf8AsciiBinaryEncoding): Buffer; + update(data: Buffer, input_encoding: any, output_encoding: HexBase64BinaryEncoding): string; + update(data: string, input_encoding: Utf8AsciiBinaryEncoding, output_encoding: HexBase64BinaryEncoding): string; + final(): Buffer; + final(output_encoding: string): string; + setAutoPadding(auto_padding?: boolean): void; + getAuthTag(): Buffer; + setAAD(buffer: Buffer): void; + } + export function createDecipher(algorithm: string, password: any): Decipher; + export function createDecipheriv(algorithm: string, key: any, iv: any): Decipher; + export interface Decipher extends NodeJS.ReadWriteStream { + update(data: Buffer): Buffer; + update(data: string, input_encoding: HexBase64BinaryEncoding): Buffer; + update(data: Buffer, input_encoding: any, output_encoding: Utf8AsciiBinaryEncoding): string; + update(data: string, input_encoding: HexBase64BinaryEncoding, output_encoding: Utf8AsciiBinaryEncoding): string; + final(): Buffer; + final(output_encoding: string): string; + setAutoPadding(auto_padding?: boolean): void; + setAuthTag(tag: Buffer): void; + setAAD(buffer: Buffer): void; + } + export function createSign(algorithm: string): Signer; + export interface Signer extends NodeJS.WritableStream { + update(data: string | Buffer): Signer; + update(data: string | Buffer, input_encoding: Utf8AsciiLatin1Encoding): Signer; + sign(private_key: string | { key: string; passphrase: string }): Buffer; + sign(private_key: string | { key: string; passphrase: string }, output_format: HexBase64Latin1Encoding): string; + } + export function createVerify(algorith: string): Verify; + export interface Verify extends NodeJS.WritableStream { + update(data: string | Buffer): Verify; + update(data: string | Buffer, input_encoding: Utf8AsciiLatin1Encoding): Verify; + verify(object: string, signature: Buffer): boolean; + verify(object: string, signature: string, signature_format: HexBase64Latin1Encoding): boolean; + } + export function createDiffieHellman(prime_length: number, generator?: number): DiffieHellman; + export function createDiffieHellman(prime: Buffer): DiffieHellman; + export function createDiffieHellman(prime: string, prime_encoding: HexBase64Latin1Encoding): DiffieHellman; + export function createDiffieHellman(prime: string, prime_encoding: HexBase64Latin1Encoding, generator: number | Buffer): DiffieHellman; + export function createDiffieHellman(prime: string, prime_encoding: HexBase64Latin1Encoding, generator: string, generator_encoding: HexBase64Latin1Encoding): DiffieHellman; + export interface DiffieHellman { + generateKeys(): Buffer; + generateKeys(encoding: HexBase64Latin1Encoding): string; + computeSecret(other_public_key: Buffer): Buffer; + computeSecret(other_public_key: string, input_encoding: HexBase64Latin1Encoding): Buffer; + computeSecret(other_public_key: string, input_encoding: HexBase64Latin1Encoding, output_encoding: HexBase64Latin1Encoding): string; + getPrime(): Buffer; + getPrime(encoding: HexBase64Latin1Encoding): string; + getGenerator(): Buffer; + getGenerator(encoding: HexBase64Latin1Encoding): string; + getPublicKey(): Buffer; + getPublicKey(encoding: HexBase64Latin1Encoding): string; + getPrivateKey(): Buffer; + getPrivateKey(encoding: HexBase64Latin1Encoding): string; + setPublicKey(public_key: Buffer): void; + setPublicKey(public_key: string, encoding: string): void; + setPrivateKey(private_key: Buffer): void; + setPrivateKey(private_key: string, encoding: string): void; + verifyError: number; + } + export function getDiffieHellman(group_name: string): DiffieHellman; + export function pbkdf2(password: string | Buffer, salt: string | Buffer, iterations: number, keylen: number, digest: string, callback: (err: Error, derivedKey: Buffer) => any): void; + export function pbkdf2Sync(password: string | Buffer, salt: string | Buffer, iterations: number, keylen: number, digest: string): Buffer; + export function randomBytes(size: number): Buffer; + export function randomBytes(size: number, callback: (err: Error, buf: Buffer) => void): void; + export function pseudoRandomBytes(size: number): Buffer; + export function pseudoRandomBytes(size: number, callback: (err: Error, buf: Buffer) => void): void; + export interface RsaPublicKey { + key: string; + padding?: number; + } + export interface RsaPrivateKey { + key: string; + passphrase?: string, + padding?: number; + } + export function publicEncrypt(public_key: string | RsaPublicKey, buffer: Buffer): Buffer + export function privateDecrypt(private_key: string | RsaPrivateKey, buffer: Buffer): Buffer + export function privateEncrypt(private_key: string | RsaPrivateKey, buffer: Buffer): Buffer + export function publicDecrypt(public_key: string | RsaPublicKey, buffer: Buffer): Buffer + export function getCiphers(): string[]; + export function getCurves(): string[]; + export function getHashes(): string[]; + export interface ECDH { + generateKeys(): Buffer; + generateKeys(encoding: HexBase64Latin1Encoding): string; + generateKeys(encoding: HexBase64Latin1Encoding, format: ECDHKeyFormat): string; + computeSecret(other_public_key: Buffer): Buffer; + computeSecret(other_public_key: string, input_encoding: HexBase64Latin1Encoding): Buffer; + computeSecret(other_public_key: string, input_encoding: HexBase64Latin1Encoding, output_encoding: HexBase64Latin1Encoding): string; + getPrivateKey(): Buffer; + getPrivateKey(encoding: HexBase64Latin1Encoding): string; + getPublicKey(): Buffer; + getPublicKey(encoding: HexBase64Latin1Encoding): string; + getPublicKey(encoding: HexBase64Latin1Encoding, format: ECDHKeyFormat): string; + setPrivateKey(private_key: Buffer): void; + setPrivateKey(private_key: string, encoding: HexBase64Latin1Encoding): void; + } + export function createECDH(curve_name: string): ECDH; + export var DEFAULT_ENCODING: string; +} + +declare module "stream" { + import * as events from "events"; + + class internal extends events.EventEmitter { + pipe(destination: T, options?: { end?: boolean; }): T; + } + namespace internal { + + export class Stream extends internal { } + + export interface ReadableOptions { + highWaterMark?: number; + encoding?: string; + objectMode?: boolean; + read?: (size?: number) => any; + } + + export class Readable extends events.EventEmitter implements NodeJS.ReadableStream { + readable: boolean; + constructor(opts?: ReadableOptions); + _read(size: number): void; + read(size?: number): any; + setEncoding(encoding: string): void; + pause(): Readable; + resume(): Readable; + pipe(destination: T, options?: { end?: boolean; }): T; + unpipe(destination?: T): void; + unshift(chunk: any): void; + wrap(oldStream: NodeJS.ReadableStream): NodeJS.ReadableStream; + push(chunk: any, encoding?: string): boolean; + + /** + * Event emitter + * The defined events on documents including: + * 1. close + * 2. data + * 3. end + * 4. readable + * 5. error + **/ + addListener(event: string, listener: Function): this; + addListener(event: string, listener: Function): this; + addListener(event: "close", listener: () => void): this; + addListener(event: "data", listener: (chunk: Buffer | string) => void): this; + addListener(event: "end", listener: () => void): this; + addListener(event: "readable", listener: () => void): this; + addListener(event: "error", listener: (err: Error) => void): this; + + emit(event: string, ...args: any[]): boolean; + emit(event: "close"): boolean; + emit(event: "data", chunk: Buffer | string): boolean; + emit(event: "end"): boolean; + emit(event: "readable"): boolean; + emit(event: "error", err: Error): boolean; + + on(event: string, listener: Function): this; + on(event: "close", listener: () => void): this; + on(event: "data", listener: (chunk: Buffer | string) => void): this; + on(event: "end", listener: () => void): this; + on(event: "readable", listener: () => void): this; + on(event: "error", listener: (err: Error) => void): this; + + once(event: string, listener: Function): this; + once(event: "close", listener: () => void): this; + once(event: "data", listener: (chunk: Buffer | string) => void): this; + once(event: "end", listener: () => void): this; + once(event: "readable", listener: () => void): this; + once(event: "error", listener: (err: Error) => void): this; + + prependListener(event: string, listener: Function): this; + prependListener(event: "close", listener: () => void): this; + prependListener(event: "data", listener: (chunk: Buffer | string) => void): this; + prependListener(event: "end", listener: () => void): this; + prependListener(event: "readable", listener: () => void): this; + prependListener(event: "error", listener: (err: Error) => void): this; + + prependOnceListener(event: string, listener: Function): this; + prependOnceListener(event: "close", listener: () => void): this; + prependOnceListener(event: "data", listener: (chunk: Buffer | string) => void): this; + prependOnceListener(event: "end", listener: () => void): this; + prependOnceListener(event: "readable", listener: () => void): this; + prependOnceListener(event: "error", listener: (err: Error) => void): this; + + removeListener(event: string, listener: Function): this; + removeListener(event: "close", listener: () => void): this; + removeListener(event: "data", listener: (chunk: Buffer | string) => void): this; + removeListener(event: "end", listener: () => void): this; + removeListener(event: "readable", listener: () => void): this; + removeListener(event: "error", listener: (err: Error) => void): this; + } + + export interface WritableOptions { + highWaterMark?: number; + decodeStrings?: boolean; + objectMode?: boolean; + write?: (chunk: string | Buffer, encoding: string, callback: Function) => any; + writev?: (chunks: { chunk: string | Buffer, encoding: string }[], callback: Function) => any; + } + + export class Writable extends events.EventEmitter implements NodeJS.WritableStream { + writable: boolean; + constructor(opts?: WritableOptions); + _write(chunk: any, encoding: string, callback: Function): void; + write(chunk: any, cb?: Function): boolean; + write(chunk: any, encoding?: string, cb?: Function): boolean; + end(): void; + end(chunk: any, cb?: Function): void; + end(chunk: any, encoding?: string, cb?: Function): void; + + /** + * Event emitter + * The defined events on documents including: + * 1. close + * 2. drain + * 3. error + * 4. finish + * 5. pipe + * 6. unpipe + **/ + addListener(event: string, listener: Function): this; + addListener(event: "close", listener: () => void): this; + addListener(event: "drain", listener: () => void): this; + addListener(event: "error", listener: (err: Error) => void): this; + addListener(event: "finish", listener: () => void): this; + addListener(event: "pipe", listener: (src: Readable) => void): this; + addListener(event: "unpipe", listener: (src: Readable) => void): this; + + emit(event: string, ...args: any[]): boolean; + emit(event: "close"): boolean; + emit(event: "drain", chunk: Buffer | string): boolean; + emit(event: "error", err: Error): boolean; + emit(event: "finish"): boolean; + emit(event: "pipe", src: Readable): boolean; + emit(event: "unpipe", src: Readable): boolean; + + on(event: string, listener: Function): this; + on(event: "close", listener: () => void): this; + on(event: "drain", listener: () => void): this; + on(event: "error", listener: (err: Error) => void): this; + on(event: "finish", listener: () => void): this; + on(event: "pipe", listener: (src: Readable) => void): this; + on(event: "unpipe", listener: (src: Readable) => void): this; + + once(event: string, listener: Function): this; + once(event: "close", listener: () => void): this; + once(event: "drain", listener: () => void): this; + once(event: "error", listener: (err: Error) => void): this; + once(event: "finish", listener: () => void): this; + once(event: "pipe", listener: (src: Readable) => void): this; + once(event: "unpipe", listener: (src: Readable) => void): this; + + prependListener(event: string, listener: Function): this; + prependListener(event: "close", listener: () => void): this; + prependListener(event: "drain", listener: () => void): this; + prependListener(event: "error", listener: (err: Error) => void): this; + prependListener(event: "finish", listener: () => void): this; + prependListener(event: "pipe", listener: (src: Readable) => void): this; + prependListener(event: "unpipe", listener: (src: Readable) => void): this; + + prependOnceListener(event: string, listener: Function): this; + prependOnceListener(event: "close", listener: () => void): this; + prependOnceListener(event: "drain", listener: () => void): this; + prependOnceListener(event: "error", listener: (err: Error) => void): this; + prependOnceListener(event: "finish", listener: () => void): this; + prependOnceListener(event: "pipe", listener: (src: Readable) => void): this; + prependOnceListener(event: "unpipe", listener: (src: Readable) => void): this; + + removeListener(event: string, listener: Function): this; + removeListener(event: "close", listener: () => void): this; + removeListener(event: "drain", listener: () => void): this; + removeListener(event: "error", listener: (err: Error) => void): this; + removeListener(event: "finish", listener: () => void): this; + removeListener(event: "pipe", listener: (src: Readable) => void): this; + removeListener(event: "unpipe", listener: (src: Readable) => void): this; + } + + export interface DuplexOptions extends ReadableOptions, WritableOptions { + allowHalfOpen?: boolean; + readableObjectMode?: boolean; + writableObjectMode?: boolean; + } + + // Note: Duplex extends both Readable and Writable. + export class Duplex extends Readable implements NodeJS.ReadWriteStream { + // Readable + pause(): Duplex; + resume(): Duplex; + // Writeable + writable: boolean; + constructor(opts?: DuplexOptions); + _write(chunk: any, encoding: string, callback: Function): void; + write(chunk: any, cb?: Function): boolean; + write(chunk: any, encoding?: string, cb?: Function): boolean; + end(): void; + end(chunk: any, cb?: Function): void; + end(chunk: any, encoding?: string, cb?: Function): void; + } + + export interface TransformOptions extends ReadableOptions, WritableOptions { + transform?: (chunk: string | Buffer, encoding: string, callback: Function) => any; + flush?: (callback: Function) => any; + } + + // Note: Transform lacks the _read and _write methods of Readable/Writable. + export class Transform extends events.EventEmitter implements NodeJS.ReadWriteStream { + readable: boolean; + writable: boolean; + constructor(opts?: TransformOptions); + _transform(chunk: any, encoding: string, callback: Function): void; + _flush(callback: Function): void; + read(size?: number): any; + setEncoding(encoding: string): void; + pause(): Transform; + resume(): Transform; + pipe(destination: T, options?: { end?: boolean; }): T; + unpipe(destination?: T): void; + unshift(chunk: any): void; + wrap(oldStream: NodeJS.ReadableStream): NodeJS.ReadableStream; + push(chunk: any, encoding?: string): boolean; + write(chunk: any, cb?: Function): boolean; + write(chunk: any, encoding?: string, cb?: Function): boolean; + end(): void; + end(chunk: any, cb?: Function): void; + end(chunk: any, encoding?: string, cb?: Function): void; + } + + export class PassThrough extends Transform { } + } + + export = internal; +} + +declare module "util" { + export interface InspectOptions { + showHidden?: boolean; + depth?: number; + colors?: boolean; + customInspect?: boolean; + } + + export function format(format: any, ...param: any[]): string; + export function debug(string: string): void; + export function error(...param: any[]): void; + export function puts(...param: any[]): void; + export function print(...param: any[]): void; + export function log(string: string): void; + export function inspect(object: any, showHidden?: boolean, depth?: number, color?: boolean): string; + export function inspect(object: any, options: InspectOptions): string; + export function isArray(object: any): boolean; + export function isRegExp(object: any): boolean; + export function isDate(object: any): boolean; + export function isError(object: any): boolean; + export function inherits(constructor: any, superConstructor: any): void; + export function debuglog(key: string): (msg: string, ...param: any[]) => void; + export function isBoolean(object: any): boolean; + export function isBuffer(object: any): boolean; + export function isFunction(object: any): boolean; + export function isNull(object: any): boolean; + export function isNullOrUndefined(object: any): boolean; + export function isNumber(object: any): boolean; + export function isObject(object: any): boolean; + export function isPrimitive(object: any): boolean; + export function isString(object: any): boolean; + export function isSymbol(object: any): boolean; + export function isUndefined(object: any): boolean; + export function deprecate(fn: Function, message: string): Function; +} + +declare module "assert" { + function internal(value: any, message?: string): void; + namespace internal { + export class AssertionError implements Error { + name: string; + message: string; + actual: any; + expected: any; + operator: string; + generatedMessage: boolean; + + constructor(options?: { + message?: string; actual?: any; expected?: any; + operator?: string; stackStartFunction?: Function + }); + } + + export function fail(actual: any, expected: any, message: string, operator: string): void; + export function ok(value: any, message?: string): void; + export function equal(actual: any, expected: any, message?: string): void; + export function notEqual(actual: any, expected: any, message?: string): void; + export function deepEqual(actual: any, expected: any, message?: string): void; + export function notDeepEqual(acutal: any, expected: any, message?: string): void; + export function strictEqual(actual: any, expected: any, message?: string): void; + export function notStrictEqual(actual: any, expected: any, message?: string): void; + export function deepStrictEqual(actual: any, expected: any, message?: string): void; + export function notDeepStrictEqual(actual: any, expected: any, message?: string): void; + export var throws: { + (block: Function, message?: string): void; + (block: Function, error: Function, message?: string): void; + (block: Function, error: RegExp, message?: string): void; + (block: Function, error: (err: any) => boolean, message?: string): void; + }; + + export var doesNotThrow: { + (block: Function, message?: string): void; + (block: Function, error: Function, message?: string): void; + (block: Function, error: RegExp, message?: string): void; + (block: Function, error: (err: any) => boolean, message?: string): void; + }; + + export function ifError(value: any): void; + } + + export = internal; +} + +declare module "tty" { + import * as net from "net"; + + export function isatty(fd: number): boolean; + export interface ReadStream extends net.Socket { + isRaw: boolean; + setRawMode(mode: boolean): void; + isTTY: boolean; + } + export interface WriteStream extends net.Socket { + columns: number; + rows: number; + isTTY: boolean; + } +} + +declare module "domain" { + import * as events from "events"; + + export class Domain extends events.EventEmitter implements NodeJS.Domain { + run(fn: Function): void; + add(emitter: events.EventEmitter): void; + remove(emitter: events.EventEmitter): void; + bind(cb: (err: Error, data: any) => any): any; + intercept(cb: (data: any) => any): any; + dispose(): void; + members: any[]; + enter(): void; + exit(): void; + } + + export function create(): Domain; +} + +declare module "constants" { + export var E2BIG: number; + export var EACCES: number; + export var EADDRINUSE: number; + export var EADDRNOTAVAIL: number; + export var EAFNOSUPPORT: number; + export var EAGAIN: number; + export var EALREADY: number; + export var EBADF: number; + export var EBADMSG: number; + export var EBUSY: number; + export var ECANCELED: number; + export var ECHILD: number; + export var ECONNABORTED: number; + export var ECONNREFUSED: number; + export var ECONNRESET: number; + export var EDEADLK: number; + export var EDESTADDRREQ: number; + export var EDOM: number; + export var EEXIST: number; + export var EFAULT: number; + export var EFBIG: number; + export var EHOSTUNREACH: number; + export var EIDRM: number; + export var EILSEQ: number; + export var EINPROGRESS: number; + export var EINTR: number; + export var EINVAL: number; + export var EIO: number; + export var EISCONN: number; + export var EISDIR: number; + export var ELOOP: number; + export var EMFILE: number; + export var EMLINK: number; + export var EMSGSIZE: number; + export var ENAMETOOLONG: number; + export var ENETDOWN: number; + export var ENETRESET: number; + export var ENETUNREACH: number; + export var ENFILE: number; + export var ENOBUFS: number; + export var ENODATA: number; + export var ENODEV: number; + export var ENOENT: number; + export var ENOEXEC: number; + export var ENOLCK: number; + export var ENOLINK: number; + export var ENOMEM: number; + export var ENOMSG: number; + export var ENOPROTOOPT: number; + export var ENOSPC: number; + export var ENOSR: number; + export var ENOSTR: number; + export var ENOSYS: number; + export var ENOTCONN: number; + export var ENOTDIR: number; + export var ENOTEMPTY: number; + export var ENOTSOCK: number; + export var ENOTSUP: number; + export var ENOTTY: number; + export var ENXIO: number; + export var EOPNOTSUPP: number; + export var EOVERFLOW: number; + export var EPERM: number; + export var EPIPE: number; + export var EPROTO: number; + export var EPROTONOSUPPORT: number; + export var EPROTOTYPE: number; + export var ERANGE: number; + export var EROFS: number; + export var ESPIPE: number; + export var ESRCH: number; + export var ETIME: number; + export var ETIMEDOUT: number; + export var ETXTBSY: number; + export var EWOULDBLOCK: number; + export var EXDEV: number; + export var WSAEINTR: number; + export var WSAEBADF: number; + export var WSAEACCES: number; + export var WSAEFAULT: number; + export var WSAEINVAL: number; + export var WSAEMFILE: number; + export var WSAEWOULDBLOCK: number; + export var WSAEINPROGRESS: number; + export var WSAEALREADY: number; + export var WSAENOTSOCK: number; + export var WSAEDESTADDRREQ: number; + export var WSAEMSGSIZE: number; + export var WSAEPROTOTYPE: number; + export var WSAENOPROTOOPT: number; + export var WSAEPROTONOSUPPORT: number; + export var WSAESOCKTNOSUPPORT: number; + export var WSAEOPNOTSUPP: number; + export var WSAEPFNOSUPPORT: number; + export var WSAEAFNOSUPPORT: number; + export var WSAEADDRINUSE: number; + export var WSAEADDRNOTAVAIL: number; + export var WSAENETDOWN: number; + export var WSAENETUNREACH: number; + export var WSAENETRESET: number; + export var WSAECONNABORTED: number; + export var WSAECONNRESET: number; + export var WSAENOBUFS: number; + export var WSAEISCONN: number; + export var WSAENOTCONN: number; + export var WSAESHUTDOWN: number; + export var WSAETOOMANYREFS: number; + export var WSAETIMEDOUT: number; + export var WSAECONNREFUSED: number; + export var WSAELOOP: number; + export var WSAENAMETOOLONG: number; + export var WSAEHOSTDOWN: number; + export var WSAEHOSTUNREACH: number; + export var WSAENOTEMPTY: number; + export var WSAEPROCLIM: number; + export var WSAEUSERS: number; + export var WSAEDQUOT: number; + export var WSAESTALE: number; + export var WSAEREMOTE: number; + export var WSASYSNOTREADY: number; + export var WSAVERNOTSUPPORTED: number; + export var WSANOTINITIALISED: number; + export var WSAEDISCON: number; + export var WSAENOMORE: number; + export var WSAECANCELLED: number; + export var WSAEINVALIDPROCTABLE: number; + export var WSAEINVALIDPROVIDER: number; + export var WSAEPROVIDERFAILEDINIT: number; + export var WSASYSCALLFAILURE: number; + export var WSASERVICE_NOT_FOUND: number; + export var WSATYPE_NOT_FOUND: number; + export var WSA_E_NO_MORE: number; + export var WSA_E_CANCELLED: number; + export var WSAEREFUSED: number; + export var SIGHUP: number; + export var SIGINT: number; + export var SIGILL: number; + export var SIGABRT: number; + export var SIGFPE: number; + export var SIGKILL: number; + export var SIGSEGV: number; + export var SIGTERM: number; + export var SIGBREAK: number; + export var SIGWINCH: number; + export var SSL_OP_ALL: number; + export var SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION: number; + export var SSL_OP_CIPHER_SERVER_PREFERENCE: number; + export var SSL_OP_CISCO_ANYCONNECT: number; + export var SSL_OP_COOKIE_EXCHANGE: number; + export var SSL_OP_CRYPTOPRO_TLSEXT_BUG: number; + export var SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS: number; + export var SSL_OP_EPHEMERAL_RSA: number; + export var SSL_OP_LEGACY_SERVER_CONNECT: number; + export var SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER: number; + export var SSL_OP_MICROSOFT_SESS_ID_BUG: number; + export var SSL_OP_MSIE_SSLV2_RSA_PADDING: number; + export var SSL_OP_NETSCAPE_CA_DN_BUG: number; + export var SSL_OP_NETSCAPE_CHALLENGE_BUG: number; + export var SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG: number; + export var SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG: number; + export var SSL_OP_NO_COMPRESSION: number; + export var SSL_OP_NO_QUERY_MTU: number; + export var SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION: number; + export var SSL_OP_NO_SSLv2: number; + export var SSL_OP_NO_SSLv3: number; + export var SSL_OP_NO_TICKET: number; + export var SSL_OP_NO_TLSv1: number; + export var SSL_OP_NO_TLSv1_1: number; + export var SSL_OP_NO_TLSv1_2: number; + export var SSL_OP_PKCS1_CHECK_1: number; + export var SSL_OP_PKCS1_CHECK_2: number; + export var SSL_OP_SINGLE_DH_USE: number; + export var SSL_OP_SINGLE_ECDH_USE: number; + export var SSL_OP_SSLEAY_080_CLIENT_DH_BUG: number; + export var SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG: number; + export var SSL_OP_TLS_BLOCK_PADDING_BUG: number; + export var SSL_OP_TLS_D5_BUG: number; + export var SSL_OP_TLS_ROLLBACK_BUG: number; + export var ENGINE_METHOD_DSA: number; + export var ENGINE_METHOD_DH: number; + export var ENGINE_METHOD_RAND: number; + export var ENGINE_METHOD_ECDH: number; + export var ENGINE_METHOD_ECDSA: number; + export var ENGINE_METHOD_CIPHERS: number; + export var ENGINE_METHOD_DIGESTS: number; + export var ENGINE_METHOD_STORE: number; + export var ENGINE_METHOD_PKEY_METHS: number; + export var ENGINE_METHOD_PKEY_ASN1_METHS: number; + export var ENGINE_METHOD_ALL: number; + export var ENGINE_METHOD_NONE: number; + export var DH_CHECK_P_NOT_SAFE_PRIME: number; + export var DH_CHECK_P_NOT_PRIME: number; + export var DH_UNABLE_TO_CHECK_GENERATOR: number; + export var DH_NOT_SUITABLE_GENERATOR: number; + export var NPN_ENABLED: number; + export var RSA_PKCS1_PADDING: number; + export var RSA_SSLV23_PADDING: number; + export var RSA_NO_PADDING: number; + export var RSA_PKCS1_OAEP_PADDING: number; + export var RSA_X931_PADDING: number; + export var RSA_PKCS1_PSS_PADDING: number; + export var POINT_CONVERSION_COMPRESSED: number; + export var POINT_CONVERSION_UNCOMPRESSED: number; + export var POINT_CONVERSION_HYBRID: number; + export var O_RDONLY: number; + export var O_WRONLY: number; + export var O_RDWR: number; + export var S_IFMT: number; + export var S_IFREG: number; + export var S_IFDIR: number; + export var S_IFCHR: number; + export var S_IFBLK: number; + export var S_IFIFO: number; + export var S_IFSOCK: number; + export var S_IRWXU: number; + export var S_IRUSR: number; + export var S_IWUSR: number; + export var S_IXUSR: number; + export var S_IRWXG: number; + export var S_IRGRP: number; + export var S_IWGRP: number; + export var S_IXGRP: number; + export var S_IRWXO: number; + export var S_IROTH: number; + export var S_IWOTH: number; + export var S_IXOTH: number; + export var S_IFLNK: number; + export var O_CREAT: number; + export var O_EXCL: number; + export var O_NOCTTY: number; + export var O_DIRECTORY: number; + export var O_NOATIME: number; + export var O_NOFOLLOW: number; + export var O_SYNC: number; + export var O_SYMLINK: number; + export var O_DIRECT: number; + export var O_NONBLOCK: number; + export var O_TRUNC: number; + export var O_APPEND: number; + export var F_OK: number; + export var R_OK: number; + export var W_OK: number; + export var X_OK: number; + export var UV_UDP_REUSEADDR: number; + export var SIGQUIT: number; + export var SIGTRAP: number; + export var SIGIOT: number; + export var SIGBUS: number; + export var SIGUSR1: number; + export var SIGUSR2: number; + export var SIGPIPE: number; + export var SIGALRM: number; + export var SIGCHLD: number; + export var SIGSTKFLT: number; + export var SIGCONT: number; + export var SIGSTOP: number; + export var SIGTSTP: number; + export var SIGTTIN: number; + export var SIGTTOU: number; + export var SIGURG: number; + export var SIGXCPU: number; + export var SIGXFSZ: number; + export var SIGVTALRM: number; + export var SIGPROF: number; + export var SIGIO: number; + export var SIGPOLL: number; + export var SIGPWR: number; + export var SIGSYS: number; + export var SIGUNUSED: number; + export var defaultCoreCipherList: string; + export var defaultCipherList: string; + export var ENGINE_METHOD_RSA: number; + export var ALPN_ENABLED: number; +} + +declare module "process" { + export = process; +} + +declare module "v8" { + interface HeapSpaceInfo { + space_name: string; + space_size: number; + space_used_size: number; + space_available_size: number; + physical_space_size: number; + } + export function getHeapStatistics(): { total_heap_size: number, total_heap_size_executable: number, total_physical_size: number, total_avaialble_size: number, used_heap_size: number, heap_size_limit: number }; + export function getHeapSpaceStatistics(): HeapSpaceInfo[]; + export function setFlagsFromString(flags: string): void; +} + +declare module "timers" { + export function setTimeout(callback: (...args: any[]) => void, ms: number, ...args: any[]): NodeJS.Timer; + export function clearTimeout(timeoutId: NodeJS.Timer): void; + export function setInterval(callback: (...args: any[]) => void, ms: number, ...args: any[]): NodeJS.Timer; + export function clearInterval(intervalId: NodeJS.Timer): void; + export function setImmediate(callback: (...args: any[]) => void, ...args: any[]): any; + export function clearImmediate(immediateId: any): void; +} + +declare module "console" { + export = console; +} \ No newline at end of file diff --git a/common-npm-packages/webdeployment-common-v2/typings/globals/node/typings.json b/common-npm-packages/webdeployment-common-v2/typings/globals/node/typings.json new file mode 100644 index 000000000000..98c1869d1d0a --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/typings/globals/node/typings.json @@ -0,0 +1,8 @@ +{ + "resolution": "main", + "tree": { + "src": "https://raw.githubusercontent.com/DefinitelyTyped/DefinitelyTyped/ab8d917787092fdfb16390f2bee6de8ab5c1783c/node/node.d.ts", + "raw": "registry:dt/node#6.0.0+20160920093002", + "typings": "https://raw.githubusercontent.com/DefinitelyTyped/DefinitelyTyped/ab8d917787092fdfb16390f2bee6de8ab5c1783c/node/node.d.ts" + } +} diff --git a/common-npm-packages/webdeployment-common-v2/typings/globals/q/index.d.ts b/common-npm-packages/webdeployment-common-v2/typings/globals/q/index.d.ts new file mode 100644 index 000000000000..4449c31841ff --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/typings/globals/q/index.d.ts @@ -0,0 +1,357 @@ +// Generated by typings +// Source: https://raw.githubusercontent.com/DefinitelyTyped/DefinitelyTyped/623f30ab194a3486e014ca39bc7f2089897d6ce4/q/Q.d.ts +declare function Q(promise: Q.IPromise): Q.Promise; +/** + * If value is not a promise, returns a promise that is fulfilled with value. + */ +declare function Q(value: T): Q.Promise; + +declare namespace Q { + interface IPromise { + then(onFulfill?: (value: T) => U | IPromise, onReject?: (error: any) => U | IPromise): IPromise; + } + + interface Deferred { + promise: Promise; + resolve(value?: T): void; + resolve(value?: IPromise): void; + reject(reason: any): void; + notify(value: any): void; + makeNodeResolver(): (reason: any, value: T) => void; + } + + interface Promise { + /** + * Like a finally clause, allows you to observe either the fulfillment or rejection of a promise, but to do so without modifying the final value. This is useful for collecting resources regardless of whether a job succeeded, like closing a database connection, shutting a server down, or deleting an unneeded key from an object. + + * finally returns a promise, which will become resolved with the same fulfillment value or rejection reason as promise. However, if callback returns a promise, the resolution of the returned promise will be delayed until the promise returned from callback is finished. + */ + fin(finallyCallback: () => any): Promise; + /** + * Like a finally clause, allows you to observe either the fulfillment or rejection of a promise, but to do so without modifying the final value. This is useful for collecting resources regardless of whether a job succeeded, like closing a database connection, shutting a server down, or deleting an unneeded key from an object. + + * finally returns a promise, which will become resolved with the same fulfillment value or rejection reason as promise. However, if callback returns a promise, the resolution of the returned promise will be delayed until the promise returned from callback is finished. + */ + finally(finallyCallback: () => any): Promise; + + /** + * The then method from the Promises/A+ specification, with an additional progress handler. + */ + then(onFulfill?: (value: T) => U | IPromise, onReject?: (error: any) => U | IPromise, onProgress?: Function): Promise; + + /** + * Like then, but "spreads" the array into a variadic fulfillment handler. If any of the promises in the array are rejected, instead calls onRejected with the first rejected promise's rejection reason. + * + * This is especially useful in conjunction with all + */ + spread(onFulfill: (...args: any[]) => IPromise | U, onReject?: (reason: any) => IPromise | U): Promise; + + fail(onRejected: (reason: any) => U | IPromise): Promise; + + /** + * A sugar method, equivalent to promise.then(undefined, onRejected). + */ + catch(onRejected: (reason: any) => U | IPromise): Promise; + + /** + * A sugar method, equivalent to promise.then(undefined, undefined, onProgress). + */ + progress(onProgress: (progress: any) => any): Promise; + + /** + * Much like then, but with different behavior around unhandled rejection. If there is an unhandled rejection, either because promise is rejected and no onRejected callback was provided, or because onFulfilled or onRejected threw an error or returned a rejected promise, the resulting rejection reason is thrown as an exception in a future turn of the event loop. + * + * This method should be used to terminate chains of promises that will not be passed elsewhere. Since exceptions thrown in then callbacks are consumed and transformed into rejections, exceptions at the end of the chain are easy to accidentally, silently ignore. By arranging for the exception to be thrown in a future turn of the event loop, so that it won't be caught, it causes an onerror event on the browser window, or an uncaughtException event on Node.js's process object. + * + * Exceptions thrown by done will have long stack traces, if Q.longStackSupport is set to true. If Q.onerror is set, exceptions will be delivered there instead of thrown in a future turn. + * + * The Golden Rule of done vs. then usage is: either return your promise to someone else, or if the chain ends with you, call done to terminate it. + */ + done(onFulfilled?: (value: T) => any, onRejected?: (reason: any) => any, onProgress?: (progress: any) => any): void; + + /** + * If callback is a function, assumes it's a Node.js-style callback, and calls it as either callback(rejectionReason) when/if promise becomes rejected, or as callback(null, fulfillmentValue) when/if promise becomes fulfilled. If callback is not a function, simply returns promise. + */ + nodeify(callback: (reason: any, value: any) => void): Promise; + + /** + * Returns a promise to get the named property of an object. Essentially equivalent to + * + * promise.then(function (o) { + * return o[propertyName]; + * }); + */ + get(propertyName: String): Promise; + set(propertyName: String, value: any): Promise; + delete(propertyName: String): Promise; + /** + * Returns a promise for the result of calling the named method of an object with the given array of arguments. The object itself is this in the function, just like a synchronous method call. Essentially equivalent to + * + * promise.then(function (o) { + * return o[methodName].apply(o, args); + * }); + */ + post(methodName: String, args: any[]): Promise; + /** + * Returns a promise for the result of calling the named method of an object with the given variadic arguments. The object itself is this in the function, just like a synchronous method call. + */ + invoke(methodName: String, ...args: any[]): Promise; + fapply(args: any[]): Promise; + fcall(...args: any[]): Promise; + + /** + * Returns a promise for an array of the property names of an object. Essentially equivalent to + * + * promise.then(function (o) { + * return Object.keys(o); + * }); + */ + keys(): Promise; + + /** + * A sugar method, equivalent to promise.then(function () { return value; }). + */ + thenResolve(value: U): Promise; + /** + * A sugar method, equivalent to promise.then(function () { throw reason; }). + */ + thenReject(reason: any): Promise; + + /** + * Attaches a handler that will observe the value of the promise when it becomes fulfilled, returning a promise for that same value, perhaps deferred but not replaced by the promise returned by the onFulfilled handler. + */ + tap(onFulfilled: (value: T) => any): Promise; + + timeout(ms: number, message?: string): Promise; + /** + * Returns a promise that will have the same result as promise, but will only be fulfilled or rejected after at least ms milliseconds have passed. + */ + delay(ms: number): Promise; + + /** + * Returns whether a given promise is in the fulfilled state. When the static version is used on non-promises, the result is always true. + */ + isFulfilled(): boolean; + /** + * Returns whether a given promise is in the rejected state. When the static version is used on non-promises, the result is always false. + */ + isRejected(): boolean; + /** + * Returns whether a given promise is in the pending state. When the static version is used on non-promises, the result is always false. + */ + isPending(): boolean; + + valueOf(): any; + + /** + * Returns a "state snapshot" object, which will be in one of three forms: + * + * - { state: "pending" } + * - { state: "fulfilled", value: } + * - { state: "rejected", reason: } + */ + inspect(): PromiseState; + } + + interface PromiseState { + /** + * "fulfilled", "rejected", "pending" + */ + state: string; + value?: T; + reason?: any; + } + + // If no value provided, returned promise will be of void type + export function when(): Promise; + + // if no fulfill, reject, or progress provided, returned promise will be of same type + export function when(value: T | IPromise): Promise; + + // If a non-promise value is provided, it will not reject or progress + export function when(value: T | IPromise, onFulfilled: (val: T) => U | IPromise, onRejected?: (reason: any) => U | IPromise, onProgress?: (progress: any) => any): Promise; + + /** + * Currently "impossible" (and I use the term loosely) to implement due to TypeScript limitations as it is now. + * See: https://github.com/Microsoft/TypeScript/issues/1784 for discussion on it. + */ + // export function try(method: Function, ...args: any[]): Promise; + + export function fbind(method: (...args: any[]) => T | IPromise, ...args: any[]): (...args: any[]) => Promise; + + export function fcall(method: (...args: any[]) => T, ...args: any[]): Promise; + + export function send(obj: any, functionName: string, ...args: any[]): Promise; + export function invoke(obj: any, functionName: string, ...args: any[]): Promise; + export function mcall(obj: any, functionName: string, ...args: any[]): Promise; + + export function denodeify(nodeFunction: Function, ...args: any[]): (...args: any[]) => Promise; + export function nbind(nodeFunction: Function, thisArg: any, ...args: any[]): (...args: any[]) => Promise; + export function nfbind(nodeFunction: Function, ...args: any[]): (...args: any[]) => Promise; + export function nfcall(nodeFunction: Function, ...args: any[]): Promise; + export function nfapply(nodeFunction: Function, args: any[]): Promise; + + export function ninvoke(nodeModule: any, functionName: string, ...args: any[]): Promise; + export function npost(nodeModule: any, functionName: string, args: any[]): Promise; + export function nsend(nodeModule: any, functionName: string, ...args: any[]): Promise; + export function nmcall(nodeModule: any, functionName: string, ...args: any[]): Promise; + + /** + * Returns a promise that is fulfilled with an array containing the fulfillment value of each promise, or is rejected with the same rejection reason as the first promise to be rejected. + */ + export function all(promises: [IPromise, IPromise, IPromise, IPromise, IPromise, IPromise]): Promise<[A, B, C, D, E, F]>; + /** + * Returns a promise that is fulfilled with an array containing the fulfillment value of each promise, or is rejected with the same rejection reason as the first promise to be rejected. + */ + export function all(promises: [IPromise, IPromise, IPromise, IPromise, IPromise]): Promise<[A, B, C, D, E]>; + /** + * Returns a promise that is fulfilled with an array containing the fulfillment value of each promise, or is rejected with the same rejection reason as the first promise to be rejected. + */ + export function all(promises: [IPromise, IPromise, IPromise, IPromise]): Promise<[A, B, C, D]>; + /** + * Returns a promise that is fulfilled with an array containing the fulfillment value of each promise, or is rejected with the same rejection reason as the first promise to be rejected. + */ + export function all(promises: [IPromise, IPromise, IPromise]): Promise<[A, B, C]>; + /** + * Returns a promise that is fulfilled with an array containing the fulfillment value of each promise, or is rejected with the same rejection reason as the first promise to be rejected. + */ + export function all(promises: [IPromise, IPromise]): Promise<[A, B]>; + /** + * Returns a promise that is fulfilled with an array containing the fulfillment value of each promise, or is rejected with the same rejection reason as the first promise to be rejected. + */ + export function all(promises: IPromise[]): Promise; + + /** + * Returns a promise for the first of an array of promises to become settled. + */ + export function race(promises: IPromise[]): Promise; + + /** + * Returns a promise that is fulfilled with an array of promise state snapshots, but only after all the original promises have settled, i.e. become either fulfilled or rejected. + */ + export function allSettled(promises: IPromise[]): Promise[]>; + + export function allResolved(promises: IPromise[]): Promise[]>; + + /** + * Like then, but "spreads" the array into a variadic fulfillment handler. If any of the promises in the array are rejected, instead calls onRejected with the first rejected promise's rejection reason. + * This is especially useful in conjunction with all. + */ + export function spread(promises: IPromise[], onFulfilled: (...args: T[]) => U | IPromise, onRejected?: (reason: any) => U | IPromise): Promise; + + /** + * Returns a promise that will have the same result as promise, except that if promise is not fulfilled or rejected before ms milliseconds, the returned promise will be rejected with an Error with the given message. If message is not supplied, the message will be "Timed out after " + ms + " ms". + */ + export function timeout(promise: Promise, ms: number, message?: string): Promise; + + /** + * Returns a promise that will have the same result as promise, but will only be fulfilled or rejected after at least ms milliseconds have passed. + */ + export function delay(promise: Promise, ms: number): Promise; + /** + * Returns a promise that will have the same result as promise, but will only be fulfilled or rejected after at least ms milliseconds have passed. + */ + export function delay(value: T, ms: number): Promise; + /** + * Returns a promise that will be fulfilled with undefined after at least ms milliseconds have passed. + */ + export function delay(ms: number): Promise ; + /** + * Returns whether a given promise is in the fulfilled state. When the static version is used on non-promises, the result is always true. + */ + export function isFulfilled(promise: Promise): boolean; + /** + * Returns whether a given promise is in the rejected state. When the static version is used on non-promises, the result is always false. + */ + export function isRejected(promise: Promise): boolean; + /** + * Returns whether a given promise is in the pending state. When the static version is used on non-promises, the result is always false. + */ + export function isPending(promise: Promise): boolean; + + /** + * Returns a "deferred" object with a: + * promise property + * resolve(value) method + * reject(reason) method + * notify(value) method + * makeNodeResolver() method + */ + export function defer(): Deferred; + + /** + * Returns a promise that is rejected with reason. + */ + export function reject(reason?: any): Promise; + + export function Promise(resolver: (resolve: (val: T | IPromise) => void , reject: (reason: any) => void , notify: (progress: any) => void ) => void ): Promise; + + /** + * Creates a new version of func that accepts any combination of promise and non-promise values, converting them to their fulfillment values before calling the original func. The returned version also always returns a promise: if func does a return or throw, then Q.promised(func) will return fulfilled or rejected promise, respectively. + * + * This can be useful for creating functions that accept either promises or non-promise values, and for ensuring that the function always returns a promise even in the face of unintentional thrown exceptions. + */ + export function promised(callback: (...args: any[]) => T): (...args: any[]) => Promise; + + /** + * Returns whether the given value is a Q promise. + */ + export function isPromise(object: any): boolean; + /** + * Returns whether the given value is a promise (i.e. it's an object with a then function). + */ + export function isPromiseAlike(object: any): boolean; + /** + * Returns whether a given promise is in the pending state. When the static version is used on non-promises, the result is always false. + */ + export function isPending(object: any): boolean; + /** + * If an object is not a promise, it is as "near" as possible. + * If a promise is rejected, it is as "near" as possible too. + * If it’s a fulfilled promise, the fulfillment value is nearer. + * If it’s a deferred promise and the deferred has been resolved, the + * resolution is "nearer". + */ + export function nearer(promise: Promise): T; + + /** + * This is an experimental tool for converting a generator function into a deferred function. This has the potential of reducing nested callbacks in engines that support yield. + */ + export function async(generatorFunction: any): (...args: any[]) => Promise; + export function nextTick(callback: Function): void; + + /** + * A settable property that will intercept any uncaught errors that would otherwise be thrown in the next tick of the event loop, usually as a result of done. Can be useful for getting the full stack trace of an error in browsers, which is not usually possible with window.onerror. + */ + export var onerror: (reason: any) => void; + /** + * A settable property that lets you turn on long stack trace support. If turned on, "stack jumps" will be tracked across asynchronous promise operations, so that if an uncaught error is thrown by done or a rejection reason's stack property is inspected in a rejection callback, a long stack trace is produced. + */ + export var longStackSupport: boolean; + + /** + * Calling resolve with a pending promise causes promise to wait on the passed promise, becoming fulfilled with its fulfillment value or rejected with its rejection reason (or staying pending forever, if the passed promise does). + * Calling resolve with a rejected promise causes promise to be rejected with the passed promise's rejection reason. + * Calling resolve with a fulfilled promise causes promise to be fulfilled with the passed promise's fulfillment value. + * Calling resolve with a non-promise value causes promise to be fulfilled with that value. + */ + export function resolve(object: IPromise): Promise; + /** + * Calling resolve with a pending promise causes promise to wait on the passed promise, becoming fulfilled with its fulfillment value or rejected with its rejection reason (or staying pending forever, if the passed promise does). + * Calling resolve with a rejected promise causes promise to be rejected with the passed promise's rejection reason. + * Calling resolve with a fulfilled promise causes promise to be fulfilled with the passed promise's fulfillment value. + * Calling resolve with a non-promise value causes promise to be fulfilled with that value. + */ + export function resolve(object: T): Promise; + + /** + * Resets the global "Q" variable to the value it has before Q was loaded. + * This will either be undefined if there was no version or the version of Q which was already loaded before. + * @returns { The last version of Q. } + */ + export function noConflict(): typeof Q; +} + +declare module "q" { + export = Q; +} \ No newline at end of file diff --git a/common-npm-packages/webdeployment-common-v2/typings/globals/q/typings.json b/common-npm-packages/webdeployment-common-v2/typings/globals/q/typings.json new file mode 100644 index 000000000000..3d59355a87e8 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/typings/globals/q/typings.json @@ -0,0 +1,8 @@ +{ + "resolution": "main", + "tree": { + "src": "https://raw.githubusercontent.com/DefinitelyTyped/DefinitelyTyped/623f30ab194a3486e014ca39bc7f2089897d6ce4/q/Q.d.ts", + "raw": "registry:dt/q#0.0.0+20160613154756", + "typings": "https://raw.githubusercontent.com/DefinitelyTyped/DefinitelyTyped/623f30ab194a3486e014ca39bc7f2089897d6ce4/q/Q.d.ts" + } +} diff --git a/common-npm-packages/webdeployment-common-v2/typings/index.d.ts b/common-npm-packages/webdeployment-common-v2/typings/index.d.ts new file mode 100644 index 000000000000..bbb3a42c2b21 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/typings/index.d.ts @@ -0,0 +1,3 @@ +/// +/// +/// diff --git a/common-npm-packages/webdeployment-common-v2/utility.ts b/common-npm-packages/webdeployment-common-v2/utility.ts new file mode 100644 index 000000000000..5725eb189966 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/utility.ts @@ -0,0 +1,222 @@ +import path = require('path'); +import fs = require('fs'); +import tl = require('azure-pipelines-task-lib/task'); +import { PackageUtility, PackageType } from './packageUtility'; + +var zipUtility = require('webdeployment-common-v2/ziputility.js'); +/** + * Validates the input package and finds out input type + * + * @param webDeployPkg Web Deploy Package input + * + * @return true/false based on input package type. + */ +export function isInputPkgIsFolder(webDeployPkg: string) { + if (!tl.exist(webDeployPkg)) { + throw new Error(tl.loc('Invalidwebapppackageorfolderpathprovided', webDeployPkg)); + } + + return !fileExists(webDeployPkg); +} + +/** + * Checks whether the given path is file or not. + * @param path input file path + * + * @return true/false based on input is file or not. + + */ +export function fileExists(path): boolean { + try { + return tl.stats(path).isFile(); + } + catch(error) { + if(error.code == 'ENOENT') { + return false; + } + tl.debug("Exception tl.stats (" + path + "): " + error); + throw Error(error); + } +} + +/** + * Validates whether input for path and returns right path. + * + * @param path input + * + * @returns null when input is empty, otherwise returns same path. + */ +export function copySetParamFileIfItExists(setParametersFile: string) : string { + + if(!setParametersFile || (!tl.filePathSupplied('SetParametersFile')) || setParametersFile == tl.getVariable('System.DefaultWorkingDirectory')) { + setParametersFile = null; + } + else if (!fileExists(setParametersFile)) { + throw Error(tl.loc('SetParamFilenotfound0', setParametersFile)); + } + else if(fileExists(setParametersFile)) { + var tempSetParametersFile = path.join(tl.getVariable('System.DefaultWorkingDirectory'), Date.now() + "_tempSetParameters.xml"); + tl.cp(setParametersFile, tempSetParametersFile, '-f'); + setParametersFile = tempSetParametersFile; + } + + return setParametersFile; +} + +/** + * Checks if WebDeploy should be used to deploy webapp package or folder + * + * @param useWebDeploy if user explicitly checked useWebDeploy + */ +export function canUseWebDeploy(useWebDeploy: boolean) { + var win = tl.osType().match(/^Win/); + return (useWebDeploy || win); +} + + +export function findfiles(filepath){ + + tl.debug("Finding files matching input: " + filepath); + + var filesList : string []; + if (filepath.indexOf('*') == -1 && filepath.indexOf('?') == -1) { + + // No pattern found, check literal path to a single file + if(tl.exist(filepath)) { + filesList = [filepath]; + } + else { + tl.debug('No matching files were found with search pattern: ' + filepath); + return []; + } + } else { + var firstWildcardIndex = function(str) { + var idx = str.indexOf('*'); + + var idxOfWildcard = str.indexOf('?'); + if (idxOfWildcard > -1) { + return (idx > -1) ? + Math.min(idx, idxOfWildcard) : idxOfWildcard; + } + + return idx; + } + + // Find app files matching the specified pattern + tl.debug('Matching glob pattern: ' + filepath); + + // First find the most complete path without any matching patterns + var idx = firstWildcardIndex(filepath); + tl.debug('Index of first wildcard: ' + idx); + var slicedPath = filepath.slice(0, idx); + var findPathRoot = path.dirname(slicedPath); + if(slicedPath.endsWith("\\") || slicedPath.endsWith("/")){ + findPathRoot = slicedPath; + } + + tl.debug('find root dir: ' + findPathRoot); + + // Now we get a list of all files under this root + var allFiles = tl.find(findPathRoot); + + // Now matching the pattern against all files + filesList = tl.match(allFiles, filepath, '', {matchBase: true, nocase: !!tl.osType().match(/^Win/) }); + + // Fail if no matching files were found + if (!filesList || filesList.length == 0) { + tl.debug('No matching files were found with search pattern: ' + filepath); + return []; + } + } + return filesList; +} + +export function generateTemporaryFolderOrZipPath(folderPath: string, isFolder: boolean) { + var randomString = Math.random().toString().split('.')[1]; + var tempPath = path.join(folderPath, 'temp_web_package_' + randomString + (isFolder ? "" : ".zip")); + if(tl.exist(tempPath)) { + return generateTemporaryFolderOrZipPath(folderPath, isFolder); + } + return tempPath; +} + +/** + * Check whether the package contains parameter.xml file + * @param webAppPackage web deploy package + * @returns boolean + */ +export async function isMSDeployPackage(webAppPackage: string ) { + var isParamFilePresent = false; + var pacakgeComponent = await zipUtility.getArchivedEntries(webAppPackage); + if (((pacakgeComponent["entries"].indexOf("parameters.xml") > -1) || (pacakgeComponent["entries"].indexOf("Parameters.xml") > -1)) && + ((pacakgeComponent["entries"].indexOf("systemInfo.xml") > -1) || (pacakgeComponent["entries"].indexOf("systeminfo.xml") > -1) || (pacakgeComponent["entries"].indexOf("SystemInfo.xml") > -1))) { + isParamFilePresent = true; + } + tl.debug("Is the package an msdeploy package : " + isParamFilePresent); + return isParamFilePresent; +} + +export function copyDirectory(sourceDirectory: string, destDirectory: string) { + if(!tl.exist(destDirectory)) { + tl.mkdirP(destDirectory); + } + var listSrcDirectory = tl.find(sourceDirectory); + for(var srcDirPath of listSrcDirectory) { + var relativePath = srcDirPath.substring(sourceDirectory.length); + var destinationPath = path.join(destDirectory, relativePath); + if(tl.stats(srcDirPath).isDirectory()) { + tl.mkdirP(destinationPath); + } + else { + if(!tl.exist(path.dirname(destinationPath))) { + tl.mkdirP(path.dirname(destinationPath)); + } + tl.debug('copy file from: ' + srcDirPath + ' to: ' + destinationPath); + tl.cp(srcDirPath, destinationPath, '-f', false); + } + } +} + +export async function generateTemporaryFolderForDeployment(isFolderBasedDeployment: boolean, webDeployPkg: string, packageType: PackageType) { + var folderName = tl.getVariable('Agent.TempDirectory') ? tl.getVariable('Agent.TempDirectory') : tl.getVariable('System.DefaultWorkingDirectory'); + var folderPath = generateTemporaryFolderOrZipPath(folderName, true); + if(isFolderBasedDeployment || packageType === PackageType.jar) { + tl.debug('Copying Web Packge: ' + webDeployPkg + ' to temporary location: ' + folderPath); + copyDirectory(webDeployPkg, folderPath); + tl.debug('Copied Web Package: ' + webDeployPkg + ' to temporary location: ' + folderPath + ' successfully.'); + } + else { + await zipUtility.unzip(webDeployPkg, folderPath); + } + return folderPath; +} + +export async function archiveFolderForDeployment(isFolderBasedDeployment: boolean, folderPath: string) { + var webDeployPkg; + + if(isFolderBasedDeployment) { + webDeployPkg = folderPath; + } + else { + var tempWebPackageZip = generateTemporaryFolderOrZipPath(tl.getVariable('System.DefaultWorkingDirectory'), false); + webDeployPkg = await zipUtility.archiveFolder(folderPath, "", tempWebPackageZip); + } + + return { + "webDeployPkg": webDeployPkg, + "tempPackagePath": webDeployPkg + }; +} + +export function getFileNameFromPath(filePath: string, extension?: string): string { + var isWindows = tl.osType().match(/^Win/); + var fileName; + if(isWindows) { + fileName = path.win32.basename(filePath, extension); + } + else { + fileName = path.posix.basename(filePath, extension); + } + + return fileName; +} diff --git a/common-npm-packages/webdeployment-common-v2/variableutility.ts b/common-npm-packages/webdeployment-common-v2/variableutility.ts new file mode 100644 index 000000000000..2cd878c06a26 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/variableutility.ts @@ -0,0 +1,35 @@ +import tl = require('azure-pipelines-task-lib'); + +export function isPredefinedVariable(variable: string): boolean { + var predefinedVarPrefix = ['agent.', 'azure_http_user_agent', 'build.', 'common.', 'release.', 'system.', 'tf_']; + for(let varPrefix of predefinedVarPrefix) { + if(variable.toLowerCase().startsWith(varPrefix)) { + return true; + } + } + return false; +} + +export function isEmpty(object){ + if(object == null || object == "" || (object.toString()).trim() == null || (object.toString()).trim() == "") + return true; + return false; +} + +export function isObject(object){ + if(object == null || object == "" || typeof(object) != 'object'){ + return false; + } + return true; +} + +export function getVariableMap() { + var variableMap = {}; + var taskVariables = tl.getVariables(); + for(var taskVariable of taskVariables) { + if(!isPredefinedVariable(taskVariable.name)) { + variableMap[taskVariable.name] = taskVariable.value; + } + } + return variableMap; +} \ No newline at end of file diff --git a/common-npm-packages/webdeployment-common-v2/webconfigutil.ts b/common-npm-packages/webdeployment-common-v2/webconfigutil.ts new file mode 100644 index 000000000000..ff363ffaf280 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/webconfigutil.ts @@ -0,0 +1,134 @@ +import tl = require('azure-pipelines-task-lib/task'); +import fs = require('fs'); +import path = require('path'); +import util = require('util'); + +export function generateWebConfigFile(webConfigTargetPath: string, appType: string, substitutionParameters: any) { + // Get the template path for the given appType + var webConfigTemplatePath = path.join(__dirname, 'WebConfigTemplates', appType.toLowerCase()); + var webConfigContent: string = fs.readFileSync(webConfigTemplatePath, 'utf8'); + webConfigContent = replaceMultiple(webConfigContent, substitutionParameters); + tl.writeFile(webConfigTargetPath, webConfigContent, { encoding: "utf8" }); +} + +function replaceMultiple(text: string, substitutions: any): string { + for(var key in substitutions) { + tl.debug('Replacing: ' + '{' + key + '} with: ' + substitutions[key]); + text = text.replace(new RegExp('{' + key + '}', 'g'), substitutions[key]); + } + return text; +} + +function addMissingParametersValue(appType: string, webConfigParameters) { + var paramDefaultValue = { + 'node': { + 'Handler': 'iisnode', + 'NodeStartFile': 'server.js' + }, + 'python_Bottle': { + 'WSGI_HANDLER': 'app.wsgi_app()', + 'PYTHON_PATH': 'D:\\home\\python353x86\\python.exe', + 'PYTHON_WFASTCGI_PATH': 'D:\\home\\python353x86\\wfastcgi.py' + }, + 'python_Django': { + 'WSGI_HANDLER': 'django.core.wsgi.get_wsgi_application()', + 'PYTHON_PATH': 'D:\\home\\python353x86\\python.exe', + 'PYTHON_WFASTCGI_PATH': 'D:\\home\\python353x86\\wfastcgi.py', + 'DJANGO_SETTINGS_MODULE': '' + }, + 'python_Flask': { + 'WSGI_HANDLER': 'main.app', + 'PYTHON_PATH': 'D:\\home\\python353x86\\python.exe', + 'PYTHON_WFASTCGI_PATH': 'D:\\home\\python353x86\\wfastcgi.py', + 'STATIC_FOLDER_PATH': 'static' + }, + 'Go': { + 'GoExeFilePath': '' + }, + 'java_springboot': { + 'JAVA_PATH' : '%JAVA_HOME%\\bin\\java.exe', + 'JAR_PATH' : '', + 'ADDITIONAL_DEPLOYMENT_OPTIONS' : '' + } + }; + + var selectedAppTypeParams = paramDefaultValue[appType]; + var resultAppTypeParams = {}; + for(var paramAtttribute in selectedAppTypeParams) { + if(webConfigParameters[paramAtttribute]) { + tl.debug("param Attribute'" + paramAtttribute + "' values provided as: " + webConfigParameters[paramAtttribute].value); + resultAppTypeParams[paramAtttribute] = webConfigParameters[paramAtttribute].value; + } + else { + tl.debug("param Attribute '" + paramAtttribute + "' is not provided. Overriding the value with '" + selectedAppTypeParams[paramAtttribute]+ "'"); + resultAppTypeParams[paramAtttribute] = selectedAppTypeParams[paramAtttribute]; + } + } + return resultAppTypeParams; +} +export function addWebConfigFile(folderPath: any, webConfigParameters, rootDirectoryPath: string) { + //Generate the web.config file if it does not already exist. + var webConfigPath = path.join(folderPath, "web.config"); + if (!tl.exist(webConfigPath)) { + try { + var supportedAppTypes = ['node', 'python_Bottle', 'python_Django', 'python_Flask', 'Go', 'java_springboot'] + // Create web.config + tl.debug('web.config file does not exist. Generating.'); + if(!webConfigParameters['appType']) { + throw new Error(tl.loc("MissingAppTypeWebConfigParameters")); + } + + var appType: string = webConfigParameters['appType'].value; + if(supportedAppTypes.indexOf(appType) === -1) { + throw Error(tl.loc('UnsupportedAppType', appType)); + } + tl.debug('Generating Web.config file for App type: ' + appType); + delete webConfigParameters['appType']; + + var selectedAppTypeParams = addMissingParametersValue(appType, webConfigParameters); + if(appType.startsWith("python")) { + tl.debug('Root Directory path to be set on web.config: ' + rootDirectoryPath); + selectedAppTypeParams['KUDU_WORKING_DIRECTORY'] = rootDirectoryPath; + if(appType === 'python_Django' && webConfigParameters['DJANGO_SETTINGS_MODULE'].value === '') { + tl.debug('Auto detecting settings.py to set DJANGO_SETTINGS_MODULE...'); + selectedAppTypeParams['DJANGO_SETTINGS_MODULE'] = getDjangoSettingsFile(folderPath); + } + } else if(appType == 'Go') { + if (util.isNullOrUndefined(webConfigParameters['GoExeFileName']) + || util.isNullOrUndefined(webConfigParameters['GoExeFileName'].value) + || webConfigParameters['GoExeFileName'].value.length <=0) { + throw Error(tl.loc('GoExeNameNotPresent')); + } + selectedAppTypeParams['GoExeFilePath'] = rootDirectoryPath + "\\" + webConfigParameters['GoExeFileName'].value; + } else if(appType == 'java_springboot') { + if (util.isNullOrUndefined(webConfigParameters['JAR_PATH']) + || util.isNullOrUndefined(webConfigParameters['JAR_PATH'].value) + || webConfigParameters['JAR_PATH'].value.length <= 0) { + throw Error(tl.loc('JarPathNotPresent')); + } + selectedAppTypeParams['JAR_PATH'] = rootDirectoryPath + "\\" + webConfigParameters['JAR_PATH'].value; + } + + generateWebConfigFile(webConfigPath, appType, selectedAppTypeParams); + console.log(tl.loc("SuccessfullyGeneratedWebConfig")); + } + catch (error) { + throw new Error(tl.loc("FailedToGenerateWebConfig", error)); + } + } + else { + console.log(tl.loc('WebConfigAlreadyExists')); + } +} + +function getDjangoSettingsFile(folderPath: string) { + var listDirFiles = tl.ls('', [folderPath]); + for(var listDirFile of listDirFiles) { + tl.debug('Searching for settings.py in ' + path.join(folderPath, listDirFile)); + if(!tl.stats(path.join(folderPath, listDirFile)).isFile() && tl.exist(path.join(folderPath, listDirFile, 'settings.py'))) { + tl.debug('Found DJANGO_SETTINGS_MODULE in ' + listDirFile + ' folder'); + return listDirFile + '.settings'; + } + } + throw tl.loc('AutoDetectDjangoSettingsFailed'); +} \ No newline at end of file diff --git a/common-npm-packages/webdeployment-common-v2/xdttransformationutility.ts b/common-npm-packages/webdeployment-common-v2/xdttransformationutility.ts new file mode 100644 index 000000000000..d48851bfa382 --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/xdttransformationutility.ts @@ -0,0 +1,136 @@ +import tl = require('azure-pipelines-task-lib/task'); +import trm = require('azure-pipelines-task-lib/toolrunner'); +import path = require('path'); + +export function expandWildcardPattern(folderPath: string, wildcardPattern : string) { + var matchingFiles = tl.findMatch(folderPath, wildcardPattern, { followSymbolicLinks: false, allowBrokenSymbolicLinks: false, followSpecifiedSymbolicLink: false }); + var filesList = {}; + for (let i = 0; i < matchingFiles.length; i++) { + matchingFiles[i] = matchingFiles[i].replace(/\//g, '\\'); + filesList[matchingFiles[i].toLowerCase()] = matchingFiles[i]; + } + + return filesList; +} + +/** +* Applys XDT transform on Source file using the Transform file +* +* @param sourceFile Source Xml File +* @param tansformFile Transform Xml File +* +*/ +export function applyXdtTransformation(sourceFile: string, transformFile: string, destinationFile?: string) { + + var cttPath = path.join(__dirname, "..", "..", "ctt", "ctt.exe"); + var cttArgsArray= [ + "s:" + sourceFile, + "t:" + transformFile, + "d:" + (destinationFile ? destinationFile : sourceFile), + "pw", + "i", + "verbose" + ]; + + tl.debug("Running command: " + cttPath + ' ' + cttArgsArray.join(' ')); + var cttExecutionResult = tl.execSync(cttPath, cttArgsArray); + if(cttExecutionResult.stderr) { + throw new Error(tl.loc("XdtTransformationErrorWhileTransforming", sourceFile, transformFile)); + } +} + +/** +* Performs XDT transformations on *.config using ctt.exe +* +* @param sourcePattern The source wildcard pattern on which the transforms need to be applied +* @param transformConfigs The array of transform config names, ex : ["Release.config", "EnvName.config"] +* +*/ +export function basicXdtTransformation(rootFolder, transformConfigs): boolean { + var sourceXmlFiles = expandWildcardPattern(rootFolder, '**/*.config'); + var isTransformationApplied = false; + Object.keys(sourceXmlFiles).forEach( function(sourceXmlFile) { + sourceXmlFile = sourceXmlFiles[sourceXmlFile]; + var sourceBasename = path.win32.basename(sourceXmlFile.replace(/\.config/ig,'\.config'), ".config"); + transformConfigs.forEach( function(transformConfig) { + var transformXmlFile = path.join(path.dirname(sourceXmlFile), sourceBasename + "." + transformConfig); + if(sourceXmlFiles[transformXmlFile.toLowerCase()]) { + tl.debug('Applying XDT Transformation : ' + transformXmlFile + ' -> ' + sourceXmlFile); + applyXdtTransformation(sourceXmlFile, transformXmlFile); + isTransformationApplied = true; + } + }); + }); + if(!isTransformationApplied) { + tl.warning(tl.loc('FailedToApplyTransformation')); + tl.warning(tl.loc('FailedToApplyTransformationReason1')); + tl.warning(tl.loc('FailedToApplyTransformationReason2')); + } + + return isTransformationApplied; +} + + +/** +* Performs XDT transformations using ctt.exe +* +*/ +export function specialXdtTransformation(rootFolder, transformConfig, sourceConfig, destinationConfig?: string): boolean { + var sourceXmlFiles = expandWildcardPattern(rootFolder, sourceConfig); + var isTransformationApplied = false; + + for(var sourceXmlFile in sourceXmlFiles) { + sourceXmlFile = sourceXmlFiles[sourceXmlFile]; + var sourceBasename = "", transformXmlFiles = {}; + + if(sourceConfig.indexOf("*") != -1){ + var sourceConfigSuffix = sourceConfig.substr(sourceConfig.lastIndexOf("*") + 1); + if(sourceConfigSuffix.indexOf("\\") != -1) { + sourceConfigSuffix = sourceConfigSuffix.substr(sourceConfigSuffix.lastIndexOf("\\") + 1); + } + sourceBasename = path.win32.basename(sourceXmlFile.replace(/\.config/ig,'\.config'), sourceConfigSuffix); + if(JSON.stringify(sourceBasename) == JSON.stringify(sourceConfigSuffix)) { + sourceBasename = ""; + } + } + + if(transformConfig.indexOf("*") != -1){ + if(sourceBasename) { + var transformConfigSuffix = transformConfig.substr(transformConfig.lastIndexOf("*") + 1); + if(transformConfigSuffix.indexOf("\\") != -1) { + transformConfigSuffix = transformConfigSuffix.substr(transformConfigSuffix.lastIndexOf("\\") + 1); + } + var transformXmlFile = path.join(path.dirname(sourceXmlFile), sourceBasename + transformConfigSuffix); + transformXmlFiles[transformXmlFile.toLowerCase()] = transformXmlFile; + } + else { + var transformXmlFiles = expandWildcardPattern(rootFolder, transformConfig); + } + } + else { + transformXmlFile = path.join(rootFolder, transformConfig); + transformXmlFiles[transformXmlFile.toLowerCase()] = transformXmlFile; + } + + var destinationXmlFile = ""; + if(destinationConfig){ + if(destinationConfig.indexOf("*") != -1){ + var destinationConfigSuffix = destinationConfig.substr(destinationConfig.lastIndexOf("*") + 1); + destinationXmlFile = path.join(path.dirname(sourceXmlFile), sourceBasename + destinationConfigSuffix); + } + else { + destinationXmlFile = path.join(rootFolder, destinationConfig); + } + } + + for(var transformXmlFile in transformXmlFiles) { + if(sourceXmlFiles[transformXmlFile.toLowerCase()] || tl.exist(transformXmlFile)) { + console.log(tl.loc('ApplyingXDTtransformation' , transformXmlFile , sourceXmlFile)); + applyXdtTransformation(sourceXmlFile, transformXmlFile, destinationXmlFile); + isTransformationApplied = true; + } + } + } + + return isTransformationApplied; +} \ No newline at end of file diff --git a/common-npm-packages/webdeployment-common-v2/xmlvariablesubstitutionutility.ts b/common-npm-packages/webdeployment-common-v2/xmlvariablesubstitutionutility.ts new file mode 100644 index 000000000000..9e92691d069a --- /dev/null +++ b/common-npm-packages/webdeployment-common-v2/xmlvariablesubstitutionutility.ts @@ -0,0 +1,316 @@ +import tl = require('azure-pipelines-task-lib/task'); +import fs = require('fs'); +import path = require('path'); + +var varUtility = require ('./variableutility.js'); +var ltxdomutility = require("./ltxdomutility.js"); +var npmdomutility = require("./npmdomutility.js"); +var fileEncoding = require('./fileencoding.js'); + +function getReplacableTokenFromTags(xmlNode, variableMap) { + var parameterSubValue = {}; + if(xmlNode.childNodes) { + var children = xmlNode.childNodes; + for (let childs = 0; childs < children.length; childs ++) { + let childNode = children[childs]; + if ((varUtility.isObject(childNode)) && (!varUtility.isEmpty(childNode))) { + if(childNode.attributes) { + let childNodeAttributes = childNode.attributes; + let childNodeAttributeName; + for (let nodeAttribute=0 ; nodeAttribute tl.exist(path) && tl.rmRF(path); + +const extractUsing7zip = async (fromFile: string, toDir: string) => { + tl.debug('Using 7zip tool for extracting'); + var win7zipLocation = path.join(__dirname, '7zip/7z.exe'); + await tl.tool(win7zipLocation) + .arg([ 'x', `-o${toDir}`, fromFile ]) + .exec(); +} + +const extractUsingUnzip = async (fromFile: string, toDir: string) => { + tl.debug('Using unzip tool for extracting'); + var unzipToolLocation = tl.which('unzip', true); + await tl.tool(unzipToolLocation) + .arg([ fromFile, '-d', toDir ]) + .exec(); +} + +export async function unzip(zipFileLocation: string, unzipDirLocation: string) { + deleteDir(unzipDirLocation); + const isWin = tl.getPlatform() === tl.Platform.Windows; + tl.debug('win: ' + isWin); + tl.debug('extracting ' + zipFileLocation + ' to ' + unzipDirLocation); + const extractor = isWin ? extractUsing7zip : extractUsingUnzip; + await extractor(zipFileLocation, unzipDirLocation); + tl.debug('extracted ' + zipFileLocation + ' to ' + unzipDirLocation + ' Successfully'); +} + +export async function archiveFolder(folderPath, targetPath, zipName) { + var defer = Q.defer(); + tl.debug('Archiving ' + folderPath + ' to ' + zipName); + var outputZipPath = path.join(targetPath, zipName); + var output = fs.createWriteStream(outputZipPath); + var archive = archiver('zip'); + output.on('close', function () { + tl.debug('Successfully created archive ' + zipName); + defer.resolve(outputZipPath); + }); + + output.on('error', function(error) { + defer.reject(error); + }); + + archive.pipe(output); + archive.directory(folderPath, '/'); + archive.finalize(); + + return defer.promise; +} + +/** + * Returns array of files present in archived package + */ +export async function getArchivedEntries(archivedPackage: string) { + var deferred = Q.defer(); + var unzipper = new DecompressZip(archivedPackage); + unzipper.on('error', function (error) { + deferred.reject(error); + }); + unzipper.on('list', function (files) { + var packageComponent = { + "entries":files + }; + deferred.resolve(packageComponent); + }); + unzipper.list(); + return deferred.promise; +} +