Merge pull request #18 from movabletype/release-2.0

Release 2.0

Author: usualoma

CHANGELOG.md

@@ -6,6 +6,32 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.0.0] - 2022-02-21
+
+### Added
+
+#### Customized Docker containers
+
+You can launch the container with customizations of your choice.
+And the development container configuration for Visual Studio Code is included by default.
+
+```
+$ make up-psgi ... DOCKER_MT_DOCKERFILE=Dockerfile.devcontainer REPO="$HOME/src/github.com/username/mt-plugin-AwesomePlugin"
+```
+
+#### Support mount flag (especially for Docker for Mac)
+
+Docker for Mac has slow file access on bind mounts, but if you use a dev container, using :delegated may improve the situation.
+
+```
+$ make up-psgi ... DOCKER_VOLUME_MOUNT_FLAG=delegated
+```
+
+### Changed
+
+* Also skip `git fetch` when "$UPDATE_BRANCH" is "no".
+* Rename environment variable DOCKER_COMPOSE_YML_MIDDLEWARES to DOCKER_COMPOSE_YAML_MIDDLEWARES
+
 ## [1.1.1] - 2022-01-03
 
 ### Changed

Makefile

@@ -1,12 +1,12 @@
 MAKEFILE_DIR=$(abspath $(dir $(lastword $(MAKEFILE_LIST))))
 
-export BASE_SITE_PATH=${MAKEFILE_DIR}/site
-export DOCKER=docker
-export DOCKER_COMPOSE=docker-compose
-export DOCKER_COMPOSE_YML_MIDDLEWARES=-f ./mt/mysql.yml -f ./mt/memcached.yml
-export UP_ARGS=-d
-export MT_HOME_PATH=${MAKEFILE_DIR}/../movabletype
-export UPDATE_BRANCH=yes
+export BASE_SITE_PATH:=${MAKEFILE_DIR}/site
+export DOCKER:=docker
+export DOCKER_COMPOSE:=${shell ${DOCKER} compose >/dev/null 2>&1 && echo 'docker compose' || echo 'docker-compose'}
+export DOCKER_COMPOSE_YAML_MIDDLEWARES:=-f ./mt/mysql.yml -f ./mt/memcached.yml
+export UP_ARGS:=-d
+export MT_HOME_PATH:=${MAKEFILE_DIR}/../movabletype
+export UPDATE_BRANCH:=yes
 
 MT_CONFIG_CGI=${shell [ -e mt-config.cgi ] && echo mt-config.cgi || echo mt-config.cgi-original}
 BASE_ARCHIVE_PATH=${MAKEFILE_DIR}/archive
@@ -18,17 +18,27 @@ endif
 ifneq (${PERL},)
 DOCKER_MT_IMAGE=movabletype/test:perl-${PERL}
 endif
+ifneq (${NODE},)
+DOCKER_NODEJS_IMAGE=node:${NODE}
+endif
 ifneq (${DB},)
 DOCKER_MYSQL_IMAGE=${DB}
 endif
 
+export DOCKER_COMPOSE_USER_YAML
+export DOCKER_MT_BUILD_CONTEXT
+export DOCKER_MT_DOCKERFILE
 export DOCKER_MT_IMAGE
 export DOCKER_MT_SERVICES
+export DOCKER_NODEJS_IMAGE
+export DOCKER_HTTPD_BUILD_CONTEXT
+export DOCKER_HTTPD_DOCKERFILE
 export DOCKER_HTTPD_IMAGE
 export DOCKER_MYSQL_IMAGE
 export DOCKER_MEMCACHED_IMAGE
 export DOCKER_LDAP_IMAGE
 export DOCKER_FTPD_IMAGE
+export DOCKER_VOLUME_MOUNT_FLAG
 export MT_RUN_VIA
 export HTTPD_EXPOSE_PORT
 export PLACKUP
@@ -57,7 +67,7 @@ ifeq ($(wildcard ${MT_CONFIG_CGI_SRC_PATH}),)
 $(error You should create ${MT_CONFIG_CGI_SRC_PATH} first.)
 endif
 
-_DC=${DOCKER_COMPOSE} -f ./mt/common.yml ${DOCKER_COMPOSE_YML_MIDDLEWARES}
+_DC=${DOCKER_COMPOSE} -f ./mt/common.yml ${DOCKER_COMPOSE_YAML_MIDDLEWARES} ${_DC_YAML_OVERRIDE} ${DOCKER_COMPOSE_USER_YAML}
 
 
 .PHONY: db up down
