Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/prestashopcorp/prestashop-flashlight

A docker based testing utility for PrestaShop
https://github.com/prestashopcorp/prestashop-flashlight

arm64 docker prestashop testing

Last synced: 3 months ago
JSON representation

A docker based testing utility for PrestaShop

Host: GitHub
URL: https://github.com/prestashopcorp/prestashop-flashlight
Owner: PrestaShopCorp
License: osl-3.0
Archived: true
Created: 2023-02-15T10:23:20.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2023-08-23T07:40:42.000Z (over 1 year ago)
Last Synced: 2024-09-26T11:41:23.622Z (3 months ago)
Topics: arm64, docker, prestashop, testing
Language: Shell
Homepage: https://prestashop.com
Size: 140 KB
Stars: 2
Watchers: 9
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

========

## This repository has been moved to https://github.com/PrestaShop/prestashop-flashlight

========

![PrestaShop Flashlight logo](./assets/prestashop_flashlight_logo.png)

Spin a Prestashop testing instance in seconds!

> **⚠️ Disclaimer**: the following tool is provided in the solely purpose of bootstraping a PrestaShop testing environment.
If you look for a production grade image, please refer to https://github.com/PrestaShop/docker.

> **Note**: no MySQL server is shipped in the resulting image, you have to provide your own instance for the backup to be dumped during the first connection.

Compatible with these architecture:

- linux/amd64 (akka `x86_64`)
- linux/arm64/v8 (akka `arm64`)

The resulting image is based on this tech stack:

- An [Alpine](https://alpine-linux.org) linux image
- An [Nginx](https://nginx.com) server

## How fast is it?

On a Mac M1 (_linux/arm64_) computer:

```
❯ docker compose up -d
[+] Building 0.0s (0/0)
[+] Running 3/3
✔ Container phpmyadmin Running 0.0s
✔ Container mysql Healthy 10.8s
✔ Container prestashop Started 11.1s
```

VS the official production image (_linux/amd64_ only) with `AUTO_INSTALL=1`: 2mn 15s.

## Where do I find pre-built images?

Here: https://hub.docker.com/r/prestashop/flashlight (please wait, will be soon available)

## Build

Simply:

```sh
PS_VERSION=8.1.0 ./build.sh
```

For a custom multiplatform build & push:

```sh
PS_VERSION=8.1.0 \
PLATFORM=linux/amd64,linux/arm64 \
PUSH=true \
DOCKER_IMAGE=my-own-repo/testing:latest \
./build.sh
```

## Use

Start the environment

```sh
cp .env.dist .env
edit .env
docker compose up
```

Add init scripts

```yaml
services:
prestashop:
image: prestashop/flashlight:8.1.0-8.1
volumes:
- ./init-scripts:/tmp/init-scripts:ro
```

## Container environment variables

- **`PS_DOMAIN`**
- Description: the public domain (and port) to reach your PrestaShop instance
- Mandatory if you do not use `NGROK_TUNNEL_AUTO_DETECT`
- Example: `localhost:8000`
- **`NGROK_TUNNEL_AUTO_DETECT`**
- Description: the ngrok agent base API url, to guess the tunnel domain of your shop
- Mandatory if you do not use `PS_DOMAIN`
- Example: `http://ngrok:4040`
- **`SSL_REDIRECT`**
- If set to `true` PrestaShop will be told to redirect all inbound traffic to https://$PS_DOMAIN
- Default to `false` (or automatically guessed if using NGROK_TUNNEL_AUTO_DETECT)
- **`DEBUG_MODE`**
- If set to `true` the Debug mode will be enabled on PrestaShop
- Default to `false`
- **`INSTALL_MODULES_DIR`**
- A module directory containing zips to be installed with the PrestaShop CLI
- Example: `/ps-modules`
- **`INIT_ON_RESTART`**
- If set to `true` the PS_DOMAIN auto search and dump fix will be replayed on container restart
- Default to `false`
- **`DUMP_ON_RESTART`**
- If set to `true` the dump restoration replayed on container restart
- Default to `false`
- **`INSTALL_MODULES_ON_RESTART`**
- If set to `true` zip modules will be reinstalled on container restart
- Default to `false`
- **`INIT_SCRIPTS_ON_RESTART`**
- If set to `true` custom init scripts will be replayed on container restart
- Default to `false`
- **`ON_INIT_SCRIPT_FAILURE`**
- If set to `continue`, PrestaShop Flashlight will continue the boot process even if an init script failed
- Default to `fail`

## Api calls within a docker network

**Disclaimer**: PrestaShop is sensitive to the `Host` header of your client, and can behave surprisingly. In fact, since the Multi-shop feature is available, you cannot just call any front controller from any endpoint, unless... You set the ` Host` or the `id_shop` you are targeting.

Let's explain this subtle - rather mandatory - knowledge:

Assume you have a module installed and working properly, and your PS_DOMAIN configured on `http://localhost:8000`

```sh
> docker compose up -d
> curl -i 'http://localhost:8000/index.php?fc=module&module=mymodule&controller=myctrl'
HTTP/1.1 200 OK
some happy content here ...
```

Is working as expected. But what about the same request performed within the docker container?

```sh
> docker exec -t prestashop curl -i 'http://localhost:8000/index.php?fc=module&module=mymodule&controller=myctrl'
curl: (7) Failed to connect to localhost port 32000 after 5 ms: Couldn't connect to server
```

Indeed this **WON'T WORK**, the container port is 80, only the host know about 8000 in our use case. Let's talk to it:

```sh
> docker exec -t prestashop curl -i 'http://localhost/index.php?fc=module&module=mymodule&controller=myctrl'
HTTP/1.1 302 Found
Server: nginx/1.24.0
Date: Tue, 22 Aug 2023 08:53:22 GMT
Content-Type: text/html; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
X-Powered-By: PHP/8.1.22
Location: http://localhost:8000/
```

Damn! Do you know what's happening? PrestaShop cannot know which shop of its multi-shop configuration you are trying to talk to. Event with one shop, this won't be selected by default and fail with a redirect which cannot be resolved within our network configuration.

If you definitely know the Shop ID you are targeting, you can do this with success:

```sh
curl -i -H 'http://localhost:80/index.php?id_shop=1&fc=module&module=mymodule&controller=myctrl'
HTTP/1.1 200 OK
some happy content here ...
```

but the best way to perform this is to set the target `Host` in a header field:

```sh
curl -i -H 'Host: localhost:8000' 'http://localhost:80/index.php?fc=module&module=mymodule&controller=myctrl'
HTTP/1.1 302 Found
Server: nginx/1.24.0
Date: Tue, 22 Aug 2023 08:53:22 GMT
Content-Type: text/html; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
X-Powered-By: PHP/8.1.22
Location: http://localhost:8000/
```

or even better if you use an Nginx reverse-proxy to forward requests to prestashop within the internal docker network:

```nginx
# so you can call "http://localhost:3000/prestashop/index.php" to reach your PrestaShop id_shop 1 with success
server {
location /prestashop {
resolver 127.0.0.11 ipv6=off valid=10s;
resolver_timeout 10s;
proxy_set_header Host "localhost:8000";
rewrite /prestashop/?(.*) /$1 break;
set $frontend "http://prestashop:80";
proxy_pass $frontend;
}
}
```

## Credits

- https://github.com/PrestaShop/PrestaShop
- https://github.com/PrestaShop/performance-project
- https://github.com/jokesterfr/docker-prestashop