Merge pull request #137 from codecov/refactor-src

chore: refactor source with new commands subfolder
codecov · Jun 17, 2022 · 54eb81c · 54eb81c
2 parents 3bf44d6 + 1ebdd04
commit 54eb81c
Show file tree

Hide file tree

Showing 19 changed files with 125 additions and 108 deletions.
diff --git a/src/__init__.py → app/__init__.py b/src/__init__.py → app/__init__.py
diff --git a/src/adder/__init__.py → app/adder/__init__.py b/src/adder/__init__.py → app/adder/__init__.py
diff --git a/src/adder/adder.py → app/adder/adder.py b/src/adder/adder.py → app/adder/adder.py
diff --git a/src/calculator/calc.js → app/calculator/calc.js b/src/calculator/calc.js → app/calculator/calc.js
diff --git a/src/calculator/calc.js.map → app/calculator/calc.js.map b/src/calculator/calc.js.map → app/calculator/calc.js.map
diff --git a/src/calculator/calc.ts → app/calculator/calc.ts b/src/calculator/calc.ts → app/calculator/calc.ts
diff --git a/src/subtractor/__init__.py → app/subtractor/__init__.py b/src/subtractor/__init__.py → app/subtractor/__init__.py
diff --git a/src/subtractor/subtractor.py → app/subtractor/subtractor.py b/src/subtractor/subtractor.py → app/subtractor/subtractor.py
diff --git a/src/@orb.yml b/src/@orb.yml
@@ -1,4 +1,3 @@
----
 version: 2.1
 
 description: >
@@ -11,103 +10,3 @@ description: >
 display:
   source_url: https://github.com/codecov/codecov-circleci-orb
   home_url: https://codecov.io/
