Dockerize Simulator

.dockerignore

@@ -0,0 +1,3 @@
+target
+.git
+.venv

README-docker-hub-repository-overview.md

@@ -0,0 +1,74 @@
+<!--
+
+The content of this file are submitted as repository overview in Docker Hub:
+https://hub.docker.com/repository/docker/codcod66/opensmpp-sim
+
+-->
+
+Note: the description for this image can be found at https://github.com/codcod/opensmpp/blob/master/README-repository-overview.md.
+
+# Quick reference
+
+-   **Maintained by**:
+
+    https://github.com/codcod/opensmpp
+
+# Supported tags and respective `Dockerfile` links
+
+-	[`0.1.0`, `latest`](https://github.com/codcod/opensmpp/blob/a70c2b567b596f8f5cf6274039b2e957a83ca9fc/sim.Dockerfile)
+
+# What is OpenSMPP?
+
+The OpenSmpp API is an open source Java library implementing the SMPP (Short
+Message Peer to Peer) protocol. It is based on the original Logica OpenSMPP
+API.
+
+At the moment only SMPP version 3.4 is supported.
+
+Support for SMPP used to be provided via the forums at smsforum.net (no longer
+in existence); but since SMS Forum ceased operations at the end of 2007,
+official support is no longer available.
+
+> http://opensmpp.org
+
+![logo](http://opensmpp.org/images/opensmpp.png)
+
+# How to use this image
+
+## start an opensmpp instance
+
+```console
+$ docker run --rm -p 2775:2775 codcod66/opensmpp-sim
+```
+
+The default users and passwords are kept [in this file](https://github.com/codcod/opensmpp/blob/a70c2b567b596f8f5cf6274039b2e957a83ca9fc/sim/users.txt).
+
+## ... or via [`docker compose`](https://github.com/docker/compose)
+
+Example `compose.yml`:
+
+```yaml
+version: "3.8"
+
+services:
+  sim:
+    container_name: opensmpp-sim-1
+    image: codcod66/opensmpp-sim
+    ports:
+      - "2775:2775"
+```
+
+# License
+
+View [license](https://github.com/codcod/opensmpp/blob/a70c2b567b596f8f5cf6274039b2e957a83ca9fc/LICENSE)
+[information](https://github.com/codcod/opensmpp/blob/a70c2b567b596f8f5cf6274039b2e957a83ca9fc/LICENSE_LOGICA)
+for the software contained in this image.
+
+As with all Docker images, these likely also contain other software which may
+be under other licenses (such as Bash, etc from the base distribution, along
+with any direct or indirect dependencies of the primary software being
+contained).
+
+As for any pre-built image usage, it is the image user's responsibility to
+ensure that any use of this image complies with any relevant licenses for all
+software contained within.

README.md

@@ -15,6 +15,17 @@ bug fixes, and has been generally refactored.
  *  client - a simple SMPP client
  *  sim - a simple SMSC simulator
 
+# Simulator
+
+Build and run Simulator with Docker:
+
+    $ docker-compose up -d
+    $ docker logs -f opensmpp-sim-1
+
+Get the image from [Docker Hub](https://hub.docker.com/r/codcod66/opensmpp-sim).
+
+See [client-py](client-py/README.md) for details on how to run the Python client.
+
 # Versions
 
 Versions of this project are managed according to the

client-py/.flake8

@@ -0,0 +1,5 @@
+[flake8]
+max-line-length = 88
+# required for compatibility with Black:
+extend-ignore = E203
+exclude = .*

client-py/.gitignore

@@ -0,0 +1,4 @@
+.venv
+.ruff_cache
+__pycache__
+*.log

client-py/.tool-versions

@@ -0,0 +1 @@
+python 3.11.6

client-py/Makefile

@@ -0,0 +1,19 @@
+.PHONY = venv fix run
+
+APP_DIR=smsc_client
+
+export PYTHONPATH=.
+
+venv:
+	rm -rf ".venv"
+	poetry install
+	@printf "\nDone. You can now activate the virtual environment:\n  source .venv/bin/activate\n"
+
+fix:
+	poetry run black $(APP_DIR)
+	poetry run flake8 $(APP_DIR)
+	poetry run isort $(APP_DIR)
+	poetry run ruff $(APP_DIR)/**
+
+run:
+	poetry run python smsc_client/app2.py

client-py/README.md

@@ -0,0 +1,21 @@
+# Python client for the OpenSMPP Simulator
+
+Basic Python client for OpenSMPP Simulator to test the connection mostly.
+
+Connects to `127.0.0.1` on port 2775 with `smppclient1` as login name and
+`password` as password.
+
+    $ make venv
+    $ make run
+
+Or interactively:
+
+    $ make venv
+    $ poetry shell
+    $ python
+    Python 3.12.0 (main, Oct  2 2023, 12:03:24) [Clang 15.0.0 (clang-1500.0.40.1)] on darwin
+    >>> from smsc_client import app2
+    >>> app2.send(sender='123', recipient='321', message='Hi 1000')
+    >>> ^D ^C
+
+Uses [smpplib](https://github.com/python-smpplib/python-smpplib).