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 :oauth_application, String
  56 property :nominatim_url, String
  57 property :overpass_url, String
  58 property :google_auth_id, String
  59 property :google_auth_secret, String
  60 property :google_openid_realm, String
  61 property :facebook_auth_id, String
  62 property :facebook_auth_secret, String
  63 property :windowslive_auth_id, String
  64 property :windowslive_auth_secret, String
  65 property :github_auth_id, String
  66 property :github_auth_secret, String
  67 property :wikipedia_auth_id, String
  68 property :wikipedia_auth_secret, String
  69 property :thunderforest_key, String
  70 property :totp_key, String
  71 property :csp_enforce, [true, false], :default => false
  72 property :csp_report_url, String
  73 property :piwik_configuration, Hash
  74 property :trace_use_job_queue, [true, false], :default => false
  75 property :diary_feed_delay, Integer
  76 property :storage_configuration, Hash, :default => {}
  77 property :storage_service, String, :default => "local"
  78 property :storage_url, String
  79 property :tile_cdn_url, String
  80
  81 action :create do
  82   package %W[
  83     ruby#{new_resource.ruby}
  84     ruby#{new_resource.ruby}-dev
  85     imagemagick
  86     nodejs
  87     tzdata
  88   ]
  89
  90   package %w[
  91     g++
  92     make
  93     pkg-config
  94     libpq-dev
  95     libsasl2-dev
  96     libxml2-dev
  97     libxslt1-dev
  98     libmemcached-dev
  99     libffi-dev
 100     libgd-dev
 101     libarchive-dev
 102     libbz2-dev
 103   ]
 104
 105   package %w[
 106     pngcrush
 107     advancecomp
 108     optipng
 109     pngquant
 110     jhead
 111     jpegoptim
 112     gifsicle
 113     libjpeg-turbo-progs
 114   ]
 115
 116   gem_package "bundler#{new_resource.ruby}" do
 117     package_name "bundler"
 118     version "2.1.4"
 119     gem_binary "gem#{new_resource.ruby}"
 120     options "--format-executable"
 121   end
 122
 123   gem_package "bundler#{new_resource.ruby}" do
 124     package_name "pkg-config"
 125     gem_binary "gem#{new_resource.ruby}"
 126   end
 127
 128   declare_resource :directory, rails_directory do
 129     owner new_resource.user
 130     group new_resource.group
 131     mode "2775"
 132   end
 133
 134   git rails_directory do
 135     action :sync
 136     repository new_resource.repository
 137     revision new_resource.revision
 138     depth 1
 139     user new_resource.user
 140     group new_resource.group
 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   end
 165
 166   application_yml = edit_file "#{rails_directory}/config/example.application.yml" do |line|
 167     line.gsub!(/^( *)server_protocol:.*$/, "\\1server_protocol: \"https\"")
 168     line.gsub!(/^( *)server_url:.*$/, "\\1server_url: \"#{new_resource.site}\"")
 169
 170     line.gsub!(/^( *)support_email:.*$/, "\\1support_email: \"support@openstreetmap.org\"")
 171
 172     if new_resource.email_from
 173       line.gsub!(/^( *)email_from:.*$/, "\\1email_from: \"#{new_resource.email_from}\"")
 174     end
 175
 176     line.gsub!(/^( *)email_return_path:.*$/, "\\1email_return_path: \"bounces@openstreetmap.org\"")
 177
 178     line.gsub!(/^( *)status:.*$/, "\\1status: :#{new_resource.status}")
 179
 180     if new_resource.messages_domain
 181       line.gsub!(/^( *)#messages_domain:.*$/, "\\1messages_domain: \"#{new_resource.messages_domain}\"")
 182     end
 183
 184     line.gsub!(/^( *)#geonames_username:.*$/, "\\1geonames_username: \"openstreetmap\"")
 185
 186     line.gsub!(/^( *)#maxmind_database:.*$/, "\\1maxmind_database: \"/usr/share/GeoIP/GeoLite2-Country.mmdb\"")
 187
 188     if new_resource.gpx_dir
 189       line.gsub!(/^( *)gpx_trace_dir:.*$/, "\\1gpx_trace_dir: \"#{new_resource.gpx_dir}/traces\"")
 190       line.gsub!(/^( *)gpx_image_dir:.*$/, "\\1gpx_image_dir: \"#{new_resource.gpx_dir}/images\"")
 191     end
 192
 193     if new_resource.attachments_dir
 194       line.gsub!(/^( *)attachments_dir:.*$/, "\\1attachments_dir: \"#{new_resource.attachments_dir}\"")
 195     end
 196
 197     if new_resource.log_path
 198       line.gsub!(/^( *)#log_path:.*$/, "\\1log_path: \"#{new_resource.log_path}\"")
 199     end
 200
 201     if new_resource.logstash_path
 202       line.gsub!(/^( *)#logstash_path:.*$/, "\\1logstash_path: \"#{new_resource.logstash_path}\"")
 203     end
 204
 205     if new_resource.memcache_servers
 206       line.gsub!(/^( *)#memcache_servers:.*$/, "\\1memcache_servers: [ \"#{new_resource.memcache_servers.join('", "')}\" ]")
 207     end
 208
 209     if new_resource.potlatch2_key
 210       line.gsub!(/^( *)#potlatch2_key:.*$/, "\\1potlatch2_key: \"#{new_resource.potlatch2_key}\"")
 211     end
 212
 213     if new_resource.id_key
 214       line.gsub!(/^( *)#id_key:.*$/, "\\1id_key: \"#{new_resource.id_key}\"")
 215     end
 216
 217     if new_resource.oauth_key
 218       line.gsub!(/^( *)#oauth_key:.*$/, "\\1oauth_key: \"#{new_resource.oauth_key}\"")
 219     end
 220
 221     if new_resource.oauth_application
 222       line.gsub!(/^( *)#oauth_application:.*$/, "\\1oauth_application: \"#{new_resource.oauth_application}\"")
 223     end
 224
 225     if new_resource.nominatim_url
 226       line.gsub!(/^( *)nominatim_url:.*$/, "\\1nominatim_url: \"#{new_resource.nominatim_url}\"")
 227     end
 228
 229     if new_resource.overpass_url
 230       line.gsub!(/^( *)overpass_url:.*$/, "\\1overpass_url: \"#{new_resource.overpass_url}\"")
 231     end
 232
 233     if new_resource.google_auth_id
 234       line.gsub!(/^( *)#google_auth_id:.*$/, "\\1google_auth_id: \"#{new_resource.google_auth_id}\"")
 235       line.gsub!(/^( *)#google_auth_secret:.*$/, "\\1google_auth_secret: \"#{new_resource.google_auth_secret}\"")
 236       line.gsub!(/^( *)#google_openid_realm:.*$/, "\\1google_openid_realm: \"#{new_resource.google_openid_realm}\"")
 237     end
 238
 239     if new_resource.facebook_auth_id
 240       line.gsub!(/^( *)#facebook_auth_id:.*$/, "\\1facebook_auth_id: \"#{new_resource.facebook_auth_id}\"")
 241       line.gsub!(/^( *)#facebook_auth_secret:.*$/, "\\1facebook_auth_secret: \"#{new_resource.facebook_auth_secret}\"")
 242     end
 243
 244     if new_resource.windowslive_auth_id
 245       line.gsub!(/^( *)#windowslive_auth_id:.*$/, "\\1windowslive_auth_id: \"#{new_resource.windowslive_auth_id}\"")
 246       line.gsub!(/^( *)#windowslive_auth_secret:.*$/, "\\1windowslive_auth_secret: \"#{new_resource.windowslive_auth_secret}\"")
 247     end
 248
 249     if new_resource.github_auth_id
 250       line.gsub!(/^( *)#github_auth_id:.*$/, "\\1github_auth_id: \"#{new_resource.github_auth_id}\"")
 251       line.gsub!(/^( *)#github_auth_secret:.*$/, "\\1github_auth_secret: \"#{new_resource.github_auth_secret}\"")
 252     end
 253
 254     if new_resource.wikipedia_auth_id
 255       line.gsub!(/^( *)#wikipedia_auth_id:.*$/, "\\1wikipedia_auth_id: \"#{new_resource.wikipedia_auth_id}\"")
 256       line.gsub!(/^( *)#wikipedia_auth_secret:.*$/, "\\1wikipedia_auth_secret: \"#{new_resource.wikipedia_auth_secret}\"")
 257     end
 258
 259     if new_resource.thunderforest_key
 260       line.gsub!(/^( *)#thunderforest_key:.*$/, "\\1thunderforest_key: \"#{new_resource.thunderforest_key}\"")
 261     end
 262
 263     if new_resource.totp_key
 264       line.gsub!(/^( *)#totp_key:.*$/, "\\1totp_key: \"#{new_resource.totp_key}\"")
 265     end
 266
 267     if new_resource.csp_enforce
 268       line.gsub!(/^( *)csp_enforce:.*$/, "\\1csp_enforce: \"#{new_resource.csp_enforce}\"")
 269     end
 270
 271     if new_resource.csp_report_url
 272       line.gsub!(/^( *)#csp_report_url:.*$/, "\\1csp_report_url: \"#{new_resource.csp_report_url}\"")
 273     end
 274
 275     line.gsub!(/^( *)require_terms_seen:.*$/, "\\1require_terms_seen: true")
 276     line.gsub!(/^( *)require_terms_agreed:.*$/, "\\1require_terms_agreed: true")
 277     line.gsub!(/^( *)trace_use_job_queue:.*$/, "\\1trace_use_job_queue: false")
 278
 279     line
 280   end
 281
 282   file "create:#{rails_directory}/config/application.yml" do
 283     path "#{rails_directory}/config/application.yml"
 284     owner new_resource.user
 285     group new_resource.group
 286     mode "664"
 287     content application_yml
 288     only_if { ::File.exist?("#{rails_directory}/config/example.application.yml") }
 289   end
 290
 291   file "delete:#{rails_directory}/config/application.yml" do
 292     path "#{rails_directory}/config/application.yml"
 293     action :delete
 294     not_if { ::File.exist?("#{rails_directory}/config/example.application.yml") }
 295   end
 296
 297   settings = new_resource.to_hash.transform_keys(&:to_s).slice(
 298     "email_from",
 299     "status",
 300     "messages_domain",
 301     "attachments_dir",
 302     "log_path",
 303     "logstash_path",
 304     "potlatch2_key",
 305     "id_key",
 306     "oauth_key",
 307     "oauth_application",
 308     "nominatim_url",
 309     "overpass_url",
 310     "google_auth_id",
 311     "google_auth_secret",
 312     "google_openid_realm",
 313     "facebook_auth_id",
 314     "facebook_auth_secret",
 315     "windowslive_auth_id",
 316     "windowslive_auth_secret",
 317     "github_auth_id",
 318     "github_auth_secret",
 319     "wikipedia_auth_id",
 320     "wikipedia_auth_secret",
 321     "thunderforest_key",
 322     "totp_key",
 323     "csp_enforce",
 324     "csp_report_url",
 325     "trace_use_job_queue",
 326     "diary_feed_delay",
 327     "storage_service",
 328     "storage_url",
 329     "tile_cdn_url"
 330   ).compact.merge(
 331     "server_protocol" => "https",
 332     "server_url" => new_resource.site,
 333     "support_email" => "support@openstreetmap.org",
 334     "email_return_path" => "bounces@openstreetmap.org",
 335     "geonames_username" => "openstreetmap",
 336     "maxmind_database" => "/usr/share/GeoIP/GeoLite2-Country.mmdb"
 337   )
 338
 339   if new_resource.memcache_servers
 340     settings["memcache_servers"] = new_resource.memcache_servers.to_a
 341   end
 342
 343   if new_resource.gpx_dir
 344     settings["gpx_trace_dir"] = "#{new_resource.gpx_dir}/traces"
 345     settings["gpx_image_dir"] = "#{new_resource.gpx_dir}/images"
 346   end
 347
 348   file "#{rails_directory}/config/settings.local.yml" do
 349     owner new_resource.user
 350     group new_resource.group
 351     mode "664"
 352     content YAML.dump(settings)
 353     only_if { ::File.exist?("#{rails_directory}/config/settings.yml") }
 354   end
 355
 356   storage_configuration = new_resource.storage_configuration.merge(
 357     "local" => {
 358       "service" => "Disk",
 359       "root" => "#{rails_directory}/storage"
 360     }
 361   )
 362
 363   file "#{rails_directory}/config/storage.yml" do
 364     owner new_resource.user
 365     group new_resource.group
 366     mode "664"
 367     content YAML.dump(storage_configuration)
 368   end
 369
 370   if new_resource.piwik_configuration
 371     file "#{rails_directory}/config/piwik.yml" do
 372       owner new_resource.user
 373       group new_resource.group
 374       mode "664"
 375       content YAML.dump(new_resource.piwik_configuration)
 376     end
 377   else
 378     file "#{rails_directory}/config/piwik.yml" do
 379       action :delete
 380     end
 381   end
 382
 383   execute "#{rails_directory}/Gemfile" do
 384     action :nothing
 385     command "bundle#{new_resource.ruby} install"
 386     cwd rails_directory
 387     user "root"
 388     group "root"
 389     environment "NOKOGIRI_USE_SYSTEM_LIBRARIES" => "yes"
 390     subscribes :run, "gem_package[bundler#{new_resource.ruby}]"
 391     subscribes :run, "git[#{rails_directory}]"
 392   end
 393
 394   execute "#{rails_directory}/db/migrate" do
 395     action :nothing
 396     command "bundle#{new_resource.ruby} exec rake db:migrate"
 397     cwd rails_directory
 398     user new_resource.user
 399     group new_resource.group
 400     subscribes :run, "git[#{rails_directory}]"
 401     only_if { new_resource.run_migrations }
 402   end
 403
 404   package "yarnpkg" do
 405     only_if { new_resource.build_assets }
 406   end
 407
 408   execute "#{rails_directory}/package.json" do
 409     action :nothing
 410     command "bundle#{new_resource.ruby} exec rake yarn:install"
 411     environment "HOME" => rails_directory,
 412                 "RAILS_ENV" => "production"
 413     cwd rails_directory
 414     user new_resource.user
 415     group new_resource.group
 416     subscribes :run, "git[#{rails_directory}]"
 417     only_if { new_resource.build_assets }
 418   end
 419
 420   execute "#{rails_directory}/app/assets/javascripts/i18n" do
 421     action :nothing
 422     command "bundle#{new_resource.ruby} exec rake i18n:js:export"
 423     environment "HOME" => rails_directory,
 424                 "RAILS_ENV" => "production"
 425     cwd rails_directory
 426     user new_resource.user
 427     group new_resource.group
 428     subscribes :run, "git[#{rails_directory}]"
 429     only_if { new_resource.build_assets }
 430   end
 431
 432   execute "#{rails_directory}/public/assets" do
 433     action :nothing
 434     command "bundle#{new_resource.ruby} exec rake assets:precompile"
 435     environment "HOME" => rails_directory,
 436                 "RAILS_ENV" => "production"
 437     cwd rails_directory
 438     user new_resource.user
 439     group new_resource.group
 440     subscribes :run, "git[#{rails_directory}]"
 441     subscribes :run, "file[create:#{rails_directory}/config/application.yml]"
 442     subscribes :run, "file[#{rails_directory}/config/settings.local.yml]"
 443     subscribes :run, "file[#{rails_directory}/config/storage.yml]"
 444     subscribes :run, "file[#{rails_directory}/config/piwik.yml]"
 445     subscribes :run, "execute[#{rails_directory}/package.json]"
 446     subscribes :run, "execute[#{rails_directory}/app/assets/javascripts/i18n]"
 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     subscribes :restart, "git[#{rails_directory}]"
 459     subscribes :restart, "file[#{rails_directory}/config/database.yml]"
 460     subscribes :restart, "file[create:#{rails_directory}/config/application.yml]"
 461     subscribes :restart, "file[#{rails_directory}/config/settings.local.yml]"
 462     subscribes :restart, "file[#{rails_directory}/config/storage.yml]"
 463     subscribes :restart, "file[#{rails_directory}/config/piwik.yml]"
 464     subscribes :restart, "execute[#{rails_directory}/Gemfile]"
 465     subscribes :restart, "execute[#{rails_directory}/db/migrate]"
 466     subscribes :restart, "execute[#{rails_directory}/package.json]"
 467     subscribes :restart, "execute[#{rails_directory}/app/assets/javascripts/i18n]"
 468     subscribes :restart, "execute[#{rails_directory}/public/assets]"
 469     only_if { ::File.exist?("/usr/bin/passenger-config") }
 470   end
 471
 472   template "/etc/cron.daily/rails-#{new_resource.site.tr('.', '-')}" do
 473     cookbook "web"
 474     source "rails.cron.erb"
 475     owner "root"
 476     group "root"
 477     mode "755"
 478     variables :directory => rails_directory
 479   end
 480 end
 481
 482 action :restart do
 483   passenger_application rails_directory do
 484     action :restart
 485   end
 486 end
 487
 488 action_class do
 489   include Chef::Mixin::EditFile
 490
 491   def rails_directory
 492     new_resource.directory || "/srv/#{new_resource.site}"
 493   end
 494 end