-
-commands:
-  upload:
-    parameters:
-      file:
-        description: Path to the code coverage data file to upload.
-        type: string
-        default: ""
-      flags:
-        description: Flag the upload to group coverage metrics (e.g. unittests
-          | integration | ui,chrome)
-        type: string
-        default: ""
-      token:
-        description: Set the private repository token as the value of the
-          variable CODECOV_TOKEN using CircleCI Environment Variables.
-        type: env_var_name
-        default: CODECOV_TOKEN
-      upload_name:
-        description: Custom defined name of the upload. Visible in Codecov UI
-        type: string
-        default: ${CIRCLE_BUILD_NUM}
-      validate:
-        description: Validate the uploader before uploading the codecov result.
-        type: boolean
-        default: true
-      when:
-        description: When should this step run?
-        type: string
-        default: "always"
-      xtra_args:
-        description: Any extra flags as provided by the bash uploader
-          (e.g. `-v -Z`).
-        type: string
-        default: ""
-      version:
-        description: Which version of the Codecov Uploader to use (defaults to
-          'latest')
-        type: string
-        default: "latest"
-    steps:
-      - run:
-          name: Download Codecov Uploader
-          command: |
-            family=$(uname -s | tr '[:upper:]' '[:lower:]')
-            os="windows"
-            [[ $family == "darwin" ]] && os="macos"
-
-            [[ $family == "linux" ]] && os="linux"
-            [[ $os == "linux" ]] && \
-              osID=$(grep -e "^ID=" /etc/os-release | cut -c4-)
-            [[ $osID == "alpine" ]] && os="alpine"
-            echo "Detected ${os}"
-            echo "export os=${os}" >> $BASH_ENV
-
-            filename="codecov"
-            [[ $os == "windows" ]] && filename+=".exe"
-            echo "export filename=${filename}" >> $BASH_ENV
-            [[ $os == "macos" ]] && \
-              HOMEBREW_NO_AUTO_UPDATE=1 brew install gpg
-            codecov_url="https://uploader.codecov.io"
-            codecov_url="$codecov_url/<< parameters.version >>"
-            codecov_url="$codecov_url/${os}/${filename}"
-            curl -Os $codecov_url
-          when: << parameters.when >>
-      - when:
-          condition: << parameters.validate >>
-          steps:
-            - run:
-                name: Validate Codecov Uploader
-                command: |
-                  source $BASH_ENV
-                  curl https://keybase.io/codecovsecurity/pgp_keys.asc | \
-                    gpg --no-default-keyring --keyring trustedkeys.gpg --import
-                  # One-time step
-                  sha_url="https://uploader.codecov.io"
-                  sha_url="$sha_url/<< parameters.version>>/${os}"
-                  sha_url="$sha_url/${filename}.SHA256SUM"
-                  curl -Os $sha_url
-                  curl -Os $sha_url".sig"
-                  gpgv $filename.SHA256SUM.sig $filename.SHA256SUM
-                  shasum -a 256 -c $filename.SHA256SUM || \
-                    sha256sum -c $filename.SHA256SUM
-      - run:
-          name: Upload Coverage Results
-          command: |
-            unset NODE_OPTIONS
-            # See https://github.com/codecov/uploader/issues/475
-            source $BASH_ENV
-            chmod +x $filename
-            [ -n "<< parameters.file >>" ] && \
-              set - "${@}" "-f" "<< parameters.file >>"
-            [ -n "<< parameters.xtra_args >>" ] && \
-              set - "${@}" "<< parameters.xtra_args >>"
-            ./$filename \
-              -Q "codecov-circleci-orb-3.2.3" \
-              -t "${<< parameters.token >>}" \
-              -n "<< parameters.upload_name >>" \
-              -F "<< parameters.flags >>" \
-              ${@}
diff --git a/src/commands/upload.yml b/src/commands/upload.yml
@@ -0,0 +1,68 @@
+description: |
+  Upload your coverage reports to Codecov without dealing with complex
+  configurations. This orb helps you get coverage results quickly so that you
+  can breathe easier and commit your code with confidence.
+
+  If running on `alpine` builds, the orb will need `coreutils`, `curl`, and
+  `gnupg` in order to validate.
+
+parameters:
+  file:
+    description: Path to the code coverage data file to upload.
+    type: string
+    default: ""
+  flags:
+    description: Flag the upload to group coverage metrics (e.g. unittests
+      | integration | ui,chrome)
+    type: string
+    default: ""
+  token:
+    description: Set the private repository token as the value of the
+      variable CODECOV_TOKEN using CircleCI Environment Variables.
+    type: env_var_name
+    default: CODECOV_TOKEN
+  upload_name:
+    description: Custom defined name of the upload. Visible in Codecov UI
+    type: string
+    default: ${CIRCLE_BUILD_NUM}
+  validate:
+    description: Validate the uploader before uploading the codecov result.
+    type: boolean
+    default: true
+  when:
+    description: When should this step run?
+    type: string
+    default: "always"
+  xtra_args:
+    description: Any extra flags as provided by the bash uploader
+      (e.g. `-v -Z`).
+    type: string
+    default: ""
+  version:
+    description: Which version of the Codecov Uploader to use (defaults to
+      'latest')
+    type: string
+    default: "latest"
+
+steps:
+  - run:
+      name: Download Codecov Uploader
+      command: <<include(scripts/download.sh)>>
+      when: << parameters.when >>
+      environment:
+        PARAM_VERSION: << parameters.version >>
+  - when:
+      condition: << parameters.validate >>
+      steps:
+        - run:
+            name: Validate Codecov Uploader
+            command: <<include(scripts/validate.sh)>>
+  - run:
+      name: Upload Coverage Results
+      command: <<include(scripts/upload.sh)>>
+      environment:
+        PARAM_FILE: << parameters.file >>
+        PARAM_FLAGS: << parameters.flags >>
+        PARAM_TOKEN: << parameters.token >>
+        PARAM_UPLOAD_NAME: << parameters.upload_name >>
+        PARAM_XTRA_ARGS: << parameters.xtra_args >>
diff --git a/src/examples/basic_upload.yml b/src/examples/basic_upload.yml
@@ -5,7 +5,7 @@ description: >
 usage:
   version: 2.1
   orbs:
-    codecov: codecov/codecov@3.1.1
+    codecov: codecov/codecov@3.2.3
   workflows:
     upload-to-codecov:
       jobs:

