fastlane-plugin-appcenter 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39cd3b20f7c98ea0ac0068fdcdb5e8528b763e747efba88d4c6f8da48f902d6d
-  data.tar.gz: ca7d95d7ed15b4b5aef398dbfc7d83ef318cf7bb976d8551733950b25bf80fec
+  metadata.gz: 172c940fc1d03ac4d3951cffc2c0f1c1d1b78ee25967f464d0a1058f12d7c7b9
+  data.tar.gz: f6835efe4d035061a6c8834e27c355817061835c9be067fe2090b2ae9dd3b65a
 SHA512:
-  metadata.gz: c4f6ae8f7f2b77e0546aa65897362f64959be25b3475c364a85cd3371da31ea3b8b9a8dbc7d77232bdc69172ba34faf61354b5e9b6ea24838e8cab6d14ee418c
-  data.tar.gz: de52913eb094b8592428f60835691873e5ad306b5885de6a1bf7b048cdbfcddc69067cc60806bf1306bee40ed5b9aba5e1d5911fca3315859a024c5a57d924c8
+  metadata.gz: 9060632241323fe3a7cbc412b77cbbe457819277176e06a00fdbf155ef72c01aa19453a626214003b211bee5a9388fd4ce509b97a823489e0d9022674b14e908
+  data.tar.gz: 68fce7a6a0755c2fe71363e7f85d1f88d44f3303d7a94876c15d57d810033021ad410461fb399b91fee82aae4710fe1740a033967c2576245495f12360dd2a48

data/README.md

