From: Tom Hughes Date: Sat, 3 Dec 2022 10:59:14 +0000 (+0000) Subject: Merge remote-tracking branch 'upstream/pull/3126' X-Git-Tag: live~1459 X-Git-Url: https://git.openstreetmap.org./rails.git/commitdiff_plain/12c1d5e6c05813a0697724277b4d8529a1a7c240?hp=-c Merge remote-tracking branch 'upstream/pull/3126' --- 12c1d5e6c05813a0697724277b4d8529a1a7c240 diff --combined .github/workflows/tests.yml index 79811c612,15283da66..aa31089c5 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@@ -2,30 -2,33 +2,30 @@@ name: Test on: - push - pull_request +concurrency: + group: ${{ github.workflow }}-${{ github.head_ref || github.ref }} + cancel-in-progress: true jobs: test: name: Ubuntu ${{ matrix.ubuntu }}, Ruby ${{ matrix.ruby }} strategy: matrix: - ubuntu: [18.04, 20.04] - ruby: [2.5, 2.7] + ubuntu: [20.04] + ruby: [2.7, 3.0] runs-on: ubuntu-${{ matrix.ubuntu }} env: RAILS_ENV: test OPENSTREETMAP_MEMCACHE_SERVERS: 127.0.0.1 steps: - name: Checkout source - uses: actions/checkout@v2.3.4 + uses: actions/checkout@v3 - name: Setup ruby - uses: actions/setup-ruby@v1 + uses: ruby/setup-ruby@v1 with: ruby-version: ${{ matrix.ruby }} - - name: Cache gems - uses: actions/cache@v2.1.4 - with: - path: vendor/bundle - key: bundle-ubuntu-${{ matrix.ubuntu }}-ruby-${{ matrix.ruby }}-${{ hashFiles('Gemfile.lock') }} - restore-keys: | - bundle-ubuntu-${{ matrix.ubuntu }}-ruby-${{ matrix.ruby }}- + bundler-cache: true - name: Cache node modules - uses: actions/cache@v2.1.4 + uses: actions/cache@v3 with: path: node_modules key: yarn-ubuntu-${{ matrix.ubuntu }}-${{ hashFiles('yarn.lock') }} @@@ -34,13 -37,17 +34,12 @@@ - name: Install packages run: | sudo apt-get -yqq update - sudo apt-get -yqq install memcached - - name: Install gems - run: | - gem install bundler - bundle config set deployment true - bundle install --jobs 4 --retry 3 + sudo apt-get -yqq install memcached libvips-dev - name: Create database run: | sudo systemctl start postgresql sudo -u postgres createuser -s $(id -un) createdb openstreetmap - psql -c "CREATE EXTENSION btree_gist" openstreetmap psql -f db/functions/functions.sql openstreetmap - name: Configure rails run: | @@@ -58,9 -65,9 +57,9 @@@ - name: Install node modules run: bundle exec rake yarn:install - name: Run tests - run: bundle exec rake test:db + run: bundle exec rails test:all - name: Report completion to Coveralls - uses: coverallsapp/github-action@v1.1.2 + uses: coverallsapp/github-action@1.1.3 with: github-token: ${{ secrets.github_token }} flag-name: ubuntu-${{ matrix.ubuntu }}-ruby-${{ matrix.ruby }} @@@ -71,7 -78,7 +70,7 @@@ runs-on: ubuntu-latest steps: - name: Report completion to Coveralls - uses: coverallsapp/github-action@v1.1.2 + uses: coverallsapp/github-action@1.1.3 with: github-token: ${{ secrets.github_token }} parallel-finished: true diff --combined INSTALL.md index b14a2d32b,e2f46d900..b9aa1a329 --- a/INSTALL.md +++ b/INSTALL.md @@@ -1,6 -1,6 +1,6 @@@ # Installation -These instructions are designed for setting up The Rails Port for development and testing. +These instructions are designed for setting up `openstreetmap-website` for development and testing. If you want to deploy the software for your own project, then see the notes at the end. You can install the software directly on your machine, which is the traditional and probably best-supported approach. However, there @@@ -12,7 -12,7 +12,7 @@@ are two alternatives which make it easi These instructions are based on Ubuntu 20.04 LTS, which is the platform used by the OSMF servers. The instructions also work, with only minor amendments, for all other current Ubuntu releases, Fedora and MacOSX -We don't recommend attempting to develop or deploy this software on Windows. If you need to use Windows, then try developing this software using Ubuntu in a virtual machine, or use [Vagrant](VAGRANT.md). +We don't recommend attempting to develop or deploy this software on Windows. Some Ruby gems may not be supported. If you need to use Windows the easiest solutions in order are [Docker](DOCKER.md), [Vagrant](VAGRANT.md), and Ubuntu in a virtual machine. ## Dependencies @@@ -24,6 -24,7 +24,6 @@@ of packages required before you can ge * Ruby 2.7+ * PostgreSQL 9.1+ -* ImageMagick * Bundler (see note below about [developer Ruby setup](#rbenv)) * Javascript Runtime @@@ -32,10 -33,10 +32,10 @@@ These can be installed on Ubuntu 20.04 ``` sudo apt-get update sudo apt-get install ruby2.7 libruby2.7 ruby2.7-dev \ - libmagickwand-dev libxml2-dev libxslt1-dev nodejs \ + libvips-dev libxml2-dev libxslt1-dev nodejs \ apache2 apache2-dev build-essential git-core firefox-geckodriver \ postgresql postgresql-contrib libpq-dev libsasl2-dev \ - imagemagick libffi-dev libgd-dev libarchive-dev libbz2-dev yarnpkg + libffi-dev libgd-dev libarchive-dev libbz2-dev yarnpkg sudo gem2.7 install bundler ``` @@@ -47,11 -48,11 +47,11 @@@ For Fedora, you can install the minimu ``` sudo dnf install ruby ruby-devel rubygem-rdoc rubygem-bundler rubygems \ - libxml2-devel js \ + libxml2-devel nodejs \ gcc gcc-c++ git \ - postgresql postgresql-server postgresql-contrib \ - perl-podlators ImageMagick libffi-devel gd-devel libarchive-devel \ - bzip2-devel nodejs-yarn + postgresql postgresql-server postgresql-contrib libpq-devel \ + perl-podlators libffi-devel gd-devel libarchive-devel \ + bzip2-devel nodejs-yarn vips-devel ``` If you didn't already have PostgreSQL installed then create a PostgreSQL instance and start the server: @@@ -89,7 -90,7 +89,7 @@@ Installing other dependencies * Install Homebrew from https://brew.sh/ * Install the latest version of Ruby: `brew install ruby` -* Install other dependencies: `brew install imagemagick libxml2 gd yarn pngcrush optipng pngquant jhead jpegoptim gifsicle svgo` +* Install other dependencies: `brew install libxml2 gd yarn pngcrush optipng pngquant jhead jpegoptim gifsicle svgo advancecomp vips` * Install Bundler: `gem install bundler` (you might need to `sudo gem install bundler` if you get an error about permissions - or see note below about [developer Ruby setup](#rbenv)) You will need to tell `bundler` that `libxml2` is installed in a Homebrew location. If it uses the system-installed one then you will get errors installing the `libxml-ruby` gem later on. @@@ -101,7 -102,8 +101,7 @@@ bundle config build.libxml-ruby --with- If you want to run the tests, you need `geckodriver` as well: ``` -brew tap homebrew/cask -brew cask install geckodriver +brew install geckodriver ``` Note that OS X does not have a /home directory by default, so if you are using the GPX functions, you will need to change the directories specified in config/application.yml. @@@ -150,7 -152,7 +150,7 @@@ touch config/settings.local.ym ## Storage setup -The Rails port needs to be configured with an object storage facility - for +`openstreetmap-website` needs to be configured with an object storage facility - for development and testing purposes you can use the example configuration: ``` @@@ -159,7 -161,7 +159,7 @@@ cp config/example.storage.yml config/st ## Database setup -The Rails Port uses three databases - one for development, one for testing, and one for production. The database-specific configuration +`openstreetmap-website` uses three databases - one for development, one for testing, and one for production. The database-specific configuration options are stored in `config/database.yml`, which we need to create from the example template. ``` @@@ -188,14 -190,6 +188,6 @@@ To create the three databases - for dev bundle exec rake db:create ``` - ### PostgreSQL Btree-gist Extension - - We need to load the `btree-gist` extension, which is needed for showing changesets on the history tab. - - ``` - psql -d openstreetmap -c "CREATE EXTENSION btree_gist" - ``` - ### PostgreSQL Functions We need to install some special functions into the PostgreSQL database: @@@ -217,7 -211,7 +209,7 @@@ bundle exec rake db:migrat To ensure that everything is set up properly, you should now run: ``` -bundle exec rake test:db +bundle exec rails test:all ``` This test will take a few minutes, reporting tests run, assertions, and any errors. If you receive no errors, then your installation is successful. @@@ -276,6 -270,7 +268,6 @@@ Then we create the functions within eac ``` psql -d openstreetmap -c "CREATE FUNCTION tile_for_point(int4, int4) RETURNS int8 AS '`pwd`/db/functions/libpgosm', 'tile_for_point' LANGUAGE C STRICT" -psql -d openstreetmap -c "CREATE FUNCTION xid_to_int4(xid) RETURNS int4 AS '`pwd`/db/functions/libpgosm', 'xid_to_int4' LANGUAGE C STRICT" ``` # Ruby development install and versions (optional) diff --combined script/vagrant/setup/provision.sh index c17ddd1d6,93e91e721..bfe12a3c6 --- a/script/vagrant/setup/provision.sh +++ b/script/vagrant/setup/provision.sh @@@ -17,10 -17,10 +17,10 @@@ apt-get upgrade - # install packages as explained in INSTALL.md apt-get install -y ruby2.7 libruby2.7 ruby2.7-dev \ - libmagickwand-dev libxml2-dev libxslt1-dev nodejs yarnpkg \ + libxml2-dev libxslt1-dev nodejs yarnpkg \ apache2 apache2-dev build-essential git-core firefox-geckodriver \ - postgresql postgresql-contrib libpq-dev \ - libsasl2-dev imagemagick libffi-dev libgd-dev libarchive-dev libbz2-dev + postgresql postgresql-contrib libpq-dev libvips-dev \ + libsasl2-dev libffi-dev libgd-dev libarchive-dev libbz2-dev gem2.7 install rake gem2.7 install --version "~> 2.1.4" bundler @@@ -36,9 -36,6 +36,6 @@@ if [ "$db_user_exists" != "1" ]; the sudo -u postgres createuser -s vagrant sudo -u vagrant createdb -E UTF-8 -O vagrant openstreetmap sudo -u vagrant createdb -E UTF-8 -O vagrant osm_test - # add btree_gist extension - sudo -u vagrant psql -c "create extension btree_gist" openstreetmap - sudo -u vagrant psql -c "create extension btree_gist" osm_test fi @@@ -53,6 -50,7 +50,6 @@@ sudo -u vagrant psql -d openstreetmap - #pushd db/functions #sudo -u vagrant make #sudo -u vagrant psql openstreetmap -c "CREATE OR REPLACE FUNCTION tile_for_point(int4, int4) RETURNS int8 AS '/srv/openstreetmap-website/db/functions/libpgosm.so', 'tile_for_point' LANGUAGE C STRICT" -#sudo -u vagrant psql openstreetmap -c "CREATE OR REPLACE FUNCTION xid_to_int4(xid) RETURNS int4 AS '/srv/openstreetmap-website/db/functions/libpgosm.so', 'xid_to_int4' LANGUAGE C STRICT" #popd @@@ -60,9 -58,6 +57,9 @@@ if [ ! -f config/database.yml ]; then sudo -u vagrant cp config/example.database.yml config/database.yml fi +if [ ! -f config/storage.yml ]; then + cp config/example.storage.yml config/storage.yml +fi touch config/settings.local.yml # migrate the database to the latest version sudo -u vagrant bundle exec rake db:migrate