Class: Fastlane::Actions::NexusUploadAction

Inherits:
Fastlane::Action show all
Defined in:
lib/fastlane/actions/nexus_upload.rb

Constant Summary

Constants inherited from Fastlane::Action

Fastlane::Action::AVAILABLE_CATEGORIES

Documentation collapse

Class Method Summary collapse

Methods inherited from Fastlane::Action

action_name, author, details, lane_context, method_missing, other_action, output, return_value, sample_return_value, sh, step_text

Class Method Details

.authors ⇒ Object 



151
152
153
 
# File 'lib/fastlane/actions/nexus_upload.rb', line 151

def self.authors
  ["xfreebird"]
end

.available_options ⇒ Object 



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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/fastlane/actions/nexus_upload.rb', line 74

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :file,
                                 env_name: "FL_NEXUS_FILE",
                                 description: "File to be uploaded to Nexus",
                                 optional: false,
                                 verify_block: proc do |value|
                                   file_path = File.expand_path(value)
                                   UI.user_error!("Couldn't find file at path '#{file_path}'") unless File.exist?(file_path)
                                 end),
    FastlaneCore::ConfigItem.new(key: :repo_id,
                                 env_name: "FL_NEXUS_REPO_ID",
                                 description: "Nexus repository id e.g. artefacts",
                                 optional: false),
    FastlaneCore::ConfigItem.new(key: :repo_group_id,
                                 env_name: "FL_NEXUS_REPO_GROUP_ID",
                                 description: "Nexus repository group id e.g. com.company",
                                 optional: false),
    FastlaneCore::ConfigItem.new(key: :repo_project_name,
                                 env_name: "FL_NEXUS_REPO_PROJECT_NAME",
                                 description: "Nexus repository commandect name. Only letters, digits, underscores(_), hyphens(-), and dots(.) are allowed",
                                 optional: false),
    FastlaneCore::ConfigItem.new(key: :repo_project_version,
                                 env_name: "FL_NEXUS_REPO_PROJECT_VERSION",
                                 description: "Nexus repository commandect version",
                                 optional: false),
    FastlaneCore::ConfigItem.new(key: :repo_classifier,
                                 env_name: "FL_NEXUS_REPO_CLASSIFIER",
                                 description: "Nexus repository artifact classifier (optional)",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :endpoint,
                                 env_name: "FL_NEXUS_ENDPOINT",
                                 description: "Nexus endpoint e.g. http://nexus:8081",
                                 optional: false),
    FastlaneCore::ConfigItem.new(key: :mount_path,
                                 env_name: "FL_NEXUS_MOUNT_PATH",
                                 description: "Nexus mount path. Defaults to /nexus",
                                 default_value: "/nexus",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :username,
                                 env_name: "FL_NEXUS_USERNAME",
                                 description: "Nexus username",
                                 optional: false),
    FastlaneCore::ConfigItem.new(key: :password,
                                 env_name: "FL_NEXUS_PASSWORD",
                                 description: "Nexus password",
                                 optional: false),
    FastlaneCore::ConfigItem.new(key: :ssl_verify,
                                 env_name: "FL_NEXUS_SSL_VERIFY",
                                 description: "Verify SSL",
                                 default_value: true,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :verbose,
                                 env_name: "FL_NEXUS_VERBOSE",
                                 description: "Make detailed output",
                                 is_string: false,
                                 default_value: false,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :proxy_username,
                                 env_name: "FL_NEXUS_PROXY_USERNAME",
                                 description: "Proxy username",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :proxy_password,
                                 env_name: "FL_NEXUS_PROXY_PASSWORD",
                                 description: "Proxy password",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :proxy_address,
                                 env_name: "FL_NEXUS_PROXY_ADDRESS",
                                 description: "Proxy address",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :proxy_port,
                                 env_name: "FL_NEXUS_PROXY_PORT",
                                 description: "Proxy port",
                                 optional: true)
  ]
end

.category ⇒ Object 



175
176
177
 
# File 'lib/fastlane/actions/nexus_upload.rb', line 175

def self.category
  :beta
end

.description ⇒ Object 



70
71
72
 
# File 'lib/fastlane/actions/nexus_upload.rb', line 70

def self.description
  "Upload a file to Sonatype Nexus platform"
end

.example_code ⇒ Object 



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/fastlane/actions/nexus_upload.rb', line 159

def self.example_code
  [
    'nexus_upload(
      file: "/path/to/file.ipa",
      repo_id: "artefacts",
      repo_group_id: "com.fastlane",
      repo_project_name: "ipa",
      repo_project_version: "1.13",
      repo_classifier: "dSYM", # Optional
      endpoint: "http://localhost:8081",
      username: "admin",
      password: "admin123"
    )'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


155
156
157
 
# File 'lib/fastlane/actions/nexus_upload.rb', line 155

def self.is_supported?(platform)
  true
end

.proxy_options(params) ⇒ Object 



56
57
58
59
60
61
62
63
64
 
# File 'lib/fastlane/actions/nexus_upload.rb', line 56

def self.proxy_options(params)
  options = []
  if params[:proxy_address] && params[:proxy_port] && params[:proxy_username] && params[:proxy_password]
    options << "-x #{params[:proxy_address].shellescape}:#{params[:proxy_port].shellescape}"
    options << "--proxy-user #{params[:proxy_username].shellescape}:#{params[:proxy_password].shellescape}"
  end

  options
end

.run(params) ⇒ Object 



4
5
6
7
8
9
10
11
12
13
14
 
# File 'lib/fastlane/actions/nexus_upload.rb', line 4

def self.run(params)
  command = []
  command << "curl"
  command << verbose(params)
  command += ssl_options(params)
  command += proxy_options(params)
  command += upload_options(params)
  command << upload_url(params)

  Fastlane::Actions.sh(command.join(' '), log: params[:verbose])
end

.ssl_options(params) ⇒ Object 



47
48
49
50
51
52
53
54
 
# File 'lib/fastlane/actions/nexus_upload.rb', line 47

def self.ssl_options(params)
  options = []
  unless params[:ssl_verify]
    options << "--insecure"
  end

  options
end

.upload_options(params) ⇒ Object 



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/fastlane/actions/nexus_upload.rb', line 24

def self.upload_options(params)
  file_path = File.expand_path(params[:file]).shellescape
  file_extension = file_path.split('.').last.shellescape

  options = []
  options << "-F p=zip"
  options << "-F hasPom=false"
  options << "-F r=#{params[:repo_id].shellescape}"
  options << "-F g=#{params[:repo_group_id].shellescape}"
  options << "-F a=#{params[:repo_project_name].shellescape}"
  options << "-F v=#{params[:repo_project_version].shellescape}"

  if params[:repo_classifier]
    options << "-F c=#{params[:repo_classifier].shellescape}"
  end

  options << "-F e=#{file_extension}"
  options << "-F file=@#{file_path}"
  options << "-u #{params[:username].shellescape}:#{params[:password].shellescape}"

  options
end

.upload_url(params) ⇒ Object 



16
17
18
 
# File 'lib/fastlane/actions/nexus_upload.rb', line 16

def self.upload_url(params)
  "#{params[:endpoint]}#{params[:mount_path]}/service/local/artifact/maven/content".shellescape
end

.verbose(params) ⇒ Object 



20
21
22
 
# File 'lib/fastlane/actions/nexus_upload.rb', line 20

def self.verbose(params)
  params[:verbose] ? "--verbose" : "--silent"
end