@@ -12,6 +12,8 @@ This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To
 fastlane add_plugin appcenter
 ```
 
+fastlane v2.96.0 or higher is required for all plugin-actions to function properly.
+
 ## About App Center
 With [App Center](https://appcenter.ms) you can continuously build, test, release, and monitor your apps. This plugin provides a set of actions to interact with App Center.
 
@@ -27,6 +29,7 @@ To get started, first, [obtain an API token](https://appcenter.ms/settings/apito
 appcenter_fetch_devices(
   api_token: "<appcenter token>",
   owner_name: "<appcenter account name of the owner of the app (username or organization URL name)>",
+  owner_type: "user", # Default is user - set to organization for appcenter organizations
   app_name: "<appcenter app name>",
   destinations: "*", # Default is 'Collaborators', use '*' for all distribution groups
   devices_file: "devices.txt" # Default. If you customize, the extension must be .txt
@@ -36,7 +39,8 @@ appcenter_fetch_devices(
 ```ruby
 appcenter_upload(
   api_token: "<appcenter token>",
-  owner_name: "<appcenter owner name of the app (as seen in app URL)>",
+  owner_name: "<appcenter account name of the owner of the app (username or organization URL name)>",
+  owner_type: "user", # Default is user - set to organization for appcenter organizations
   app_name: "<appcenter app name (as seen in app URL)>",
   file: "<path to android build binary>",
   notify_testers: true # Set to false if you don't want to notify testers of your new release (default: `false`)
@@ -81,15 +85,12 @@ Here is the list of all existing parameters:
 |-----------------|--------------------|
 | `api_token` <br/> `APPCENTER_API_TOKEN` | API Token for App Center |
 | `owner_type` <br/> `APPCENTER_OWNER_TYPE` | Owner type, either 'user' or 'organization' (default: `user`) |
-| `owner_name` <br/> `APPCENTER_OWNER_NAME` | Owner name, as found in the App's URL in App Center |
-| `app_name` <br/> `APPCENTER_APP_NAME` | App name as found in the App's URL in App Center, if there is no app with such name, you will be prompted to create one |
+| `owner_name` <br/> `APPCENTER_OWNER_NAME` | Owner name as found in the App's URL in App Center |
+| `app_name` <br/> `APPCENTER_APP_NAME` | App name as found in the App's URL in App Center. If there is no app with such name, you will be prompted to create one |
 | `app_display_name` <br/> `APPCENTER_APP_DISPLAY_NAME` | App display name to use when creating a new app |
 | `app_os` <br/> `APPCENTER_APP_OS` | App OS. Used for new app creation, if app 'app_name' was not found |
 | `app_platform` <br/> `APPCENTER_APP_PLATFORM` | App Platform. Used for new app creation, if app 'app_name' was not found |
-| `apk` <br/> `APPCENTER_DISTRIBUTE_APK` | Build release path for android build |
-| `aab` <br/> `APPCENTER_DISTRIBUTE_AAB` | Build release path for android app bundle build |
-| `ipa` <br/> `APPCENTER_DISTRIBUTE_IPA` | Build release path for iOS builds |
-| `file` <br/> `APPCENTER_DISTRIBUTE_FILE` | Build release path for generic builds (.aab, .app, .app.zip, .apk, .dmg, .ipa, .pkg) |
+| `file` <br/> `APPCENTER_DISTRIBUTE_FILE` | File path to the release build to publish |
 | `dsym` <br/> `APPCENTER_DISTRIBUTE_DSYM` | Path to your symbols file. For iOS provide path to app.dSYM.zip |
 | `upload_dsym_only` <br/> `APPCENTER_DISTRIBUTE_UPLOAD_DSYM_ONLY` | Flag to upload only the dSYM file to App Center (default: `false`) |
 | `mapping` <br/> `APPCENTER_DISTRIBUTE_ANDROID_MAPPING` | Path to your Android mapping.txt |
@@ -101,10 +102,11 @@ Here is the list of all existing parameters:
 | `release_notes` <br/> `APPCENTER_DISTRIBUTE_RELEASE_NOTES` | Release notes (default: `No changelog given`) |
 | `should_clip` <br/> `APPCENTER_DISTRIBUTE_RELEASE_NOTES_CLIPPING` | Clip release notes if its length is more then 5000, true by default (default: `true`) |
 | `release_notes_link` <br/> `APPCENTER_DISTRIBUTE_RELEASE_NOTES_LINK` | Additional release notes link |
-| `build_number` <br/> `APPCENTER_DISTRIBUTE_BUILD_NUMBER` | The build number, required for Android ProGuard mapping files, as well as macOS .pkg and .dmg builds |
-| `version` <br/> `APPCENTER_DISTRIBUTE_VERSION` | The build version, required for Android ProGuard mapping files, as well as macOS .pkg and .dmg builds |
+| `build_number` <br/> `APPCENTER_DISTRIBUTE_BUILD_NUMBER` | The build number, required for macOS .pkg and .dmg builds, as well as Android ProGuard `mapping.txt` when using `upload_mapping_only` |
+| `version` <br/> `APPCENTER_DISTRIBUTE_VERSION` | The build version, required for .pkg, .dmg, .zip and .msi builds, as well as Android ProGuard `mapping.txt` when using `upload_mapping_only` |
 | `timeout` <br/> `APPCENTER_DISTRIBUTE_TIMEOUT` | Request timeout in seconds |
-| `dsa_signature` <br/> `APPCENTER_DISTRIBUTE_DSA_SIGNATURE` | DSA signature of the macOS or Windows releases for Sparkle update feed |
+| `dsa_signature` <br/> `APPCENTER_DISTRIBUTE_DSA_SIGNATURE` | DSA signature of the macOS or Windows release for Sparkle update feed |
+| `strict` <br/> `APPCENTER_STRICT_MODE` | Strict mode, set to 'true' to fail early in case a potential error was detected |
 
 
 ## Example

data/lib/fastlane/plugin/appcenter/actions/appcenter_upload_action.rb

@@ -2,6 +2,18 @@ module Fastlane
   module Actions
     module Constants
       MAX_RELEASE_NOTES_LENGTH = 5000
+      SUPPORTED_EXTENSIONS = {
+          android: %w(.aab .apk),
+          ios: %w(.ipa),
+          mac: %w(.app .app.zip .dmg .pkg),
+          windows: %w(.appx .appxbundle .appxupload .msix .msixbundle .msixupload .zip .msi),
+          custom: %w(.zip)
+      }
+      ALL_SUPPORTED_EXTENSIONS = SUPPORTED_EXTENSIONS.values.flatten.sort!.uniq!
+      STORE_ONLY_EXTENSIONS = %w(.aab)
+      STORE_SUPPORTED_EXTENSIONS = %w(.aab .apk .ipa)
+      VERSION_REQUIRED_EXTENSIONS = %w(.msi .zip)
+      FULL_VERSION_REQUIRED_EXTENSIONS = %w(.dmg .pkg)
     end
 
     module SharedValues
@@ -64,7 +76,6 @@ module Fastlane
       end
 
       def self.run_mapping_upload(params)
-        values = params.values
         api_token = params[:api_token]
         owner_name = params[:owner_name]
         app_name = params[:app_name]
@@ -131,29 +142,35 @@ module Fastlane
 
         file_ext = Helper::AppcenterHelper.file_extname_full(file)
         if destination_type == "group"
-          UI.user_error!("Can't distribute #{file_ext} to groups, please use `destination_type: 'store'`") if %w(.aab).include? file_ext
+          self.optional_error("Can't distribute #{file_ext} to groups, please use `destination_type: 'store'`") if Constants::STORE_ONLY_EXTENSIONS.include? file_ext
         else
-          UI.user_error!("Can't distribute #{file_ext} to stores, please use `destination_type: 'group'`") if %w(.app .app.zip .dmg .pkg).include? file_ext
+          self.optional_error("Can't distribute #{file_ext} to stores, please use `destination_type: 'group'`") unless Constants::STORE_SUPPORTED_EXTENSIONS.include? file_ext
         end
 
+        release_upload_body = nil
         unless params[:file].to_s.empty?
-          if %w[.dmg .pkg].include? file_ext
-            UI.user_error!("Fields `version` and `build_number` must be specified to upload a #{file_ext} file") if build_number.to_s.empty? || version.to_s.empty?
-            release_upload_body = { build_version: version, build_number: build_number }
+          if Constants::FULL_VERSION_REQUIRED_EXTENSIONS.include? file_ext
+            self.optional_error("Fields `version` and `build_number` must be specified to upload a #{file_ext} file") if build_number.to_s.empty? || version.to_s.empty?
+          elsif Constants::VERSION_REQUIRED_EXTENSIONS.include? file_ext
+            self.optional_error("Field `version` must be specified to upload a #{file_ext} file") if version.to_s.empty?
           else
-            UI.message("Fields `version` and `build_number` are not required for files of type #{file_ext}, ignored") unless build_number.to_s.empty? && version.to_s.empty?
+            self.optional_error("Fields `version` and `build_number` are not supported for files of type #{file_ext}") unless build_number.to_s.empty? && version.to_s.empty?
           end
+
+          release_upload_body = { build_version: version } unless version.nil?
+          release_upload_body = { build_version: version, build_number: build_number } if !version.nil? && !build_number.nil?
         end
 
         if file_ext == ".app" && File.directory?(file)
           UI.message("App path is a directory, zipping it before upload")
           zip_file = file + ".zip"
-          if File.exists? zip_file
+          if File.exist? zip_file
             override = UI.interactive? ? UI.confirm("File '#{zip_file}' already exists, do you want to override it?") : true
             UI.abort_with_message!("Not overriding, aborting publishing operation") unless override
-            UI.message("Deleting zip file: #{zip_file}")
+            UI.message("Deleting zip archive: #{zip_file}")
             File.delete zip_file
           end
+          UI.message("Creating zip archive: #{zip_file}")
           file = Actions::ZipAction.run(path: file, output_path: zip_file)
         end
 
@@ -171,7 +188,7 @@ module Fastlane
             release_url = Helper::AppcenterHelper.get_release_url(owner_type, owner_name, app_name, release_id)
             UI.message("Release '#{release_id}' committed: #{release_url}")
 
-            Helper::AppcenterHelper.update_release(api_token, owner_name, app_name, release_id, release_notes)
+            release = Helper::AppcenterHelper.update_release(api_token, owner_name, app_name, release_id, release_notes)
             Helper::AppcenterHelper.update_release_metadata(api_token, owner_name, app_name, release_id, dsa_signature)
 
             destinations_array = destinations.split(',')
@@ -196,6 +213,8 @@ module Fastlane
             UI.user_error!("Failed to upload release")
           end
         end
+
+        release
       end
 
       # checks app existance, if ther is no such - creates it
@@ -240,9 +259,14 @@ module Fastlane
         upload_dsym_only = params[:upload_dsym_only]
         upload_mapping_only = params[:upload_mapping_only]
 
+        Options.strict_mode(params[:strict])
+
         # if app found or successfully created
         if self.get_or_create_app(params)
-          self.run_release_upload(params) unless upload_dsym_only || upload_mapping_only
+          release = self.run_release_upload(params) unless upload_dsym_only || upload_mapping_only
+          params[:version] = release['short_version'] if release
+          params[:build_number] = release['version'] if release
+
           self.run_dsym_upload(params) unless upload_mapping_only
           self.run_mapping_upload(params) unless upload_dsym_only
         end
@@ -282,7 +306,7 @@ module Fastlane
                                       type: String,
                               verify_block: proc do |value|
                                 accepted_formats = ["user", "organization"]
-                                UI.user_error!("Only \"user\" and \"organization\" types are allowed, you provided \"#{File.extname(value)}\"") unless accepted_formats.include? value
+                                UI.user_error!("Only \"user\" and \"organization\" types are allowed, you provided \"#{value}\"") unless accepted_formats.include? value
                               end),
 
           FastlaneCore::ConfigItem.new(key: :owner_name,
@@ -328,6 +352,7 @@ module Fastlane
                                description: "Build release path for android build",
                              default_value: Actions.lane_context[SharedValues::GRADLE_APK_OUTPUT_PATH],
                                   optional: true,
+                                deprecated: true,
                                       type: String,
                        conflicting_options: [:ipa, :aab, :file],
                             conflict_block: proc do |value|
@@ -336,7 +361,7 @@ module Fastlane
                               verify_block: proc do |value|
                                 accepted_formats = [".apk"]
                                 file_extname_full = Helper::AppcenterHelper.file_extname_full(value)
-                                UI.user_error!("Only \".apk\" formats are allowed, you provided \"#{file_extname_full}\"") unless accepted_formats.include? file_extname_full
+                                self.optional_error("Only \".apk\" formats are allowed, you provided \"#{file_extname_full}\"") unless accepted_formats.include? file_extname_full
                               end),
 
           FastlaneCore::ConfigItem.new(key: :aab,
@@ -344,6 +369,7 @@ module Fastlane
                                description: "Build release path for android app bundle build",
                              default_value: Actions.lane_context[SharedValues::GRADLE_AAB_OUTPUT_PATH],
                                   optional: true,
+                                deprecated: true,
                                       type: String,
                        conflicting_options: [:ipa, :apk, :file],
                             conflict_block: proc do |value|
@@ -351,7 +377,7 @@ module Fastlane
                             end,
                               verify_block: proc do |value|
                                 accepted_formats = [".aab"]
-                                UI.user_error!("Only \".aab\" formats are allowed, you provided \"#{File.extname(value)}\"") unless accepted_formats.include? File.extname(value)
+                                self.optional_error("Only \".aab\" formats are allowed, you provided \"#{File.extname(value)}\"") unless accepted_formats.include? File.extname(value)
                               end),
 
           FastlaneCore::ConfigItem.new(key: :ipa,
@@ -359,6 +385,7 @@ module Fastlane
                                description: "Build release path for iOS builds",
                              default_value: Actions.lane_context[SharedValues::IPA_OUTPUT_PATH],
                                   optional: true,
+                                deprecated: true,
                                       type: String,
                        conflicting_options: [:apk, :aab, :file],
                             conflict_block: proc do |value|
@@ -366,12 +393,12 @@ module Fastlane
                             end,
                               verify_block: proc do |value|
                                 accepted_formats = [".ipa"]
-                                UI.user_error!("Only \".ipa\" formats are allowed, you provided \"#{File.extname(value)}\"") unless accepted_formats.include? File.extname(value)
+                                self.optional_error("Only \".ipa\" formats are allowed, you provided \"#{File.extname(value)}\"") unless accepted_formats.include? File.extname(value)
                               end),
 
           FastlaneCore::ConfigItem.new(key: :file,
                                   env_name: "APPCENTER_DISTRIBUTE_FILE",
-                               description: "Build release path for generic builds (.aab, .app, .app.zip, .apk, .dmg, .ipa, .pkg)",
+                               description: "File path to the release build to publish",
                                   optional: true,
                                       type: String,
                        conflicting_options: [:apk, :aab, :ipa],
@@ -379,9 +406,14 @@ module Fastlane
                               UI.user_error!("You can't use 'file' and '#{value.key}' options in one run")
                             end,
                               verify_block: proc do |value|
-                                accepted_formats = %w(.aab .app .app.zip .apk .dmg .ipa .pkg)
+                                platform = Actions.lane_context[SharedValues::PLATFORM_NAME]
+                                accepted_formats = Constants::SUPPORTED_EXTENSIONS[platform.to_sym] if platform
+                                unless accepted_formats
+                                  UI.important("Unknown platform '#{platform}', consider using one of: #{Constants::SUPPORTED_EXTENSIONS.keys}")
+                                  accepted_formats = Constants::ALL_SUPPORTED_EXTENSIONS
+                                end
                                 file_ext = Helper::AppcenterHelper.file_extname_full(value)
-                                UI.user_error!("Only #{accepted_formats.to_s} formats are allowed, you provided \"#{file_ext}\"") unless accepted_formats.include? file_ext
+                                self.optional_error("Extension not supported: '#{file_ext}'. Supported formats for platform '#{platform}': #{accepted_formats.join ' '}") unless accepted_formats.include? file_ext
                               end),
 
           FastlaneCore::ConfigItem.new(key: :dsym,
@@ -489,13 +521,13 @@ module Fastlane
 
           FastlaneCore::ConfigItem.new(key: :build_number,
                                        env_name: "APPCENTER_DISTRIBUTE_BUILD_NUMBER",
-                                       description: "The build number, required for Android ProGuard mapping files, as well as macOS .pkg and .dmg builds",
+                                       description: "The build number, required for macOS .pkg and .dmg builds, as well as Android ProGuard `mapping.txt` when using `upload_mapping_only`",
                                        optional: true,
                                        type: String),
 
           FastlaneCore::ConfigItem.new(key: :version,
                                        env_name: "APPCENTER_DISTRIBUTE_VERSION",
-                                       description: "The build version, required for Android ProGuard mapping files, as well as macOS .pkg and .dmg builds",
+                                       description: "The build version, required for .pkg, .dmg, .zip and .msi builds, as well as Android ProGuard `mapping.txt` when using `upload_mapping_only`",
                                        optional: true,
                                        type: String),
 
@@ -507,7 +539,13 @@ module Fastlane
 
           FastlaneCore::ConfigItem.new(key: :dsa_signature,
                                        env_name: "APPCENTER_DISTRIBUTE_DSA_SIGNATURE",
-                                       description: "DSA signature of the macOS or Windows releases for Sparkle update feed",
+                                       description: "DSA signature of the macOS or Windows release for Sparkle update feed",
+                                       optional: true,
+                                       type: String),
+
+          FastlaneCore::ConfigItem.new(key: :strict,
+                                       env_name: "APPCENTER_STRICT_MODE",
+                                       description: "Strict mode, set to 'true' to fail early in case a potential error was detected",
                                        optional: true,
                                        type: String)
         ]