diff --git a/src/examples/node_test_upload.yml b/src/examples/node_test_upload.yml
@@ -7,7 +7,7 @@ usage:
   version: 2.1
   orbs:
     node: circleci/node@4.7.0
-    codecov: codecov/codecov@3.1.1
+    codecov: codecov/codecov@3.2.3
   workflows:
     upload-to-codecov:
       jobs:

diff --git a/src/scripts/download.sh b/src/scripts/download.sh
@@ -0,0 +1,22 @@
+family=$(uname -s | tr '[:upper:]' '[:lower:]')
+os="windows"
+[[ $family == "darwin" ]] && os="macos"
+
+[[ $family == "linux" ]] && os="linux"
+[[ $os == "linux" ]] && \
+  osID=$(grep -e "^ID=" /etc/os-release | cut -c4-)
+[[ $osID == "alpine" ]] && os="alpine"
+echo "Detected ${os}"
+echo "export os=${os}" >> $BASH_ENV
+echo "export version=${PARAM_VERSION}" >> $BASH_ENV
+
+filename="codecov"
+[[ $os == "windows" ]] && filename+=".exe"
+echo "export filename=${filename}" >> $BASH_ENV
+[[ $os == "macos" ]] && \
+  HOMEBREW_NO_AUTO_UPDATE=1 brew install gpg
+codecov_url="https://uploader.codecov.io"
+codecov_url="$codecov_url/${PARAM_VERSION}"
+codecov_url="$codecov_url/${os}/${filename}"
+echo "Downloading ${codecov_url}"
+curl -Os $codecov_url -v
diff --git a/src/scripts/upload.sh b/src/scripts/upload.sh
@@ -0,0 +1,15 @@
+unset NODE_OPTIONS
+# See https://github.com/codecov/uploader/issues/475
+source $BASH_ENV
+chmod +x $filename
+[ -n "${PARAM_FILE}" ] && \
+  set - "${@}" "-f" "${PARAM_FILE}"
+[ -n "${PARAM_XTRA_ARGS}" ] && \
+  set - "${@}" "${PARAM_XTRA_ARGS}"
+# alpine doesn't allow for indirect expansion
+./"$filename" \
+  -Q "codecov-circleci-orb-3.2.3" \
+  -t "$(eval echo \$$PARAM_TOKEN)" \
+  -n "${PARAM_UPLOAD_NAME}" \
+  -F "${PARAM_FLAGS}" \
+  ${@}
diff --git a/src/scripts/validate.sh b/src/scripts/validate.sh
@@ -0,0 +1,13 @@
+source $BASH_ENV
+curl https://keybase.io/codecovsecurity/pgp_keys.asc | \
+  gpg --no-default-keyring --keyring trustedkeys.gpg --import
+# One-time step
+sha_url="https://uploader.codecov.io"
+sha_url="$sha_url/${version}/${os}"
+sha_url="$sha_url/${filename}.SHA256SUM"
+echo "Downloading ${sha_url}"
+curl -Os $sha_url
+curl -Os $sha_url".sig"
+gpgv $filename.SHA256SUM.sig $filename.SHA256SUM
+shasum -a 256 -c $filename.SHA256SUM || \
+  sha256sum -c $filename.SHA256SUM
diff --git a/test/calc.spec.js b/test/calc.spec.js
diff --git a/test/calc.spec.ts b/test/calc.spec.ts
@@ -1,4 +1,4 @@
-import Calculator from '../src/calculator/calc'
+import Calculator from '../app/calculator/calc'
 import { expect } from 'chai'
 
 describe('Calculator', () => {

diff --git a/test/unit/adder/test_adder.py b/test/unit/adder/test_adder.py
@@ -1,6 +1,6 @@
 import unittest
 
-from src.adder.adder import Adder
+from app.adder.adder import Adder
 
 
 class TestAdderMethods(unittest.TestCase):

diff --git a/test/unit/subtractor/test_subtractor.py b/test/unit/subtractor/test_subtractor.py
@@ -1,6 +1,6 @@
 import unittest
 
-from src.subtractor.subtractor import Subtractor
+from app.subtractor.subtractor import Subtractor
 
 
 class TestSubtractorMethods(unittest.TestCase):