Merge pull request #185 from sticky-note/fix/non-ng-deprecation

fix: warn formula users ng states will be promoted in `v1.0.0`

docs/README.rst

@@ -16,6 +16,31 @@ php-formula
 
 Formula to set up and configure php
 
+.. list-table::
+   :name: banner-breaking-changes-v1.0.0
+   :header-rows: 1
+   :widths: 1
+
+   * - WARNING: BREAKING CHANGES IN UPCOMING ``v1.0.0``
+   * - This formula currently provides two methods for managing PHP; the old method
+       under ``php`` and the new method under ``php.ng``.
+       In upcoming `v1.0.0 <https://github.com/saltstack-formulas/php-formula/releases/tag/v1.0.0>`_,
+       the old method will be removed and ``php.ng`` will be promoted to ``php`` in its place.
+
+       If you are not in a position to migrate, you will need to pin your repo to
+       the final release tag before
+       `v1.0.0 <https://github.com/saltstack-formulas/php-formula/releases/tag/v1.0.0>`_,
+       which is expected to be
+       `v0.37.1 <https://github.com/saltstack-formulas/php-formula/releases/tag/v0.37.1>`_.
+
+       If you are currently using ``php.ng``, there is nothing to do until
+       `v1.0.0 <https://github.com/saltstack-formulas/php-formula/releases/tag/v1.0.0>`_
+       is released.
+
+       To migrate from the old ``php``, the first step is to convert to ``php.ng``,
+       before `v1.0.0 <https://github.com/saltstack-formulas/php-formula/releases/tag/v1.0.0>`_
+       is released.
+
 .. contents:: **Table of Contents**
 
 General notes

php/adodb.sls

@@ -1,6 +1,7 @@
 {%- from "php/map.jinja" import php with context %}
 
 include:
+  - php.deprecated
   - php
 
 php-adodb:

php/apc.sls

@@ -1,6 +1,7 @@
 {%- from "php/map.jinja" import php with context %}
 
 include:
+  - php.deprecated
   - php
 
 php-apc:

php/apcu.sls

@@ -1,6 +1,7 @@
 {%- from "php/map.jinja" import php with context %}
 
 include:
+  - php.deprecated
   - php
 
 php-apcu:

php/bcmath.sls

@@ -1,6 +1,7 @@
 {%- from "php/map.jinja" import php with context %}
 
 include:
+  - php.deprecated
   - php
 
 php-bcmath:

php/cgi.sls

@@ -1,6 +1,7 @@
 {%- from "php/map.jinja" import php with context %}
 
 include:
+  - php.deprecated
   - php
 
 php-cgi:

php/cli.sls

@@ -1,6 +1,7 @@
 {%- from "php/map.jinja" import php with context %}
 
 include:
+  - php.deprecated
   - php
 
 php-cli:

php/composer.sls

@@ -11,6 +11,7 @@
 {%- set salt_user_home = salt['user.info'](salt_user).get('home', '/root') %}
 
 include:
+  - php.deprecated
   - php
 
 get-composer:

php/curl.sls

@@ -1,6 +1,7 @@
 {%- from "php/map.jinja" import php with context %}
 
 include:
+  - php.deprecated
   - php
 
 php-curl:

php/deprecated.sls

