Class: Fastlane::Actions::FirebaseAppDistributionCreateGroupAction

Inherits:
Action
  • Object
show all
Extended by:
Fastlane::Auth::FirebaseAppDistributionAuthClient, Helper::FirebaseAppDistributionHelper
Defined in:
lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_create_group_action.rb

Constant Summary

Constants included from Fastlane::Auth::FirebaseAppDistributionAuthClient

Fastlane::Auth::FirebaseAppDistributionAuthClient::CLIENT_ID, Fastlane::Auth::FirebaseAppDistributionAuthClient::CLIENT_SECRET, Fastlane::Auth::FirebaseAppDistributionAuthClient::REDACTION_CHARACTER, Fastlane::Auth::FirebaseAppDistributionAuthClient::REDACTION_EXPOSED_LENGTH, Fastlane::Auth::FirebaseAppDistributionAuthClient::SCOPE, Fastlane::Auth::FirebaseAppDistributionAuthClient::TOKEN_CREDENTIAL_URI

Class Method Summary collapse

Methods included from Fastlane::Auth::FirebaseAppDistributionAuthClient

get_authorization

Methods included from Helper::FirebaseAppDistributionHelper

app_id_from_params, app_name_from_app_id, binary_type_from_path, blank?, deep_symbolize_keys, get_ios_app_id_from_archive_plist, get_ios_app_id_from_plist, get_value_from_value_or_file, group_name, init_google_api_client, lane_platform, parse_plist, present?, project_name, project_number_from_app_id, string_to_array, xcode_archive_path

Class Method Details

.authors ⇒ Object 



62
63
64
 
# File 'lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_create_group_action.rb', line 62

def self.authors
  ["Garry Jeromson"]
end

.available_options ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_create_group_action.rb', line 71

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :project_number,
                                 env_name: "FIREBASEAPPDISTRO_PROJECT_NUMBER",
                                 description: "Your Firebase project number. You can find the project number in the Firebase console, on the General Settings page",
                                 type: Integer,
                                 optional: false),
    FastlaneCore::ConfigItem.new(key: :alias,
                                 env_name: "FIREBASEAPPDISTRO_CREATE_GROUP_ALIAS",
                                 description: "Alias of the group to be created",
                                 optional: false,
                                 type: String),
    FastlaneCore::ConfigItem.new(key: :display_name,
                                 env_name: "FIREBASEAPPDISTRO_CREATE_GROUP_DISPLAY_NAME",
                                 description: "Display name for the group to be created",
                                 optional: false,
                                 type: String),
    FastlaneCore::ConfigItem.new(key: :service_credentials_file,
                                 description: "Path to Google service credentials file",
                                 optional: true,
                                 type: String),
    FastlaneCore::ConfigItem.new(key: :service_credentials_json_data,
                                 description: "Google service account json file content",
                                 optional: true,
                                 type: String),
    FastlaneCore::ConfigItem.new(key: :firebase_cli_token,
                                 description: "Auth token generated using the Firebase CLI's login:ci command",
                                 optional: true,
                                 type: String),
    FastlaneCore::ConfigItem.new(key: :debug,
                                 description: "Print verbose debug output",
                                 optional: true,
                                 default_value: false,
                                 is_string: false)
  ]
end

.description ⇒ Object 



58
59
60
 
# File 'lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_create_group_action.rb', line 58

def self.description
  "Create a tester group"
end

.details ⇒ Object

supports markdown.



67
68
69
 
# File 'lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_create_group_action.rb', line 67

def self.details
  "Create a tester group"
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


108
109
110
 
# File 'lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_create_group_action.rb', line 108

def self.is_supported?(platform)
  true
end

.run(params) ⇒ Object 



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_create_group_action.rb', line 15

def self.run(params)
  if blank?(params[:alias])
    UI.user_error!("Must specify `alias`.")
  end

  if blank?(params[:display_name])
    UI.user_error!("Must specify `display_name`.")
  end

  init_google_api_client(params[:debug])
  client = Google::Apis::FirebaseappdistributionV1::FirebaseAppDistributionService.new
  client.authorization = get_authorization(params[:service_credentials_file], params[:firebase_cli_token], params[:service_credentials_json_data], params[:debug])

  project_number = params[:project_number]
  group_alias = params[:alias]
  display_name = params[:display_name]

  UI.message("⏳ Creating tester group '#{group_alias} (#{display_name})' in project #{project_number}...")

  parent = project_name(project_number)
  group = Google::Apis::FirebaseappdistributionV1::GoogleFirebaseAppdistroV1Group.new(
    name: group_name(project_number, group_alias),
    display_name: display_name
  )

  begin
    client.create_project_group(parent, group, group_id: group_alias)
  rescue Google::Apis::Error => err
    case err.status_code.to_i
    when 400
      UI.user_error!(ErrorMessage::INVALID_TESTER_GROUP_NAME)
    when 404
      UI.user_error!(ErrorMessage::INVALID_PROJECT)
    when 409
      UI.important("Tester group #{group_alias} already exists.")
    else
      UI.crash!(err)
    end
  end

  UI.success("✅ Group created successfully.")
end