@@ -126,14 +136,16 @@ ifneq (${PR},)
 endif
 	${MAKE} up-common-invoke-docker-compose MT_HOME_PATH=${MT_HOME_PATH} ${_ARGS} RECIPE="" REPO="" PR="" $(shell [ -n "${DOCKER_MT_IMAGE}" ] && echo "DOCKER_MT_IMAGE=${DOCKER_MT_IMAGE}") $(shell [ -n "${DOCKER_MYSQL_IMAGE}" ] && echo "DOCKER_MYSQL_IMAGE=${DOCKER_MYSQL_IMAGE}")
 
+up-common-invoke-docker-compose: _DC_YAML_OVERRIDE=-f ./mt/${MT_RUN_VIA}.yml ${DOCKER_COMPOSE_YAML_OVERRIDE}
 up-common-invoke-docker-compose: setup-mysql-volume
 	@echo MT_HOME_PATH=${MT_HOME_PATH}
 	@echo BASE_SITE_PATH=${BASE_SITE_PATH}
 	@echo DOCKER_MT_IMAGE=${DOCKER_MT_IMAGE}
 	@echo DOCKER_HTTPD_IMAGE=${DOCKER_HTTPD_IMAGE}
 	@echo DOCKER_MYSQL_IMAGE=${DOCKER_MYSQL_IMAGE}
-	${_DC} -f ./mt/${MT_RUN_VIA}.yml ${DOCKER_COMPOSE_YML_OVERRIDE} pull
-	${_DC} -f ./mt/${MT_RUN_VIA}.yml ${DOCKER_COMPOSE_YML_OVERRIDE} up ${UP_ARGS}
+	${_DC} pull
+	${_DC} build
+	${_DC} up ${UP_ARGS}
 
 
 ifneq (${REMOVE_VOLUME},)

README.ja.md