@@ -521,6 +559,8 @@ module Fastlane
       end
 
       def self.is_supported?(platform)
+        return Constants::SUPPORTED_EXTENSIONS.keys.include?(platform) if Options.strict
+
         true
       end
 
@@ -529,12 +569,10 @@ module Fastlane
           'appcenter_upload(
             api_token: "...",
             owner_name: "appcenter_owner",
-            app_name: "testing_app",
-            apk: "./app-release.apk",
+            app_name: "testing_android_app",
+            file: "./app-release.apk",
             destinations: "Testers",
             destination_type: "group",
-            build_number: "3",
-            version: "1.0.0",
             mapping: "./mapping.txt",
             release_notes: "release notes",
             notify_testers: false
@@ -542,9 +580,9 @@ module Fastlane
           'appcenter_upload(
             api_token: "...",
             owner_name: "appcenter_owner",
-            app_name: "testing_app",
-            apk: "./app-release.ipa",
-            destinations: "Testers,Alpha",
+            app_name: "testing_ios_app",
+            file: "./app-release.ipa",
+            destinations: "Testers,Public",
             destination_type: "group",
             dsym: "./app.dSYM.zip",
             release_notes: "release notes",
@@ -553,18 +591,36 @@ module Fastlane
           'appcenter_upload(
             api_token: "...",
             owner_name: "appcenter_owner",
