cookbooks/web/resources/rails_port.rb

   1 #
   2 # Cookbook:: web
   3 # Resource:: rails_port
   4 #
   5 # Copyright:: 2012, OpenStreetMap Foundation
   6 #
   7 # Licensed under the Apache License, Version 2.0 (the "License");
   8 # you may not use this file except in compliance with the License.
   9 # You may obtain a copy of the License at
  10 #
  11 #     https://www.apache.org/licenses/LICENSE-2.0
  12 #
  13 # Unless required by applicable law or agreed to in writing, software
  14 # distributed under the License is distributed on an "AS IS" BASIS,
  15 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16 # See the License for the specific language governing permissions and
  17 # limitations under the License.
  18 #
  19
  20 require "yaml"
  21
  22 resource_name :rails_port
  23 provides :rails_port
  24
  25 unified_mode true
  26
  27 default_action :create
  28
  29 property :site, String, :name_property => true
  30 property :ruby, String, :default => "2.3"
  31 property :directory, String
  32 property :user, String
  33 property :group, String
  34 property :repository, String, :default => "https://git.openstreetmap.org/public/rails.git"
  35 property :revision, String, :default => "live"
  36 property :run_migrations, [true, false], :default => false
  37 property :build_assets, [true, false], :default => true
  38 property :email_from, String, :default => "OpenStreetMap <support@openstreetmap.org>"
  39 property :status, String, :default => "online"
  40 property :database_host, String
  41 property :database_port, String
  42 property :database_name, String
  43 property :database_username, String
  44 property :database_password, String
  45 property :email_from, String
  46 property :messages_domain, String
  47 property :gpx_dir, String
  48 property :attachments_dir, String
  49 property :log_path, String
  50 property :logstash_path, String
  51 property :memcache_servers, Array
  52 property :potlatch2_key, String
  53 property :id_key, String
  54 property :oauth_key, String
  55 property :nominatim_url, String
  56 property :osrm_url, String
  57 property :google_auth_id, String
  58 property :google_auth_secret, String
  59 property :google_openid_realm, String
  60 property :facebook_auth_id, String
  61 property :facebook_auth_secret, String
  62 property :windowslive_auth_id, String
  63 property :windowslive_auth_secret, String
  64 property :github_auth_id, String
  65 property :github_auth_secret, String
  66 property :wikipedia_auth_id, String
  67 property :wikipedia_auth_secret, String
  68 property :thunderforest_key, String
  69 property :totp_key, String
  70 property :csp_enforce, [true, false], :default => false
  71 property :csp_report_url, String
  72 property :piwik_configuration, Hash
  73 property :trace_use_job_queue, [true, false], :default => false
  74 property :diary_feed_delay, Integer
  75 property :storage_configuration, Hash, :default => {}
  76 property :storage_service, String, :default => "local"
  77 property :storage_url, String
  78 property :tile_cdn_url, String
  79
  80 action :create do
  81   package %W[
  82     ruby#{new_resource.ruby}
  83     ruby#{new_resource.ruby}-dev
  84     imagemagick
  85     nodejs
  86     tzdata
  87   ]
  88
  89   package %w[
  90     g++
  91     make
  92     pkg-config
  93     libpq-dev
  94     libsasl2-dev
  95     libxml2-dev
  96     libxslt1-dev
  97     libmemcached-dev
  98     libffi-dev
  99     libgd-dev
 100     libarchive-dev
 101     libbz2-dev
 102   ]
 103
 104   package %w[
 105     pngcrush
 106     advancecomp
 107     optipng
 108     pngquant
 109     jhead
 110     jpegoptim
 111     gifsicle
 112     libjpeg-turbo-progs
 113   ]
 114
 115   gem_package "bundler#{new_resource.ruby}" do
 116     package_name "bundler"
 117     version "2.1.4"
 118     gem_binary "gem#{new_resource.ruby}"
 119     options "--format-executable"
 120   end
 121
 122   gem_package "bundler#{new_resource.ruby}" do
 123     package_name "pkg-config"
 124     gem_binary "gem#{new_resource.ruby}"
 125   end
 126
 127   declare_resource :directory, rails_directory do
 128     owner new_resource.user
 129     group new_resource.group
 130     mode "2775"
 131   end
 132
 133   git rails_directory do
 134     action :sync
 135     repository new_resource.repository
 136     revision new_resource.revision
 137     depth 1
 138     user new_resource.user
 139     group new_resource.group
 140     notifies :restart, "passenger_application[#{rails_directory}]"
 141   end
 142
 143   declare_resource :directory, "#{rails_directory}/tmp" do
 144     owner new_resource.user
 145     group new_resource.group
 146   end
 147
 148   file "#{rails_directory}/config/environment.rb" do
 149     owner new_resource.user
 150     group new_resource.group
 151   end
 152
 153   template "#{rails_directory}/config/database.yml" do
 154     cookbook "web"
 155     source "database.yml.erb"
 156     owner new_resource.user
 157     group new_resource.group
 158     mode "664"
 159     variables :host => new_resource.database_host,
 160               :port => new_resource.database_port,
 161               :name => new_resource.database_name,
 162               :username => new_resource.database_username,
 163               :password => new_resource.database_password
 164     notifies :restart, "passenger_application[#{rails_directory}]"
 165   end
 166
 167   application_yml = edit_file "#{rails_directory}/config/example.application.yml" do |line|
 168     line.gsub!(/^( *)server_protocol:.*$/, "\\1server_protocol: \"https\"")
 169     line.gsub!(/^( *)server_url:.*$/, "\\1server_url: \"#{new_resource.site}\"")
 170
 171     line.gsub!(/^( *)support_email:.*$/, "\\1support_email: \"support@openstreetmap.org\"")
 172
 173     if new_resource.email_from
 174       line.gsub!(/^( *)email_from:.*$/, "\\1email_from: \"#{new_resource.email_from}\"")
 175     end
 176
 177     line.gsub!(/^( *)email_return_path:.*$/, "\\1email_return_path: \"bounces@openstreetmap.org\"")
 178
 179     line.gsub!(/^( *)status:.*$/, "\\1status: :#{new_resource.status}")
 180
 181     if new_resource.messages_domain
 182       line.gsub!(/^( *)#messages_domain:.*$/, "\\1messages_domain: \"#{new_resource.messages_domain}\"")
 183     end
 184
 185     line.gsub!(/^( *)#geonames_username:.*$/, "\\1geonames_username: \"openstreetmap\"")
 186
 187     line.gsub!(/^( *)#maxmind_database:.*$/, "\\1maxmind_database: \"/usr/share/GeoIP/GeoLite2-Country.mmdb\"")
 188
 189     if new_resource.gpx_dir
 190       line.gsub!(/^( *)gpx_trace_dir:.*$/, "\\1gpx_trace_dir: \"#{new_resource.gpx_dir}/traces\"")
 191       line.gsub!(/^( *)gpx_image_dir:.*$/, "\\1gpx_image_dir: \"#{new_resource.gpx_dir}/images\"")
 192     end
 193
 194     if new_resource.attachments_dir
 195       line.gsub!(/^( *)attachments_dir:.*$/, "\\1attachments_dir: \"#{new_resource.attachments_dir}\"")
 196     end
 197
 198     if new_resource.log_path
 199       line.gsub!(/^( *)#log_path:.*$/, "\\1log_path: \"#{new_resource.log_path}\"")
 200     end
 201
 202     if new_resource.logstash_path
 203       line.gsub!(/^( *)#logstash_path:.*$/, "\\1logstash_path: \"#{new_resource.logstash_path}\"")
 204     end
 205
 206     if new_resource.memcache_servers
 207       line.gsub!(/^( *)#memcache_servers:.*$/, "\\1memcache_servers: [ \"#{new_resource.memcache_servers.join('", "')}\" ]")
 208     end
 209
 210     if new_resource.potlatch2_key
 211       line.gsub!(/^( *)#potlatch2_key:.*$/, "\\1potlatch2_key: \"#{new_resource.potlatch2_key}\"")
 212     end
 213
 214     if new_resource.id_key
 215       line.gsub!(/^( *)#id_key:.*$/, "\\1id_key: \"#{new_resource.id_key}\"")
 216     end
 217
 218     if new_resource.oauth_key
 219       line.gsub!(/^( *)#oauth_key:.*$/, "\\1oauth_key: \"#{new_resource.oauth_key}\"")
 220     end
 221
 222     if new_resource.nominatim_url
 223       line.gsub!(/^( *)nominatim_url:.*$/, "\\1nominatim_url: \"#{new_resource.nominatim_url}\"")
 224     end
 225
 226     if new_resource.osrm_url
 227       line.gsub!(/^( *)osrm_url:.*$/, "\\1osrm_url: \"#{new_resource.osrm_url}\"")
 228     end
 229
 230     if new_resource.google_auth_id
 231       line.gsub!(/^( *)#google_auth_id:.*$/, "\\1google_auth_id: \"#{new_resource.google_auth_id}\"")
 232       line.gsub!(/^( *)#google_auth_secret:.*$/, "\\1google_auth_secret: \"#{new_resource.google_auth_secret}\"")
 233       line.gsub!(/^( *)#google_openid_realm:.*$/, "\\1google_openid_realm: \"#{new_resource.google_openid_realm}\"")
 234     end
 235
 236     if new_resource.facebook_auth_id
 237       line.gsub!(/^( *)#facebook_auth_id:.*$/, "\\1facebook_auth_id: \"#{new_resource.facebook_auth_id}\"")
 238       line.gsub!(/^( *)#facebook_auth_secret:.*$/, "\\1facebook_auth_secret: \"#{new_resource.facebook_auth_secret}\"")
 239     end
 240
 241     if new_resource.windowslive_auth_id
 242       line.gsub!(/^( *)#windowslive_auth_id:.*$/, "\\1windowslive_auth_id: \"#{new_resource.windowslive_auth_id}\"")
 243       line.gsub!(/^( *)#windowslive_auth_secret:.*$/, "\\1windowslive_auth_secret: \"#{new_resource.windowslive_auth_secret}\"")
 244     end
 245
 246     if new_resource.github_auth_id
 247       line.gsub!(/^( *)#github_auth_id:.*$/, "\\1github_auth_id: \"#{new_resource.github_auth_id}\"")
 248       line.gsub!(/^( *)#github_auth_secret:.*$/, "\\1github_auth_secret: \"#{new_resource.github_auth_secret}\"")
 249     end
 250
 251     if new_resource.wikipedia_auth_id
 252       line.gsub!(/^( *)#wikipedia_auth_id:.*$/, "\\1wikipedia_auth_id: \"#{new_resource.wikipedia_auth_id}\"")
 253       line.gsub!(/^( *)#wikipedia_auth_secret:.*$/, "\\1wikipedia_auth_secret: \"#{new_resource.wikipedia_auth_secret}\"")
 254     end
 255
 256     if new_resource.thunderforest_key
 257       line.gsub!(/^( *)#thunderforest_key:.*$/, "\\1thunderforest_key: \"#{new_resource.thunderforest_key}\"")
 258     end
 259
 260     if new_resource.totp_key
 261       line.gsub!(/^( *)#totp_key:.*$/, "\\1totp_key: \"#{new_resource.totp_key}\"")
 262     end
 263
 264     if new_resource.csp_enforce
 265       line.gsub!(/^( *)csp_enforce:.*$/, "\\1csp_enforce: \"#{new_resource.csp_enforce}\"")
 266     end
 267
 268     if new_resource.csp_report_url
 269       line.gsub!(/^( *)#csp_report_url:.*$/, "\\1csp_report_url: \"#{new_resource.csp_report_url}\"")
 270     end
 271
 272     line.gsub!(/^( *)require_terms_seen:.*$/, "\\1require_terms_seen: true")
 273     line.gsub!(/^( *)require_terms_agreed:.*$/, "\\1require_terms_agreed: true")
 274     line.gsub!(/^( *)trace_use_job_queue:.*$/, "\\1trace_use_job_queue: false")
 275
 276     line
 277   end
 278
 279   file "create:#{rails_directory}/config/application.yml" do
 280     path "#{rails_directory}/config/application.yml"
 281     owner new_resource.user
 282     group new_resource.group
 283     mode "664"
 284     content application_yml
 285     notifies :restart, "passenger_application[#{rails_directory}]"
 286     only_if { ::File.exist?("#{rails_directory}/config/example.application.yml") }
 287   end
 288
 289   file "delete:#{rails_directory}/config/application.yml" do
 290     path "#{rails_directory}/config/application.yml"
 291     action :delete
 292     not_if { ::File.exist?("#{rails_directory}/config/example.application.yml") }
 293   end
 294
 295   settings = new_resource.to_hash.transform_keys(&:to_s).slice(
 296     "email_from",
 297     "status",
 298     "messages_domain",
 299     "attachments_dir",
 300     "log_path",
 301     "logstash_path",
 302     "potlatch2_key",
 303     "id_key",
 304     "oauth_key",
 305     "nominatim_url",
 306     "osrm_url",
 307     "google_auth_id",
 308     "google_auth_secret",
 309     "google_openid_realm",
 310     "facebook_auth_id",
 311     "facebook_auth_secret",
 312     "windowslive_auth_id",
 313     "windowslive_auth_secret",
 314     "github_auth_id",
 315     "github_auth_secret",
 316     "wikipedia_auth_id",
 317     "wikipedia_auth_secret",
 318     "thunderforest_key",
 319     "totp_key",
 320     "csp_enforce",
 321     "csp_report_url",
 322     "trace_use_job_queue",
 323     "diary_feed_delay",
 324     "storage_service",
 325     "storage_url",
 326     "tile_cdn_url"
 327   ).compact.merge(
 328     "server_protocol" => "https",
 329     "server_url" => new_resource.site,
 330     "support_email" => "support@openstreetmap.org",
 331     "email_return_path" => "bounces@openstreetmap.org",
 332     "geonames_username" => "openstreetmap",
 333     "maxmind_database" => "/usr/share/GeoIP/GeoLite2-Country.mmdb"
 334   )
 335
 336   if new_resource.memcache_servers
 337     settings["memcache_servers"] = new_resource.memcache_servers.to_a
 338   end
 339
 340   if new_resource.gpx_dir
 341     settings["gpx_trace_dir"] = "#{new_resource.gpx_dir}/traces"
 342     settings["gpx_image_dir"] = "#{new_resource.gpx_dir}/images"
 343   end
 344
 345   file "#{rails_directory}/config/settings.local.yml" do
 346     owner new_resource.user
 347     group new_resource.group
 348     mode "664"
 349     content YAML.dump(settings)
 350     only_if { ::File.exist?("#{rails_directory}/config/settings.yml") }
 351   end
 352
 353   storage_configuration = new_resource.storage_configuration.merge(
 354     "local" => {
 355       "service" => "Disk",
 356       "root" => "#{rails_directory}/storage"
 357     }
 358   )
 359
 360   file "#{rails_directory}/config/storage.yml" do
 361     owner new_resource.user
 362     group new_resource.group
 363     mode "664"
 364     content YAML.dump(storage_configuration)
 365   end
 366
 367   if new_resource.piwik_configuration
 368     file "#{rails_directory}/config/piwik.yml" do
 369       owner new_resource.user
 370       group new_resource.group
 371       mode "664"
 372       content YAML.dump(new_resource.piwik_configuration)
 373     end
 374   else
 375     file "#{rails_directory}/config/piwik.yml" do
 376       action :delete
 377     end
 378   end
 379
 380   execute "#{rails_directory}/Gemfile" do
 381     action :nothing
 382     command "bundle#{new_resource.ruby} install"
 383     cwd rails_directory
 384     user "root"
 385     group "root"
 386     environment "NOKOGIRI_USE_SYSTEM_LIBRARIES" => "yes"
 387     subscribes :run, "gem_package[bundler#{new_resource.ruby}]"
 388     subscribes :run, "git[#{rails_directory}]"
 389     notifies :restart, "passenger_application[#{rails_directory}]"
 390   end
 391
 392   execute "#{rails_directory}/db/migrate" do
 393     action :nothing
 394     command "bundle#{new_resource.ruby} exec rake db:migrate"
 395     cwd rails_directory
 396     user new_resource.user
 397     group new_resource.group
 398     subscribes :run, "git[#{rails_directory}]"
 399     notifies :restart, "passenger_application[#{rails_directory}]"
 400     only_if { new_resource.run_migrations }
 401   end
 402
 403   package "yarnpkg" do
 404     only_if { new_resource.build_assets }
 405   end
 406
 407   execute "#{rails_directory}/package.json" do
 408     action :nothing
 409     command "bundle#{new_resource.ruby} exec rake yarn:install"
 410     environment "HOME" => rails_directory,
 411                 "RAILS_ENV" => "production"
 412     cwd rails_directory
 413     user new_resource.user
 414     group new_resource.group
 415     subscribes :run, "git[#{rails_directory}]"
 416     only_if { new_resource.build_assets }
 417   end
 418
 419   execute "#{rails_directory}/app/assets/javascripts/i18n" do
 420     action :nothing
 421     command "bundle#{new_resource.ruby} exec rake i18n:js:export"
 422     environment "HOME" => rails_directory,
 423                 "RAILS_ENV" => "production"
 424     cwd rails_directory
 425     user new_resource.user
 426     group new_resource.group
 427     subscribes :run, "git[#{rails_directory}]"
 428     only_if { new_resource.build_assets }
 429   end
 430
 431   execute "#{rails_directory}/public/assets" do
 432     action :nothing
 433     command "bundle#{new_resource.ruby} exec rake assets:precompile"
 434     environment "HOME" => rails_directory,
 435                 "RAILS_ENV" => "production"
 436     cwd rails_directory
 437     user new_resource.user
 438     group new_resource.group
 439     subscribes :run, "git[#{rails_directory}]"
 440     subscribes :run, "file[create:#{rails_directory}/config/application.yml]"
 441     subscribes :run, "file[#{rails_directory}/config/settings.local.yml]"
 442     subscribes :run, "file[#{rails_directory}/config/storage.yml]"
 443     subscribes :run, "file[#{rails_directory}/config/piwik.yml]"
 444     subscribes :run, "execute[#{rails_directory}/package.json]"
 445     subscribes :run, "execute[#{rails_directory}/app/assets/javascripts/i18n]"
 446     notifies :restart, "passenger_application[#{rails_directory}]"
 447     only_if { new_resource.build_assets }
 448   end
 449
 450   file "#{rails_directory}/public/export/embed.html" do
 451     action :nothing
 452     subscribes :delete, "git[#{rails_directory}]"
 453     subscribes :delete, "file[#{rails_directory}/config/settings.local.yml]"
 454   end
 455
 456   passenger_application rails_directory do
 457     action :nothing
 458     only_if { ::File.exist?("/usr/bin/passenger-config") }
 459   end
 460
 461   template "/etc/cron.daily/rails-#{new_resource.site.tr('.', '-')}" do
 462     cookbook "web"
 463     source "rails.cron.erb"
 464     owner "root"
 465     group "root"
 466     mode "755"
 467     variables :directory => rails_directory
 468   end
 469 end
 470
 471 action :restart do
 472   passenger_application rails_directory do
 473     action :restart
 474   end
 475 end
 476
 477 action_class do
 478   include Chef::Mixin::EditFile
 479
 480   def rails_directory
 481     new_resource.directory || "/srv/#{new_resource.site}"
 482   end
 483 end