@@ -0,0 +1,41 @@
+# -*- coding: utf-8 -*-
+# vim: ft=sls
+
+{#- Evaluating as `False` by default, using this method since `defaults.yaml` not available in this repo #}
+{%- if not salt['config.get']('php').get('warning_messages', {}).get('v1.0.0', {}).get('mute_critical', False) %}
+php-deprecated-in-v1.0.0-test-succeed:
+  test.succeed_without_changes:
+    - name: |
+
+
+        ################################################################################
+        #                                                                              #
+        #            WARNING: BREAKING CHANGES IN UPCOMING VERSION `v1.0.0`            #
+        #                                                                              #
+        ################################################################################
+        #                                                                              #
+        # This formula currently provides two methods for managing PHP; the old method #
+        # under `php` and the new method under `php.ng`. In upcoming `v1.0.0`, the old #
+        # method will be removed and `php.ng` will be promoted to `php` in its place.  #
+        #                                                                              #
+        # If you are not in a position to migrate, you will need to pin your repo to   #
+        # the final release tag before `v1.0.0`, which is expected to be `v0.37.1`.    #
+        #                                                                              #
+        # If you are currently using `php.ng`, there is nothing to do until `v1.0.0`   #
+        # is released.                                                                 #
+        #                                                                              #
+        # To migrate from the old `php`, the first step is to convert to `php.ng`,     #
+        # before `v1.0.0` is released.                                                 #
+        #                                                                              #
+        # To prevent this message being displayed again, set the pillar/config value:  #
+        #                                                                              #
+        # ```                                                                          #
+        # php:                                                                         #
+        #   warning_messages:                                                          #
+        #     v1.0.0:                                                                  #
+        #       mute_critical: True                                                    #
+        # ```                                                                          #
+        #                                                                              #
+        ################################################################################
+    # - failhard: True
+{%- endif %}

php/dev.sls

@@ -1,6 +1,7 @@
 {%- from "php/map.jinja" import php with context %}
 
 include:
+  - php.deprecated
   - php
 
 php-dev:

php/fpm.sls

@@ -1,5 +1,8 @@
 {%- from "php/map.jinja" import php with context %}
 
+include:
+  - php.deprecated
+
 php-fpm:
   pkg.installed:
     - name: {{ php.fpm_pkg }}

php/gd.sls

@@ -1,6 +1,7 @@
 {%- from "php/map.jinja" import php with context %}
 
 include:
+  - php.deprecated
   - php
 
 php-gd:

php/imagick.sls

@@ -1,6 +1,7 @@
 {%- from "php/map.jinja" import php with context %}
 
 include:
+  - php.deprecated
   - php
 
 php-imagick:

php/imap.sls

@@ -1,6 +1,7 @@
 {%- from "php/map.jinja" import php with context %}
 
 include:
+  - php.deprecated
   - php
 
 php-imap:

php/init.sls

@@ -1,5 +1,8 @@
 {%- from "php/map.jinja" import php with context %}
 
+include:
+  - php.deprecated
+
 {%- if not 'ng' in salt['pillar.get']('php', {}) %}
 
   {%- if grains['os'] == "Ubuntu" %}

php/intl.sls

@@ -1,6 +1,7 @@
 {%- from "php/map.jinja" import php with context %}
 
 include:
+  - php.deprecated
   - php
 
 php-intl:

php/json.sls

@@ -1,6 +1,7 @@
 {%- from "php/map.jinja" import php with context %}
 
 include:
+  - php.deprecated
   - php
 
 php-json:

php/ldap.sls

@@ -1,6 +1,7 @@
 {%- from "php/map.jinja" import php with context %}
 
 include:
+  - php.deprecated
   - php
 
 php-ldap:

php/mail.sls

@@ -1,6 +1,7 @@
 {%- from "php/map.jinja" import php with context %}
 
 include:
+  - php.deprecated
   - php
 
 php-mail:

php/mbstring.sls

@@ -1,6 +1,7 @@
 {%- from "php/map.jinja" import php with context %}
 
 include:
+  - php.deprecated
   - php
 
 php-mbstring:

php/mcrypt.sls

@@ -1,6 +1,7 @@
 {%- from "php/map.jinja" import php with context %}
 
 include:
+  - php.deprecated
   - php
 
 php-mcrypt:

php/memcache.sls

@@ -1,6 +1,7 @@
 {%- from "php/map.jinja" import php with context %}
 
 include:
+  - php.deprecated
   - php
 
 php-memcache:

php/memcached.sls

@@ -1,6 +1,7 @@
 {%- from "php/map.jinja" import php with context %}
 
 include:
+  - php.deprecated
   - php
 
 php-memcached:

php/mongo.sls

@@ -3,6 +3,7 @@
 {%- set version = salt['pillar.get']('php:mongo_version', none) %}
 
 include:
+  - php.deprecated
   - php
   - php.xml
   - php.dev

php/mysql.sls

@@ -1,6 +1,7 @@
 {%- from "php/map.jinja" import php with context %}
 
 include:
+  - php.deprecated
   - php
 
 php-mysql:

php/mysqlnd.sls

@@ -1,6 +1,7 @@
 {%- from "php/map.jinja" import php with context %}
 
 include:
+  - php.deprecated
   - php
 
 php-mysqlnd:

php/ng/apache2/ini.sls

@@ -5,5 +5,8 @@
 {% set settings = php.ini.defaults %}
 {% do settings.update(php.apache2.ini.settings) %}
 
+include:
+  - php.ng.deprecated
+
 php_apache2_ini:
   {{ php_ini(php.lookup.apache2.ini, php.apache2.ini.opts, settings) }}

php/ng/apache2/init.sls

@@ -1,5 +1,6 @@
 {% if grains['os_family'] in ["Debian", "FreeBSD"] %}
 include:
+  - php.ng.deprecated
   - php.ng.apache2.install
 {% endif %} #END: os = Debian|FreeBSD
 {% if grains['os_family'] == "Debian" %}

php/ng/apache2/install.sls

@@ -1,5 +1,8 @@
 {% from "php/ng/map.jinja" import php with context %}
 
+include:
+  - php.ng.deprecated
+
 {% set state = 'apache2' %}
 {% include "php/ng/installed.jinja" %}
 

php/ng/cli/ini.sls

@@ -2,6 +2,9 @@
 {% from "php/ng/map.jinja" import php with context %}
 {% from "php/ng/ini.jinja" import php_ini %}
 
+include:
+  - php.ng.deprecated
+
 {% set settings = php.ini.defaults %}
 {% for key, value in php.cli.ini.settings.items() %}
   {% if settings[key] is defined %}

php/ng/cli/init.sls

@@ -1,6 +1,7 @@
 # Installs php-cli and manages the associated php.ini
 
 include:
+  - php.ng.deprecated
   - php.ng.cli.install
   - php.ng.cli.ini
 

php/ng/cli/install.sls

@@ -1,6 +1,9 @@
 {% set state = 'cli' %}
 {% include "php/ng/installed.jinja" %}
 
+include:
+  - php.ng.deprecated
+
 {%- if salt['grains.get']('os_family') == "Debian" %}
 {% set current_php = salt['alternatives.show_current']('php') %}
 {% set phpng_version = salt['pillar.get']('php:ng:version', '7.0')|string %}

php/ng/composer.sls

@@ -11,6 +11,7 @@
 {% set salt_user_home = salt['user.info'](salt_user).get('home', '/root') %}
 
 include:
+  - php.ng.deprecated
   - php.ng
 {% if grains['os_family'] == 'FreeBSD' %}
   - php.ng.filter

php/ng/deprecated.sls

@@ -0,0 +1,40 @@
+# -*- coding: utf-8 -*-
+# vim: ft=sls
+
+{#- Evaluating as `False` by default, using this method since `defaults.yaml` not available in this repo #}
+{%- if not salt['config.get']('php').get('warning_messages', {}).get('v1.0.0', {}).get('mute_upcoming', False) %}
+php-deprecated-in-v1.0.0-test-succeed:
+  test.succeed_without_changes:
+    - name: |
+
+
+        ################################################################################
+        #                                                                              #
+        #            WARNING: BREAKING CHANGES IN UPCOMING VERSION `v1.0.0`            #
+        #                                                                              #
+        ################################################################################
+        #                                                                              #
+        # This formula currently provides two methods for managing PHP; the old method #
+        # under `php` and the new method under `php.ng`. In upcoming `v1.0.0`, the old #
+        # method will be removed and `php.ng` will be promoted to `php` in its place.  #
+        #                                                                              #
+        # If you are not in a position to migrate, you will need to pin your repo to   #
+        # the final release tag before `v1.0.0`, which is expected to be `v0.37.1`.    #
+        #                                                                              #
+        # If you are currently using `php.ng`, there is nothing to do until `v1.0.0`   #
+        # is released.                                                                 #
+        #                                                                              #
+        # To migrate from the old `php`, the first step is to convert to `php.ng`,     #
+        # before `v1.0.0` is released.                                                 #
+        #                                                                              #
+        # To prevent this message being displayed again, set the pillar/config value:  #
+        #                                                                              #
+        # ```                                                                          #
+        # php:                                                                         #
+        #   warning_messages:                                                          #
+        #     v1.0.0:                                                                  #
+        #       mute_upcoming: True                                                    #
+        # ```                                                                          #
+        #                                                                              #
+        ################################################################################
+{%- endif %}

php/ng/fpm/config.sls

@@ -2,6 +2,9 @@
 {% from 'php/ng/map.jinja' import php with context %}
 {% from "php/ng/ini.jinja" import php_ini %}
 
+include:
+  - php.ng.deprecated
+
 {% set ini_settings = php.ini.defaults %}
 {% for key, value in php.fpm.config.ini.settings.items() %}
   {% if ini_settings[key] is defined %}

php/ng/fpm/init.sls

@@ -1,6 +1,7 @@
 # Meta-state to fully install php.fpm
 
 include:
+  - php.ng.deprecated
   - php.ng.fpm.config
   - php.ng.fpm.service
   - php.ng.fpm.pools

php/ng/fpm/install.sls

@@ -1,2 +1,5 @@
+include:
+  - php.ng.deprecated
+
 {% set state = 'fpm' %}
 {% include "php/ng/installed.jinja" %}

php/ng/fpm/pools.sls

@@ -10,6 +10,7 @@
 {% endmacro %}
 
 include:
+  - php.ng.deprecated
   - php.ng.fpm.service
   - php.ng.fpm.pools_config
 

php/ng/fpm/pools_config.sls

@@ -2,6 +2,9 @@
 {% from 'php/ng/map.jinja' import php with context %}
 {% from "php/ng/macro.jinja" import sls_block, serialize %}
 
+include:
+  - php.ng.deprecated
+
 # Simple path concatenation.
 {% macro path_join(file, root) -%}
   {{ root ~ '/' ~ file }}

php/ng/fpm/service.sls

@@ -5,6 +5,7 @@
 {% set service_function = {True:'running', False:'dead'}.get(php.fpm.service.enabled) %}
 
 include:
+  - php.ng.deprecated
   - php.ng.fpm.install
 
 php_fpm_service:

php/ng/hhvm/config.sls

@@ -2,6 +2,9 @@
 {% from "php/ng/map.jinja" import php with context %}
 {% from "php/ng/ini.jinja" import php_ini %}
 
+include:
+  - php.ng.deprecated
+
 {% set server_settings = php.lookup.hhvm.server %}
 {% do server_settings.update(php.hhvm.config.server.settings) %}
 

php/ng/hhvm/init.sls

@@ -1,6 +1,7 @@
 # Meta-state to fully install php.hhvm
 
 include:
+  - php.ng.deprecated
   - php.ng.hhvm.repo
   - php.ng.hhvm.config
   - php.ng.hhvm.service

php/ng/hhvm/install.sls

@@ -1,2 +1,5 @@
+include:
+  - php.ng.deprecated
+
 {% set state = 'hhvm' %}
 {% include "php/ng/installed.jinja" %}

php/ng/hhvm/repo.sls

@@ -2,6 +2,7 @@
 {% from "php/ng/map.jinja" import php with context %}
 
 include:
+  - php.ng.deprecated
   - php.ng.hhvm.install
 
 

php/ng/hhvm/service.sls

@@ -5,6 +5,7 @@
 {% set service_function = {True:'running', False:'dead'}.get(php.hhvm.service.enabled) %}
 
 include:
+  - php.ng.deprecated
   - php.ng.hhvm.install
 
 php_hhvm_service:
@@ -15,5 +16,5 @@ php_hhvm_service:
   - require:
     - sls: php.ng.hhvm.install
   - watch:
-    - pkg: php_install_hhvm 
+    - pkg: php_install_hhvm
 

php/ng/installed.jinja

@@ -4,6 +4,8 @@
 {% from "php/ng/map.jinja" import php with context %}
 {% from "php/ng/macro.jinja" import sls_block %}
 
+include:
+  - php.ng.deprecated
 
 {% set pkginfo = php.lookup.pkgs.get(state) %}
 
@@ -60,7 +62,7 @@ php_ppa_{{ state }}:
     - __env__:
       - LC_ALL: C.UTF-8
     - onlyif:
-      - test ! -e /etc/apt/sources.list.d/ondrej-php.list 
+      - test ! -e /etc/apt/sources.list.d/ondrej-php.list
     - require_in:
       - pkg: php_install_{{ state }}
   pkg.latest:

php/ng/mdb2/init.sls

@@ -1,2 +1,5 @@
+include:
+  - php.ng.deprecated
+
 {% set state = 'mdb2' %}
 {% include "php/ng/installed.jinja" %}

php/ng/mdb2/mysql.sls

@@ -1,3 +1,6 @@
+include:
+  - php.ng.deprecated
+
 {% set state = 'mdb2-driver-mysql' %}
 {% include "php/ng/installed.jinja" %}
 {% include "php/ng/mdb2/init.sls" %}

php/ng/mdb2/pgsql.sls

@@ -1,3 +1,6 @@
+include:
+  - php.ng.deprecated
+
 {% set state = 'mdb2-driver-pgsql' %}
 {% include "php/ng/installed.jinja" %}
 {% include "php/ng/mdb2/init.sls" %}

php/ng/suhosin.sls

@@ -1,6 +1,7 @@
 {% from "php/ng/map.jinja" import php with context %}
 
 include:
+  - php.ng.deprecated
   - php.ng
   - php.ng.dev
 

php/ng/xcache/ini.sls

@@ -2,6 +2,9 @@
 {% from "php/ng/map.jinja" import php with context %}
 {% from "php/ng/ini.jinja" import php_ini %}
 
+include:
+  - php.ng.deprecated
+
 {% set settings = php.xcache.ini.defaults %}
 {% for key, value in php.xcache.ini.settings.items() %}
   {% if settings[key] is defined %}

php/ng/xcache/init.sls

@@ -1,6 +1,7 @@
 # Installs php-xcache and manages the associated xcache.ini
 
 include:
+  - php.ng.deprecated
   - php.ng.xcache.install
   - php.ng.xcache.ini
 

php/ng/xcache/install.sls

@@ -1,2 +1,5 @@
+include:
+  - php.ng.deprecated
+
 {% set state = 'xcache' %}
 {% include "php/ng/installed.jinja" %}

php/oauth.sls

@@ -1,6 +1,7 @@
 {%- from "php/map.jinja" import php with context %}
 
 include:
+  - php.deprecated
   - php
 
 php-oauth:

php/pear.sls

@@ -1,6 +1,7 @@
 {%- from "php/map.jinja" import php with context %}
 
 include:
+  - php.deprecated
   - php
 
 php-pear:

php/pgsql.sls

@@ -1,6 +1,7 @@
 {%- from "php/map.jinja" import php with context %}
 
 include:
+  - php.deprecated
   - php
 
 php-pgsql:

php/readline.sls

@@ -1,6 +1,7 @@
 {%- from "php/map.jinja" import php with context %}
 
 include:
+  - php.deprecated
   - php
 
 php-readline:

php/redis.sls

@@ -1,6 +1,7 @@
 {%- from "php/map.jinja" import php with context %}
 
 include:
+  - php.deprecated
   - php
 
 php-redis:

php/soap.sls

@@ -1,6 +1,7 @@
 {%- from "php/map.jinja" import php with context %}
 
 include:
+  - php.deprecated
   - php
 
 php-soap:

php/sqlite.sls

@@ -1,6 +1,7 @@
 {%- from "php/map.jinja" import php with context %}
 
 include:
+  - php.deprecated
   - php
 
 php-sqlite:

php/suhosin.sls

@@ -1,6 +1,7 @@
 {%- from "php/map.jinja" import php with context %}
 
 include:
+  - php.deprecated
   - php
   - php.dev
 

php/sybase.sls

@@ -1,6 +1,7 @@
 {%- from "php/map.jinja" import php with context %}
 
 include:
+  - php.deprecated
   - php
 
 php-sybase:

php/xml.sls

@@ -1,6 +1,7 @@
 {%- from "php/map.jinja" import php with context %}
 
 include:
+  - php.deprecated
   - php
 
 php-xml:

php/zip.sls

@@ -1,6 +1,7 @@
 {%- from "php/map.jinja" import php with context %}
 
 include:
+  - php.deprecated
   - php
 
 php-zip:

pillar.example

@@ -1,6 +1,11 @@
 ## php.ng pillar examples
 
 php:
+  # Use the following values to mute deprecation warnings
+  warning_messages:                                                          #
+    v1.0.0:                                                                  #
+      mute_critical: True                                                    #
+      mute_upcoming: True                                                    #
   # Use external repository instead the default (only Ubuntu family)
   use_external_repo: True
   # Set the external repository name (valid only if use_external_repo is not none)

test/salt/pillar/debian.sls

@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+# vim: ft=yaml
+---
+php: {}

test/salt/pillar/redhat.sls

@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+# vim: ft=yaml
+---
+php: {}

test/salt/pillar/suse.sls

@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+# vim: ft=yaml
+---
+php: {}