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 :directory, String
  31 property :user, String
  32 property :group, String
  33 property :repository, String, :default => "https://git.openstreetmap.org/public/rails.git"
  34 property :revision, String, :default => "live"
  35 property :run_migrations, [true, false], :default => false
  36 property :build_assets, [true, false], :default => true
  37 property :email_from, String, :default => "OpenStreetMap <support@openstreetmap.org>"
  38 property :status, String, :default => "online"
  39 property :database_host, String
  40 property :database_port, String
  41 property :database_name, String
  42 property :database_username, String
  43 property :database_password, String
  44 property :email_from, String
  45 property :messages_domain, String
  46 property :gpx_dir, String
  47 property :attachments_dir, String
  48 property :log_path, String
  49 property :memcache_servers, Array
  50 property :potlatch2_key, String
  51 property :id_key, String
  52 property :id_application, String
  53 property :oauth_key, String
  54 property :oauth_application, String
  55 property :nominatim_url, String
  56 property :overpass_url, String
  57 property :overpass_credentials, [true, false], :default => false
  58 property :google_auth_id, String
  59 property :google_auth_secret, String
  60 property :google_openid_realm, String
  61 property :apple_auth_id, String
  62 property :apple_team_id, String
  63 property :apple_key_id, String
  64 property :apple_private_key, String
  65 property :facebook_auth_id, String
  66 property :facebook_auth_secret, String
  67 property :microsoft_auth_id, String
  68 property :microsoft_auth_secret, String
  69 property :github_auth_id, String
  70 property :github_auth_secret, String
  71 property :wikipedia_auth_id, String
  72 property :wikipedia_auth_secret, String
  73 property :thunderforest_key, String
  74 property :tracestrack_key, String
  75 property :maptiler_key, String
  76 property :totp_key, String
  77 property :csp_enforce, [true, false], :default => false
  78 property :csp_report_url, String
  79 property :matomo_configuration, Hash
  80 property :storage_service, String, :default => "local"
  81 property :storage_url, String
  82 property :trace_use_job_queue, [true, false], :default => false
  83 property :diary_feed_delay, Integer
  84 property :storage_configuration, Hash, :default => {}
  85 property :avatar_storage, String
  86 property :trace_file_storage, String
  87 property :trace_image_storage, String
  88 property :trace_icon_storage, String
  89 property :avatar_storage_url, String
  90 property :trace_image_storage_url, String
  91 property :trace_icon_storage_url, String
  92 property :tile_cdn_url, String
  93 property :imagery_blacklist, Array
  94 property :signup_ip_per_day, Integer
  95 property :signup_ip_max_burst, Integer
  96 property :signup_email_per_day, Integer
  97 property :signup_email_max_burst, Integer
  98 property :doorkeeper_signing_key, String
  99 property :user_account_deletion_delay, Integer
 100
 101 action :create do
 102   package %w[
 103     imagemagick
 104     libvips42
 105     nodejs
 106     tzdata
 107   ]
 108
 109   package %w[
 110     g++
 111     make
 112     pkg-config
 113     libpq-dev
 114     libsasl2-dev
 115     libxml2-dev
 116     libxslt1-dev
 117     libmemcached-dev
 118     libffi-dev
 119     libgd-dev
 120     libarchive-dev
 121     libbz2-dev
 122     libyaml-dev
 123   ]
 124
 125   package %w[
 126     pngcrush
 127     advancecomp
 128     optipng
 129     pngquant
 130     jhead
 131     jpegoptim
 132     gifsicle
 133     libjpeg-turbo-progs
 134   ]
 135
 136   declare_resource :directory, rails_directory do
 137     owner new_resource.user
 138     group new_resource.group
 139     mode "2775"
 140   end
 141
 142   git rails_directory do
 143     action :sync
 144     repository new_resource.repository
 145     revision new_resource.revision
 146     depth 1
 147     user new_resource.user
 148     group new_resource.group
 149   end
 150
 151   declare_resource :directory, "#{rails_directory}/tmp" do
 152     owner new_resource.user
 153     group new_resource.group
 154   end
 155
 156   file "#{rails_directory}/config/environment.rb" do
 157     owner new_resource.user
 158     group new_resource.group
 159   end
 160
 161   template "#{rails_directory}/config/database.yml" do
 162     cookbook "web"
 163     source "database.yml.erb"
 164     owner new_resource.user
 165     group new_resource.group
 166     mode "664"
 167     variables :host => new_resource.database_host,
 168               :port => new_resource.database_port,
 169               :name => new_resource.database_name,
 170               :username => new_resource.database_username,
 171               :password => new_resource.database_password
 172   end
 173
 174   application_yml = edit_file "#{rails_directory}/config/example.application.yml" do |line|
 175     line.gsub!(/^( *)server_protocol:.*$/, "\\1server_protocol: \"https\"")
 176     line.gsub!(/^( *)server_url:.*$/, "\\1server_url: \"#{new_resource.site}\"")
 177
 178     line.gsub!(/^( *)support_email:.*$/, "\\1support_email: \"support@openstreetmap.org\"")
 179
 180     if new_resource.email_from
 181       line.gsub!(/^( *)email_from:.*$/, "\\1email_from: \"#{new_resource.email_from}\"")
 182     end
 183
 184     line.gsub!(/^( *)email_return_path:.*$/, "\\1email_return_path: \"bounces@openstreetmap.org\"")
 185
 186     line.gsub!(/^( *)status:.*$/, "\\1status: :#{new_resource.status}")
 187
 188     if new_resource.messages_domain
 189       line.gsub!(/^( *)#messages_domain:.*$/, "\\1messages_domain: \"#{new_resource.messages_domain}\"")
 190     end
 191
 192     line.gsub!(/^( *)#geonames_username:.*$/, "\\1geonames_username: \"openstreetmap\"")
 193
 194     line.gsub!(/^( *)#maxmind_database:.*$/, "\\1maxmind_database: \"#{node[:geoipupdate][:directory]}/GeoLite2-Country.mmdb\"")
 195
 196     if new_resource.gpx_dir
 197       line.gsub!(/^( *)gpx_trace_dir:.*$/, "\\1gpx_trace_dir: \"#{new_resource.gpx_dir}/traces\"")
 198       line.gsub!(/^( *)gpx_image_dir:.*$/, "\\1gpx_image_dir: \"#{new_resource.gpx_dir}/images\"")
 199     end
 200
 201     if new_resource.attachments_dir
 202       line.gsub!(/^( *)attachments_dir:.*$/, "\\1attachments_dir: \"#{new_resource.attachments_dir}\"")
 203     end
 204
 205     if new_resource.log_path
 206       line.gsub!(/^( *)#log_path:.*$/, "\\1log_path: \"#{new_resource.log_path}\"")
 207     end
 208
 209     if new_resource.memcache_servers
 210       line.gsub!(/^( *)#memcache_servers:.*$/, "\\1memcache_servers: [ \"#{new_resource.memcache_servers.join('", "')}\" ]")
 211     end
 212
 213     if new_resource.potlatch2_key
 214       line.gsub!(/^( *)#potlatch2_key:.*$/, "\\1potlatch2_key: \"#{new_resource.potlatch2_key}\"")
 215     end
 216
 217     if new_resource.id_key
 218       line.gsub!(/^( *)#id_key:.*$/, "\\1id_key: \"#{new_resource.id_key}\"")
 219     end
 220
 221     if new_resource.id_application
 222       line.gsub!(/^( *)#id_application:.*$/, "\\1id_application: \"#{new_resource.id_application}\"")
 223     end
 224
 225     if new_resource.oauth_key
 226       line.gsub!(/^( *)#oauth_key:.*$/, "\\1oauth_key: \"#{new_resource.oauth_key}\"")
 227     end
 228
 229     if new_resource.oauth_application
 230       line.gsub!(/^( *)#oauth_application:.*$/, "\\1oauth_application: \"#{new_resource.oauth_application}\"")
 231     end
 232
 233     if new_resource.nominatim_url
 234       line.gsub!(/^( *)nominatim_url:.*$/, "\\1nominatim_url: \"#{new_resource.nominatim_url}\"")
 235     end
 236
 237     if new_resource.overpass_url
 238       line.gsub!(/^( *)overpass_url:.*$/, "\\1overpass_url: \"#{new_resource.overpass_url}\"")
 239     end
 240
 241     if new_resource.google_auth_id
 242       line.gsub!(/^( *)#google_auth_id:.*$/, "\\1google_auth_id: \"#{new_resource.google_auth_id}\"")
 243       line.gsub!(/^( *)#google_auth_secret:.*$/, "\\1google_auth_secret: \"#{new_resource.google_auth_secret}\"")
 244       line.gsub!(/^( *)#google_openid_realm:.*$/, "\\1google_openid_realm: \"#{new_resource.google_openid_realm}\"")
 245     end
 246
 247     if new_resource.facebook_auth_id
 248       line.gsub!(/^( *)#facebook_auth_id:.*$/, "\\1facebook_auth_id: \"#{new_resource.facebook_auth_id}\"")
 249       line.gsub!(/^( *)#facebook_auth_secret:.*$/, "\\1facebook_auth_secret: \"#{new_resource.facebook_auth_secret}\"")
 250     end
 251
 252     if new_resource.microsoft_auth_id
 253       line.gsub!(/^( *)#microsoft_auth_id:.*$/, "\\1microsoft_auth_id: \"#{new_resource.microsoft_auth_id}\"")
 254       line.gsub!(/^( *)#microsoft_auth_secret:.*$/, "\\1microsoft_auth_secret: \"#{new_resource.microsoft_auth_secret}\"")
 255     end
 256
 257     if new_resource.github_auth_id
 258       line.gsub!(/^( *)#github_auth_id:.*$/, "\\1github_auth_id: \"#{new_resource.github_auth_id}\"")
 259       line.gsub!(/^( *)#github_auth_secret:.*$/, "\\1github_auth_secret: \"#{new_resource.github_auth_secret}\"")
 260     end
 261
 262     if new_resource.wikipedia_auth_id
 263       line.gsub!(/^( *)#wikipedia_auth_id:.*$/, "\\1wikipedia_auth_id: \"#{new_resource.wikipedia_auth_id}\"")
 264       line.gsub!(/^( *)#wikipedia_auth_secret:.*$/, "\\1wikipedia_auth_secret: \"#{new_resource.wikipedia_auth_secret}\"")
 265     end
 266
 267     if new_resource.thunderforest_key
 268       line.gsub!(/^( *)#thunderforest_key:.*$/, "\\1thunderforest_key: \"#{new_resource.thunderforest_key}\"")
 269     end
 270
 271     if new_resource.totp_key
 272       line.gsub!(/^( *)#totp_key:.*$/, "\\1totp_key: \"#{new_resource.totp_key}\"")
 273     end
 274
 275     if new_resource.csp_enforce
 276       line.gsub!(/^( *)csp_enforce:.*$/, "\\1csp_enforce: \"#{new_resource.csp_enforce}\"")
 277     end
 278
 279     if new_resource.csp_report_url
 280       line.gsub!(/^( *)#csp_report_url:.*$/, "\\1csp_report_url: \"#{new_resource.csp_report_url}\"")
 281     end
 282
 283     line.gsub!(/^( *)require_terms_seen:.*$/, "\\1require_terms_seen: true")
 284     line.gsub!(/^( *)require_terms_agreed:.*$/, "\\1require_terms_agreed: true")
 285     line.gsub!(/^( *)trace_use_job_queue:.*$/, "\\1trace_use_job_queue: false")
 286
 287     line
 288   end
 289
 290   file "create:#{rails_directory}/config/application.yml" do
 291     path "#{rails_directory}/config/application.yml"
 292     owner new_resource.user
 293     group new_resource.group
 294     mode "664"
 295     content application_yml
 296     only_if { ::File.exist?("#{rails_directory}/config/example.application.yml") }
 297   end
 298
 299   file "delete:#{rails_directory}/config/application.yml" do
 300     path "#{rails_directory}/config/application.yml"
 301     action :delete
 302     not_if { ::File.exist?("#{rails_directory}/config/example.application.yml") }
 303   end
 304
 305   settings = new_resource.to_hash.transform_keys(&:to_s).slice(
 306     "email_from",
 307     "status",
 308     "messages_domain",
 309     "attachments_dir",
 310     "log_path",
 311     "potlatch2_key",
 312     "id_key",
 313     "id_application",
 314     "oauth_key",
 315     "oauth_application",
 316     "nominatim_url",
 317     "overpass_url",
 318     "overpass_credentials",
 319     "google_auth_id",
 320     "google_auth_secret",
 321     "google_openid_realm",
 322     "apple_auth_id",
 323     "apple_team_id",
 324     "apple_key_id",
 325     "apple_private_key",
 326     "facebook_auth_id",
 327     "facebook_auth_secret",
 328     "microsoft_auth_id",
 329     "microsoft_auth_secret",
 330     "github_auth_id",
 331     "github_auth_secret",
 332     "wikipedia_auth_id",
 333     "wikipedia_auth_secret",
 334     "thunderforest_key",
 335     "tracestrack_key",
 336     "maptiler_key",
 337     "totp_key",
 338     "csp_enforce",
 339     "csp_report_url",
 340     "trace_use_job_queue",
 341     "diary_feed_delay",
 342     "storage_service",
 343     "storage_url",
 344     "avatar_storage",
 345     "trace_file_storage",
 346     "trace_image_storage",
 347     "trace_icon_storage",
 348     "avatar_storage_url",
 349     "trace_image_storage_url",
 350     "trace_icon_storage_url",
 351     "tile_cdn_url",
 352     "imagery_blacklist",
 353     "signup_ip_per_day",
 354     "signup_ip_max_burst",
 355     "signup_email_per_day",
 356     "signup_email_max_burst",
 357     "doorkeeper_signing_key",
 358     "user_account_deletion_delay"
 359   ).compact.merge(
 360     "server_protocol" => "https",
 361     "server_url" => new_resource.site,
 362     "support_email" => "support@openstreetmap.org",
 363     "email_return_path" => "bounces@openstreetmap.org",
 364     "geonames_username" => "openstreetmap",
 365     "maxmind_database" => "#{node[:geoipupdate][:directory]}/GeoLite2-Country.mmdb",
 366     "max_request_area" => node[:web][:max_request_area],
 367     "max_number_of_nodes" => node[:web][:max_number_of_nodes],
 368     "max_number_of_way_nodes" => node[:web][:max_number_of_way_nodes],
 369     "max_number_of_relation_members" => node[:web][:max_number_of_relation_members],
 370     "oauth_10_support" => false,
 371     "oauth_10_registration" => false,
 372     "oauth_10a_support" => false,
 373     "basic_auth_support" => false
 374   )
 375
 376   if new_resource.memcache_servers
 377     settings["memcache_servers"] = new_resource.memcache_servers.to_a
 378   end
 379
 380   if new_resource.gpx_dir
 381     settings["gpx_trace_dir"] = "#{new_resource.gpx_dir}/traces"
 382     settings["gpx_image_dir"] = "#{new_resource.gpx_dir}/images"
 383   end
 384
 385   if new_resource.matomo_configuration
 386     settings["matomo"] = new_resource.matomo_configuration.to_h
 387   end
 388
 389   file "#{rails_directory}/config/settings.local.yml" do
 390     owner new_resource.user
 391     group new_resource.group
 392     mode "664"
 393     content YAML.dump(settings)
 394     only_if { ::File.exist?("#{rails_directory}/config/settings.yml") }
 395   end
 396
 397   storage_configuration = new_resource.storage_configuration.merge(
 398     "local" => {
 399       "service" => "Disk",
 400       "root" => "#{rails_directory}/storage"
 401     }
 402   )
 403
 404   file "#{rails_directory}/config/storage.yml" do
 405     owner new_resource.user
 406     group new_resource.group
 407     mode "664"
 408     content YAML.dump(storage_configuration)
 409   end
 410
 411   file "#{rails_directory}/config/piwik.yml" do
 412     action :delete
 413   end
 414
 415   directory "#{rails_directory}/vendor/bundle/ruby/#{node[:ruby][:version]}.0" do
 416     owner new_resource.user
 417     group new_resource.group
 418     mode "775"
 419     recursive true
 420   end
 421
 422   bundle_config rails_directory do
 423     user new_resource.user
 424     group new_resource.group
 425     settings "deployment" => "true",
 426              "build.nokogiri" => "--use-system-libraries"
 427   end
 428
 429   bundle_install rails_directory do
 430     action :nothing
 431     user new_resource.user
 432     group new_resource.group
 433     subscribes :run, "directory[#{rails_directory}/vendor/bundle/ruby/#{node[:ruby][:version]}.0]"
 434     subscribes :run, "git[#{rails_directory}]"
 435   end
 436
 437   bundle_exec "#{rails_directory}/db/migrate" do
 438     action :nothing
 439     directory rails_directory
 440     command "rails db:migrate"
 441     user new_resource.user
 442     group new_resource.group
 443     subscribes :run, "git[#{rails_directory}]"
 444     only_if { new_resource.run_migrations }
 445   end
 446
 447   bundle_exec "#{rails_directory}/package.json" do
 448     action :nothing
 449     directory rails_directory
 450     command "rails yarn:install"
 451     environment "HOME" => rails_directory,
 452                 "RAILS_ENV" => "production",
 453                 "SECRET_KEY_BASE_DUMMY" => "1"
 454     user new_resource.user
 455     group new_resource.group
 456     subscribes :run, "git[#{rails_directory}]"
 457     only_if { new_resource.build_assets }
 458   end
 459
 460   bundle_exec "#{rails_directory}/config/i18n-js.yml" do
 461     action :nothing
 462     directory rails_directory
 463     command "rails i18n:js:export"
 464     environment "HOME" => rails_directory,
 465                 "RAILS_ENV" => "production",
 466                 "SECRET_KEY_BASE_DUMMY" => "1"
 467     user new_resource.user
 468     group new_resource.group
 469     subscribes :run, "git[#{rails_directory}]"
 470     only_if { new_resource.build_assets && ::File.exist?("#{rails_directory}/config/i18n-js.yml") }
 471   end
 472
 473   bundle_exec "#{rails_directory}/config/i18n.yml" do
 474     action :nothing
 475     directory rails_directory
 476     command "i18n export"
 477     environment "HOME" => rails_directory
 478     user new_resource.user
 479     group new_resource.group
 480     subscribes :run, "git[#{rails_directory}]"
 481     only_if { new_resource.build_assets && ::File.exist?("#{rails_directory}/config/i18n.yml") }
 482   end
 483
 484   bundle_exec "#{rails_directory}/public/assets" do
 485     action :nothing
 486     directory rails_directory
 487     command "rails assets:precompile"
 488     environment "HOME" => rails_directory,
 489                 "RAILS_ENV" => "production",
 490                 "SECRET_KEY_BASE_DUMMY" => "1"
 491     user new_resource.user
 492     group new_resource.group
 493     subscribes :run, "git[#{rails_directory}]"
 494     subscribes :run, "file[create:#{rails_directory}/config/application.yml]"
 495     subscribes :run, "file[#{rails_directory}/config/settings.local.yml]"
 496     subscribes :run, "file[#{rails_directory}/config/storage.yml]"
 497     subscribes :run, "bundle_exec[#{rails_directory}/package.json]"
 498     subscribes :run, "bundle_exec[#{rails_directory}/config/i18n-js.yml]"
 499     subscribes :run, "bundle_exec[#{rails_directory}/config/i18n.yml]"
 500     only_if { new_resource.build_assets }
 501   end
 502
 503   file "#{rails_directory}/public/export/embed.html" do
 504     action :nothing
 505     subscribes :delete, "git[#{rails_directory}]"
 506     subscribes :delete, "file[#{rails_directory}/config/settings.local.yml]"
 507   end
 508
 509   passenger_application rails_directory do
 510     action :nothing
 511     subscribes :restart, "git[#{rails_directory}]"
 512     subscribes :restart, "file[#{rails_directory}/config/database.yml]"
 513     subscribes :restart, "file[create:#{rails_directory}/config/application.yml]"
 514     subscribes :restart, "file[#{rails_directory}/config/settings.local.yml]"
 515     subscribes :restart, "file[#{rails_directory}/config/storage.yml]"
 516     subscribes :restart, "bundle_installl[#{rails_directory}]"
 517     subscribes :restart, "bundle_exec[#{rails_directory}/db/migrate]"
 518     subscribes :restart, "bundle_exec[#{rails_directory}/package.json]"
 519     subscribes :restart, "bundle_exec[#{rails_directory}/app/assets/javascripts/i18n]"
 520     subscribes :restart, "bundle_exec[#{rails_directory}/public/assets]"
 521     only_if { ::File.exist?("/usr/bin/passenger-config") }
 522   end
 523
 524   template "/etc/cron.daily/rails-#{new_resource.site.tr('.', '-')}" do
 525     cookbook "web"
 526     source "rails.cron.erb"
 527     owner "root"
 528     group "root"
 529     mode "755"
 530     variables :directory => rails_directory
 531   end
 532 end
 533
 534 action :restart do
 535   passenger_application rails_directory do
 536     action :restart
 537   end
 538 end
 539
 540 action_class do
 541   include OpenStreetMap::Mixin::EditFile
 542
 543   def rails_directory
 544     new_resource.directory || "/srv/#{new_resource.site}"
 545   end
 546 end