@@ -36,7 +36,7 @@ $ vagrant mt-dev up ARCHIVE=MT7-R0000.zip
 $ vagrant mt-dev exec-mysql SQL='CREATE DATABASE mt /*!40100 DEFAULT CHARACTER SET utf8mb4 */'
 ```
 
-http://192.168.7.25/cgi-bin/mt/mt.cgi を開くとインストール画面になります。
+http://192.168.58.25/cgi-bin/mt/mt.cgi を開くとインストール画面になります。
 
 mt-config.cgiは、mt-dev/mt-config.cgi（またはなければmt-config.cgi-original）が使われます。
 

bin/git-clone

@@ -9,11 +9,10 @@ if [ ! -e $dir ]; then
     git clone $repo $dir
 fi
 
-cd $dir
-git fetch --all --prune
-git fetch --tags --prune
-
 if [ "$UPDATE_BRANCH" = "yes" -o "$UPDATE_BRANCH" = "1" ] && [ -n "$branch" ]; then
+    cd $dir
+    git fetch --all --tags --prune
+
     git checkout .
     git clean -f
 

bin/setup-environment

@@ -9,12 +9,13 @@ use lib "$FindBin::Bin/local/lib/perl5";
 
 use Cwd qw(realpath getcwd);
 use IO::File;
+use JSON::PP qw(encode_json);
 use Data::Dumper;
 use Digest::MD5;
 use Getopt::Long;
 use HTTP::Tiny;
 use Config::Tiny;
-use YAML::Tiny qw(LoadFile DumpFile);
+use YAML::Tiny qw(LoadFile Dump);
 use File::Basename qw(basename fileparse);
 use File::Spec::Functions qw(catfile);
 use File::Temp qw(tempfile tmpnam tempdir);
@@ -29,11 +30,15 @@ GetOptions(
 my $recipe_dir    = realpath("$FindBin::Bin/../recipe");
 my $repo_dir      = realpath("$FindBin::Bin/../repo");
 my $repo_base_dir = realpath("$FindBin::Bin/../..");
-my $archive_dir      = realpath("$FindBin::Bin/../archive");
+my $archive_dir   = realpath("$FindBin::Bin/../archive");
 my $git_clone_cmd = realpath("$FindBin::Bin/git-clone");
 
-my $env   = {};
-my $yamls = [];
+my $env       = {};
+my $yamls     = [];
+my $workspace = {
+    folders  => [],
+    settings => {},
+};
 
 sub handle_recipe {
     my $data = shift;
@@ -54,12 +59,12 @@ sub handle_recipe {
     for my $k ( keys %$data ) {
         my $repo     = $data->{$k}{location};
         my $dest_dir = $data->{$k}{directory} || do {
-            ( my $dir = $repo ) =~ s{.*/}{};
-            "$repo_base_dir/$dir";
+            "$repo_base_dir/@{[basename($repo)]}";
         };
         if ( $dest_dir !~ m{\A/} ) {
             $dest_dir = "$repo_base_dir/$dest_dir";
         }
+        ( my $basename = $dest_dir ) =~ s{.*/}{};
 
         if ( $k eq 'core' ) {
             $env->{MT_HOME_PATH} = $dest_dir;
@@ -69,18 +74,18 @@ sub handle_recipe {
             my $branch = $data->{$k}{branch} || '';
 
             for my $pr ( split /\s+/, $pull_reqs ) {
-                my ($pr_repo, $pr_id) = ($pr =~ m{([^/]+)/(pull/\d+)});
+                my ( $pr_repo, $pr_id ) = ( $pr =~ m{([^/]+)/(pull/\d+)} );
                 next unless $pr_repo && $pr_id;
-                $branch = $pr_id . '/head' if basename($dest_dir) eq $pr_repo;
+                $branch = $pr_id . '/head' if $basename eq $pr_repo;
             }
 
             {
                 my %repos = map { $_ => 1 } split /\s+/, $repos;
                 for my $r ( keys %repos ) {
-                    my ($bn, $br) = $r =~ m{([^/]+)#(.*)$}
+                    my ( $bn, $br ) = $r =~ m{([^/]+)#(.*)$}
                         or next;
 
-                    next unless basename($dest_dir) eq $bn;
+                    next unless $basename eq $bn;
 
                     $branch = $br;
                     delete $repos{$r};
@@ -97,6 +102,9 @@ sub handle_recipe {
             print STDERR "$k:$res";
         }
 
+        push @volumes, "      - '$dest_dir:/src/$basename:\${DOCKER_VOLUME_MOUNT_FLAG:-rw}'";
+        push @{ $workspace->{folders} }, { path => $basename, };
+
         next if $k eq 'core';
 
         my $plugin_dir = $dest_dir;
@@ -120,7 +128,8 @@ sub handle_recipe {
         }
 
         for my $l (@$links) {
-            push @volumes, "      - '$plugin_dir/$l:/var/www/cgi-bin/mt/$l'";
+            push @volumes,
+                "      - '$plugin_dir/$l:/var/www/cgi-bin/mt/$l:\${DOCKER_VOLUME_MOUNT_FLAG:-rw}'";
         }
     }
 
@@ -146,12 +155,13 @@ YAML
 }
 
 for my $recipe ( split /\s+/, $recipes ) {
-    my $recipe_file = ( $recipe =~ m{^[/\.]} && -e $recipe )
+    my $recipe_file
+        = ( $recipe =~ m{^[/\.]} && -e $recipe )
         ? realpath($recipe)
         : do {
-            $recipe =~ s{\.yaml\z}{};
-            $recipe .= '.yaml';
-            "$recipe_dir/$recipe";
+        $recipe =~ s{\.yaml\z}{};
+        $recipe .= '.yaml';
+        "$recipe_dir/$recipe";
         };
 
     # get recipe
@@ -282,8 +292,25 @@ for my $a ( split /\s+/, $archives ) {
     handle_recipe( { $basename => { directory => $directory, }, } );
 }
 
+{
+    my ( $ws_fh, $ws_file ) = tmpnam();
+    print $ws_fh encode_json($workspace);
+    close $ws_fh;
+
+    my ( $fh, $file ) = tmpnam();
+    print $fh Dump({
+        version  => "3",
+        services => {
+            map {
+                $_ => { volumes => ["$ws_file:/src/mt.code-workspace",], },
+            } qw(mt httpd)
+        },
+    });
+    push @$yamls, $file;
+}
+
 if (@$yamls) {
-    $env->{DOCKER_COMPOSE_YML_OVERRIDE} = join( ' ', map {"-f $_"} @$yamls );
+    $env->{DOCKER_COMPOSE_YAML_OVERRIDE} = join( ' ', map {"-f $_"} @$yamls );
 }
 
 # output args for make command

mt/common.yml

@@ -1,35 +1,49 @@
 version: "3"
 services:
   mt:
-    image: ${DOCKER_MT_IMAGE:-movabletype/test:perl-5.28}
+    build:
+      context: ${DOCKER_MT_BUILD_CONTEXT:-mt}
+      dockerfile: ${DOCKER_MT_DOCKERFILE}
+      args:
+        - DOCKER_NODEJS_IMAGE=${DOCKER_NODEJS_IMAGE:-node:16.13.2}
+        - DOCKER_MT_IMAGE=${DOCKER_MT_IMAGE:-movabletype/test:perl-5.28}
     restart: always
     working_dir: /var/www/cgi-bin/mt
     entrypoint: /usr/local/bin/docker-entrypoint.sh
     environment:
       NLS_LANG: ${NLS_LANG:-Japanese_Japan.UTF8}
       MT_DEV_UPDATE_BRANCH: ${UPDATE_BRANCH:-yes}
       DOCKER_MT_SERVICES: ${DOCKER_MT_SERVICES}
+      APACHE_LOG_DIR: ${APACHE_LOG_DIR:-/tmp/apache2/log}
+      APACHE_PID_FILE: ${APACHE_PID_FILE:-/tmp/apache2/run/apache2.pid}
     volumes:
       - "..:/mt-dev"
-      - "${MT_HOME_PATH:-../../movabletype}:/var/www/cgi-bin/mt"
-      - "${MT_CONFIG_CGI_SRC_PATH:-../mt-config.cgi-original}:${MT_CONFIG_CGI_DEST_PATH:-/var/www/cgi-bin/mt/mt-config.cgi}"
-      - "${BASE_SITE_PATH:-site}:/var/www/html"
-      - "support:/var/www/cgi-bin/mt/mt-static/support"
+      - "${MT_HOME_PATH:-../../movabletype}:/var/www/cgi-bin/mt:${DOCKER_VOLUME_MOUNT_FLAG:-rw}"
+      - "${MT_CONFIG_CGI_SRC_PATH:-../mt-config.cgi-original}:${MT_CONFIG_CGI_DEST_PATH:-/var/www/cgi-bin/mt/mt-config.cgi}:${DOCKER_VOLUME_MOUNT_FLAG:-rw}"
+      - "${BASE_SITE_PATH:-site}:/var/www/html:${DOCKER_VOLUME_MOUNT_FLAG:-rw}"
+      - "support:/var/www/cgi-bin/mt/mt-static/support:${DOCKER_VOLUME_MOUNT_FLAG:-rw}"
       # override entrypoint
       - "./docker-entrypoint.sh:/usr/local/bin/docker-entrypoint.sh"
     labels:
       mt-dev.service: "mt"
 
   httpd:
-    image: ${DOCKER_HTTPD_IMAGE:-movabletype/test:php-7.3}
+    build:
+      context: ${DOCKER_HTTPD_BUILD_CONTEXT:-httpd}
+      dockerfile: ${DOCKER_HTTPD_DOCKERFILE}
+      args:
+        - DOCKER_HTTPD_IMAGE=${DOCKER_HTTPD_IMAGE:-movabletype/test:php-8.0}
     restart: always
     entrypoint: "/usr/local/bin/docker-entrypoint.sh"
+    environment:
+      APACHE_LOG_DIR: ${APACHE_LOG_DIR:-/tmp/apache2/log}
+      APACHE_PID_FILE: ${APACHE_PID_FILE:-/tmp/apache2/run/apache2.pid}
     volumes:
       - "..:/mt-dev"
-      - "${MT_HOME_PATH:-../../movabletype}:/var/www/cgi-bin/mt"
-      - "${MT_CONFIG_CGI_SRC_PATH:-../mt-config.cgi-original}:${MT_CONFIG_CGI_DEST_PATH:-/var/www/cgi-bin/mt/mt-config.cgi}"
-      - "${BASE_SITE_PATH:-site}:/var/www/html"
-      - "support:/var/www/cgi-bin/mt/mt-static/support"
+      - "${MT_HOME_PATH:-../../movabletype}:/var/www/cgi-bin/mt:${DOCKER_VOLUME_MOUNT_FLAG:-rw}"
+      - "${MT_CONFIG_CGI_SRC_PATH:-../mt-config.cgi-original}:${MT_CONFIG_CGI_DEST_PATH:-/var/www/cgi-bin/mt/mt-config.cgi}:${DOCKER_VOLUME_MOUNT_FLAG:-rw}"
+      - "${BASE_SITE_PATH:-site}:/var/www/html:${DOCKER_VOLUME_MOUNT_FLAG:-rw}"
+      - "support:/var/www/cgi-bin/mt/mt-static/support:${DOCKER_VOLUME_MOUNT_FLAG:-rw}"
       # override entrypoint
       - "./docker-entrypoint.sh:/usr/local/bin/docker-entrypoint.sh"
       # proxy setting