-            app_name: "testing_app",
-            aab: "./app.aab",
+            app_name: "testing_google_play_app",
+            file: "./app.aab",
             destinations: "Alpha",
             destination_type: "store",
-            build_number: "3",
-            version: "1.0.0",
-            mapping: "./mapping.txt",
-            release_notes: "release notes",
-            notify_testers: false
+            release_notes: "this is a store release"
           )'
         ]
       end
+
+      class Options
+        include Singleton
+
+        def self.strict_mode(mode)
+          @strict = mode.to_s == "true"
+          UI.message("Enabled strict mode") if @strict
+        end
+
+        def self.strict
+          @strict
+        end
+      end
+
+      def self.optional_error(message)
+        if Options.strict
+          UI.user_error!(message)
+        else
+          UI.important(message)
+          UI.important("The current operation might fail, trying anyway...")
+        end
+      end
     end
   end
 end

data/lib/fastlane/plugin/appcenter/version.rb

@@ -1,5 +1,5 @@
 module Fastlane
   module Appcenter
-    VERSION = "1.5.0"
+    VERSION = "1.6.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-appcenter
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Microsoft Corporation
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-14 00:00:00.000000000 Z
+date: 2019-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.29.0
+        version: 2.96.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.29.0
+        version: 2.96.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement