Merge branch 'package_individually_like_base_sls' of https://github.com/bweigel/serverless-python-requirements into package_individually_like_base_sls

Author: bweigel

README.md

@@ -72,6 +72,15 @@ It is important that the host of your private repositories has already been adde
 `$HOME/.ssh/known_hosts` file, as the install process will fail otherwise due to host authenticity
 failure.
 
+You can also pass environment variables to docker by specifying them in `dockerEnv`
+option:
+```yaml
+custom:
+  pythonRequirements:
+    dockerEnv:
+      - https_proxy
+```
+
 [:checkered_flag: Windows notes](#checkered_flag-windows-dockerizepip-notes)
 
 ## Pipenv support :sparkles::cake::sparkles:

index.js

@@ -42,6 +42,7 @@ class ServerlessPythonRequirements {
         dockerSsh: false,
         dockerImage: null,
         dockerFile: null,
+        dockerEnv: false,
         useStaticCache: false,
         useDownloadCache: false,
         cacheLocation: false,

lib/inject.js

@@ -50,25 +50,15 @@ function injectRequirements(requirementsPath, packagePath, options) {
  * @param {string} module module to keep
  * @return {Promise} the JSZip object written out.
  */
-function moveModuleUp(source, target, module, options) {
+function injectSourceCode(source, target, module) {
   const targetZip = new JSZip();
 
   return fse
     .readFileAsync(source)
     .then(buffer => JSZip.loadAsync(buffer))
-    .then(sourceZip => sourceZip.filter(file => file.startsWith(module + '/')))
+    .then(sourceZip => sourceZip.filter(() => true))
     .map(srcZipObj => {
-      let targetName;
-
-      if (
-        options.IndividuallyMoveUpModules === true ||
-        options.IndividuallyMoveUpModules == 'true'
-      ) {
-        targetName = srcZipObj.name.replace(module + '/', '');
-      } else {
-        targetName = srcZipObj.name;
-      }
-
+      let targetName = srcZipObj.name.replace(module + '/', '');
       return zipFile(targetZip, targetName, srcZipObj.async('nodebuffer'));
     })
     .then(() => writeZip(targetZip, target));
@@ -95,19 +85,26 @@ function injectAllRequirements(funcArtifact) {
         return func;
       })
       .map(func => {
-        if (func.module !== '.') {
+        if (
+          this.options.IndividuallyMoveUpModules === true ||
+          this.options.IndividuallyMoveUpModules === 'true'
+        ) {
           const artifact = func.package ? func.package.artifact : funcArtifact;
-          const newArtifact = path.join(
-            '.serverless',
-            `${func.module}-${func.name}.zip`
-          );
+
+          let newArtifact;
+          if (func.module === '.') {
+            newArtifact = path.join('.serverless', `root-${func.name}.zip`);
+          } else {
+            newArtifact = path.join(
+              '.serverless',
+              `${func.module}-${func.name}.zip`
+            );
+          }
+
           func.package.artifact = newArtifact;
-          return moveModuleUp(
-            artifact,
-            newArtifact,
-            func.module,
-            this.options
-          ).then(() => func);
+          return injectSourceCode(artifact, newArtifact, func.module).then(
+            () => func
+          );
         } else {
           return func;
         }

lib/pip.js

@@ -27,15 +27,19 @@ function quote_single(quoteme) {
  * @param {Object} options
  * @return {undefined}
  */
-function installRequirementsFile(
+function generateRequirementsFile(
   requirementsPath,
   targetFile,
   serverless,
   servicePath,
   options
 ) {
   if (options.usePipenv && fse.existsSync(path.join(servicePath, 'Pipfile'))) {
-    generateRequirementsFile(
+    filterRequirementsFile(
+      /*
+      TODO: this is supposed to generate a requirements.txt from Pipfile, 
+      but source and target are basicalle the same
+      */
       path.join(servicePath, '.serverless/requirements.txt'),
       targetFile,
       options
@@ -44,7 +48,7 @@ function installRequirementsFile(
       `Parsed requirements.txt from Pipfile in ${targetFile}...`
     );
   } else {
-    generateRequirementsFile(requirementsPath, targetFile, options);
+    filterRequirementsFile(requirementsPath, targetFile, options);
     serverless.cli.log(
       `Generated requirements from ${requirementsPath} in ${targetFile}...`
     );
@@ -196,6 +200,13 @@ function installRequirements(targetFolder, serverless, options) {
       pipCmd.push('--cache-dir', quote_single(dockerDownloadCacheDir));
     }
 
+    if (options.dockerEnv) {
+      // Add environment variables to docker run cmd
+      options.dockerEnv.forEach(function(item) {
+        cmdOptions.push('-e', item);
+      });
+    }
+
     if (process.platform === 'linux') {
       // Use same user so requirements folder is not root and so --cache-dir works
       var commands = [];
@@ -293,7 +304,7 @@ function dockerPathForWin(options, path) {
  * @param {string} target requirements where results are written
  * @param {Object} options
  */
-function generateRequirementsFile(source, target, options) {
+function filterRequirementsFile(source, target, options) {
   const noDeploy = new Set(options.noDeploy || []);
   const requirements = fse
     .readFileSync(source, { encoding: 'utf-8' })
@@ -374,11 +385,26 @@ function installRequirementsIfNeeded(
   // Our source requirements, under our service path, and our module path (if specified)
   const fileName = path.join(servicePath, modulePath, options.fileName);
 
-  // First, generate the requirements file to our local .serverless folder
-  fse.ensureDirSync(path.join(servicePath, '.serverless'));
-  const slsReqsTxt = path.join(servicePath, '.serverless', 'requirements.txt');
+  // Skip requirements generation, if requirements file doesn't exist
+  if (!fse.existsSync(fileName)) {
+    return false;
+  }
 
-  installRequirementsFile(
+  let requirementsTxtDirectory;
+  // Copy our requirements to another filename in .serverless (incase of individually packaged)
+  if (modulePath && modulePath != '.') {
+    requirementsTxtDirectory = path.join(
+      servicePath,
+      '.serverless',
+      modulePath
+    );
+  } else {
+    requirementsTxtDirectory = path.join(servicePath, '.serverless');
+  }
+  fse.ensureDirSync(requirementsTxtDirectory);
+  const slsReqsTxt = path.join(requirementsTxtDirectory, 'requirements.txt');
+
+  generateRequirementsFile(
     fileName,
     slsReqsTxt,
     serverless,
@@ -394,28 +420,13 @@ function installRequirementsIfNeeded(
     return false;
   }
 
-  // Copy our requirements to another filename in .serverless (incase of individually packaged)
-  if (modulePath && modulePath != '.') {
-    fse.existsSync(path.join(servicePath, '.serverless', modulePath));
-    const destinationFile = path.join(
-      servicePath,
-      '.serverless',
-      modulePath,
-      'requirements.txt'
-    );
-    serverless.cli.log(
-      `Copying from ${slsReqsTxt} into ${destinationFile} ...`
-    );
-    fse.copySync(slsReqsTxt, destinationFile);
-  }
-
   // Then generate our MD5 Sum of this requirements file to determine where it should "go" to and/or pull cache from
   const reqChecksum = md5Path(slsReqsTxt);
 
   // Then figure out where this cache should be, if we're caching, if we're in a module, etc
   const workingReqsFolder = getRequirementsWorkingPath(
     reqChecksum,
-    servicePath,
+    requirementsTxtDirectory,
     options
   );
 

lib/shared.js

@@ -57,7 +57,11 @@ function checkForAndDeleteMaxCacheVersions(options, serverless) {
  * @param  {Object} options
  * @return {string}
  */
-function getRequirementsWorkingPath(subfolder, servicePath, options) {
+function getRequirementsWorkingPath(
+  subfolder,
+  requirementsTxtDirectory,
+  options
+) {
   // If we want to use the static cache
   if (options && options.useStaticCache) {
     if (subfolder) {
@@ -69,7 +73,7 @@ function getRequirementsWorkingPath(subfolder, servicePath, options) {
   }
 
   // If we don't want to use the static cache, then fallback to the way things used to work
-  return path.join(servicePath, '.serverless', 'requirements');
+  return path.join(requirementsTxtDirectory, 'requirements');
 }
 
 /**