diff --git a/README.md b/README.md index 13f785b..df72e76 100644 --- a/README.md +++ b/README.md @@ -1,383 +1,397 @@ # Systemd [![Build Status](https://github.com/voxpupuli/puppet-systemd/workflows/CI/badge.svg)](https://github.com/voxpupuli/puppet-systemd/actions?query=workflow%3ACI) [![Release](https://github.com/voxpupuli/puppet-systemd/actions/workflows/release.yml/badge.svg)](https://github.com/voxpupuli/puppet-systemd/actions/workflows/release.yml) [![Puppet Forge](https://img.shields.io/puppetforge/v/puppet/systemd.svg)](https://forge.puppetlabs.com/puppet/systemd) [![Puppet Forge - downloads](https://img.shields.io/puppetforge/dt/puppet/systemd.svg)](https://forge.puppetlabs.com/puppet/systemd) [![Puppet Forge - endorsement](https://img.shields.io/puppetforge/e/puppet/systemd.svg)](https://forge.puppetlabs.com/puppet/systemd) [![Puppet Forge - scores](https://img.shields.io/puppetforge/f/puppet/systemd.svg)](https://forge.puppetlabs.com/puppet/systemd) [![puppetmodule.info docs](http://www.puppetmodule.info/images/badge.png)](http://www.puppetmodule.info/m/puppet-systemd) [![Apache-2 License](https://img.shields.io/github/license/voxpupuli/puppet-systemd.svg)](LICENSE) [![Donated by Camptocamp](https://img.shields.io/badge/donated%20by-camptocamp-fb7047.svg)](#transfer-notice) ## Overview This module declares exec resources to create global sync points for reloading systemd. **Version 2 and newer of the module don't work with Hiera 3! You need to migrate your existing Hiera setup to Hiera 5** ## Usage and examples There are two ways to use this module. ### unit files Let this module handle file creation. ```puppet systemd::unit_file { 'foo.service': source => "puppet:///modules/${module_name}/foo.service", } ~> service {'foo': ensure => 'running', } ``` This is equivalent to: ```puppet file { '/usr/lib/systemd/system/foo.service': ensure => file, owner => 'root', group => 'root', mode => '0644', source => "puppet:///modules/${module_name}/foo.service", } ~> service {'foo': ensure => 'running', } ``` You can also use this module to more fully manage the new unit. This example deploys the unit, reloads systemd and then enables and starts it. ```puppet systemd::unit_file { 'foo.service': source => "puppet:///modules/${module_name}/foo.service", enable => true, active => true, } ``` ### drop-in files Drop-in files are used to add or alter settings of a unit without modifying the unit itself. As for the unit files, the module can handle the file and directory creation: ```puppet systemd::dropin_file { 'foo.conf': unit => 'foo.service', source => "puppet:///modules/${module_name}/foo.conf", } ~> service {'foo': ensure => 'running', } ``` This is equivalent to: ```puppet file { '/etc/systemd/system/foo.service.d': ensure => directory, owner => 'root', group => 'root', } file { '/etc/systemd/system/foo.service.d/foo.conf': ensure => file, owner => 'root', group => 'root', mode => '0644', source => "puppet:///modules/${module_name}/foo.conf", } ~> service {'foo': ensure => 'running', } ``` dropin-files can also be generated via hiera: ```yaml systemd::dropin_files: my-foo.conf: unit: foo.service source: puppet:///modules/${module_name}/foo.conf ``` ### tmpfiles Let this module handle file creation and systemd reloading ```puppet systemd::tmpfile { 'foo.conf': source => "puppet:///modules/${module_name}/foo.conf", } ``` Or handle file creation yourself and trigger systemd. ```puppet include systemd::tmpfiles file { '/etc/tmpfiles.d/foo.conf': ensure => file, owner => 'root', group => 'root', mode => '0644', source => "puppet:///modules/${module_name}/foo.conf", } ~> Class['systemd::tmpfiles'] ``` ### timer units Create a systemd timer unit and a systemd service unit to execute from that timer The following will create a timer unit and a service unit file. When `active` and `enable` are set to `true` the puppet service `runoften.timer` will be declared, started and enabled. ```puppet systemd::timer{'runoften.timer': timer_source => "puppet:///modules/${module_name}/runoften.timer", service_source => "puppet:///modules/${module_name}/runoften.service", active => true, enable => true, } ``` A trivial daily run. In this case enable and active are both unset and so the service `daily.timer` is not declared by the `systemd::timer` type. ```puppet $_timer = @(EOT) [Timer] OnCalendar=daily RandomizedDelaySec=1d EOT $_service = @(EOT) [Service] Type=oneshot ExecStart=/usr/bin/touch /tmp/file EOT systemd::timer{'daily.timer': timer_content => $_timer, service_content => $_service, } service{'daily.timer': ensure => running, subscribe => Systemd::Timer['daily.timer'], } ``` If neither `service_content` or `service_source` are specified then no service unit will be created. The service unit name can also be specified. ```puppet $_timer = @(EOT) [Timer] OnCalendar=daily RandomizedDelaySec=1d Unit=touch-me-today.service EOT $_service = @(EOT) [Service] Type=oneshot ExecStart=/usr/bin/touch /tmp/file EOT systemd::timer{'daily.timer': timer_content => $_timer, service_unit => 'touch-me-today.service', service_content => $_service, active => true, enable => true, } ``` ### service limits Manage soft and hard limits on various resources for executed processes. ```puppet systemd::service_limits { 'foo.service': limits => { 'LimitNOFILE' => 8192, 'LimitNPROC' => 16384, } } ``` Or provide the configuration file yourself. Systemd reloading and restarting of the service are handled by the module. ```puppet systemd::service_limits { 'foo.service': source => "puppet:///modules/${module_name}/foo.conf", } ``` ### Daemon reloads Systemd caches unit files and their relations. This means it needs to reload, typically done via `systemctl daemon-reload`. Since Puppet 6.1.0 ([PUP-3483](https://tickets.puppetlabs.com/browse/PUP-3483)) takes care of this by calling `systemctl show $SERVICE -- --property=NeedDaemonReload` to determine if a reload is needed. Typically this works well and removes the need for `systemd::systemctl::daemon_reload` as provided prior to camptocamp/systemd 3.0.0. This avoids common circular dependencies. It does contain a workaround for [PUP-9473](https://tickets.puppetlabs.com/browse/PUP-9473) but there's no guarantee that this works in every case. ### network systemd-networkd is able to manage your network configuration. We provide a defined resource which can write the interface configurations. systemd-networkd needs to be restarted to apply the configs. The defined resource can do this for you: ```puppet systemd::network{'eth0.network': source => "puppet:///modules/${module_name}/eth0.network", restart_service => true, } ``` ### Services Systemd provides multiple services. Currently you can manage `systemd-resolved`, `systemd-timesyncd`, `systemd-networkd`, `systemd-journald` and `systemd-logind` via the main class: ```puppet class{'systemd': manage_resolved => true, manage_networkd => true, manage_timesyncd => true, manage_journald => true, manage_udevd => true, manage_logind => true, } ``` $manage_networkd is required if you want to reload it for new `systemd::network` resources. Setting $manage_resolved will also manage your `/etc/resolv.conf`. When configuring `systemd::resolved` you could set `dns_stub_resolver` to false (default) to use a *standard* `/etc/resolved.conf`, or you could set it to `true` to use the local resolver provided by `systemd-resolved`. Systemd has introduced `DNS Over TLS` in the release 239. Currently three states are supported `yes` (since systemd 243), `opportunistic` (true) and `no` (false, default). When enabled with `yes` or `opportunistic` `systemd-resolved` will start a TCP-session to a DNS server with `DNS Over TLS` support. When enabled with `yes` (strict mode), queries will fail if the configured DNS servers do not support `DNS Over TLS`. Note that there will be no host checking for `DNS Over TLS` due to missing implementation in `systemd-resolved`. It is possible to configure the default ntp servers in `/etc/systemd/timesyncd.conf`: ```puppet class{'systemd': manage_timesyncd => true, ntp_server => ['0.pool.ntp.org', '1.pool.ntp.org'], fallback_ntp_server => ['2.pool.ntp.org', '3.pool.ntp.org'], } ``` This requires [puppetlabs-inifile](https://forge.puppet.com/puppetlabs/inifile), which is only a soft dependency in this module (you need to explicitly install it). Both parameters accept a string or an array. ### Resource Accounting Systemd has support for different accounting option. It can track CPU/Memory/Network stats per process. This is explained in depth at [systemd-system.conf](https://www.freedesktop.org/software/systemd/man/systemd-system.conf.html). This defaults to off (default on most operating systems). You can enable this with the `$manage_accounting` parameter. The module provides a default set of working accounting options per operating system, but you can still modify them with `$accounting`: ```puppet class{'systemd': manage_accounting => true, accounting => { 'DefaultCPUAccounting' => 'yes', 'DefaultMemoryAccounting' => 'no', } } ``` ### journald configuration It also allows you to manage journald settings. You can manage journald settings through setting the `journald_settings` parameter. If you want a parameter to be removed, you can pass its value as params. ```yaml systemd::journald_settings: Storage: auto MaxRetentionSec: 5day MaxLevelStore: ensure: absent ``` ### udevd configuration It allows you to manage the udevd configuration. You can set the udev.conf values via the `udev_log`, `udev_children_max`, `udev_exec_delay`, `udev_event_timeout`, `udev_resolve_names`, and `udev_timeout_signal` parameters. Additionally you can set custom udev rules with the `udev_rules` parameter. ```puppet class { 'systemd': manage_udevd => true, udev_rules => { 'example_raw.rules' => { 'rules' => [ 'ACTION=="add", KERNEL=="sda", RUN+="/bin/raw /dev/raw/raw1 %N"', 'ACTION=="add", KERNEL=="sdb", RUN+="/bin/raw /dev/raw/raw2 %N"', ], }, }, } ``` ### udev::rules configuration Custom udev rules can be defined for specific events. ```yaml systemd::udev::rule: ensure: present path: /etc/udev/rules.d selinux_ignore_defaults: false notify: "Service[systemd-udevd']" rules: - 'ACTION=="add", KERNEL=="sda", RUN+="/bin/raw /dev/raw/raw1 %N"' - 'ACTION=="add", KERNEL=="sdb", RUN+="/bin/raw /dev/raw/raw2 %N"', ``` ### logind configuration It also allows you to manage logind settings. You can manage logind settings through setting the `logind_settings` parameter. If you want a parameter to be removed, you can pass its value as params. ```yaml systemd::logind_settings: HandleSuspendKey: 'ignore' KillUserProcesses: 'no' RemoveIPC: ensure: absent UserTasksMax: 10000 ``` ### User linger A `loginctl_user` resource is available to manage user linger enablement: ```puppet loginctl_user { 'foo': linger => enabled, } ``` or as a hash via the `systemd::loginctl_users` parameter. +### Systemd Escape Function +Escapes strings as `systemd-escape` command does. + +```puppet +$result = systemd::escape('foo::bar/') +``` +`$result` would be `foo::bar-` + +or path escape as if with `-p` option. + +```puppet +$result = systemd::escape('/mnt/foobar/', true) +``` +`$result` would be `mnt-foobar`. ## Transfer Notice This plugin was originally authored by [Camptocamp](http://www.camptocamp.com). The maintainer preferred that Puppet Community take ownership of the module for future improvement and maintenance. Existing pull requests and issues were transferred over, please fork and continue to contribute here instead of Camptocamp. Previously: https://github.com/camptocamp/puppet-systemd diff --git a/REFERENCE.md b/REFERENCE.md index 56ba759..20362cb 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -1,1283 +1,1341 @@ # Reference ## Table of Contents ### Classes #### Public Classes * [`systemd`](#systemd): This module allows triggering systemd commands once for all modules * [`systemd::tmpfiles`](#systemdtmpfiles): Update the systemd temp files #### Private Classes * `systemd::journald`: This class manages and configures journald. * `systemd::logind`: This class manages systemd's login manager configuration. * `systemd::networkd`: This class provides an abstract way to trigger systemd-networkd * `systemd::resolved`: This class provides an abstract way to trigger resolved. * `systemd::system`: This class provides a solution to enable accounting * `systemd::timesyncd`: This class provides an abstract way to trigger systemd-timesyncd * `systemd::udevd`: This class manages systemd's udev config ### Defined types * [`systemd::dropin_file`](#systemddropin_file): Creates a drop-in file for a systemd unit * [`systemd::network`](#systemdnetwork): Creates network config for systemd-networkd * [`systemd::service_limits`](#systemdservice_limits): Adds a set of custom limits to the service * [`systemd::timer`](#systemdtimer): Create a timer and optionally a service unit to execute with the timer unit * [`systemd::tmpfile`](#systemdtmpfile): Creates a systemd tmpfile * [`systemd::udev::rule`](#systemdudevrule): Adds a custom udev rule * [`systemd::unit_file`](#systemdunit_file): Creates a systemd unit file ### Resource types * [`loginctl_user`](#loginctl_user): An arbitrary name used as the identity of the resource. +### Functions + +* [`systemd::escape`](#systemdescape): Escape strings as systemd-escape does. + ### Data types * [`Systemd::Dropin`](#systemddropin): custom datatype that validates filenames/paths for valid systemd dropin files * [`Systemd::JournaldSettings`](#systemdjournaldsettings): Matches Systemd journald config Struct * [`Systemd::JournaldSettings::Ensure`](#systemdjournaldsettingsensure): defines allowed ensure states for systemd-journald settings * [`Systemd::LogindSettings`](#systemdlogindsettings): Matches Systemd Login Manager Struct * [`Systemd::LogindSettings::Ensure`](#systemdlogindsettingsensure): defines allowed ensure states for systemd-logind settings * [`Systemd::ServiceLimits`](#systemdservicelimits): Matches Systemd Service Limit Struct * [`Systemd::Unit`](#systemdunit): custom datatype that validates different filenames for systemd units ## Classes ### `systemd` This module allows triggering systemd commands once for all modules #### Parameters The following parameters are available in the `systemd` class: * [`service_limits`](#service_limits) * [`manage_resolved`](#manage_resolved) * [`resolved_ensure`](#resolved_ensure) * [`dns`](#dns) * [`fallback_dns`](#fallback_dns) * [`domains`](#domains) * [`llmnr`](#llmnr) * [`multicast_dns`](#multicast_dns) * [`dnssec`](#dnssec) * [`dnsovertls`](#dnsovertls) * [`cache`](#cache) * [`dns_stub_listener`](#dns_stub_listener) * [`use_stub_resolver`](#use_stub_resolver) * [`manage_networkd`](#manage_networkd) * [`networkd_ensure`](#networkd_ensure) * [`manage_timesyncd`](#manage_timesyncd) * [`timesyncd_ensure`](#timesyncd_ensure) * [`ntp_server`](#ntp_server) * [`fallback_ntp_server`](#fallback_ntp_server) * [`manage_journald`](#manage_journald) * [`journald_settings`](#journald_settings) * [`manage_udevd`](#manage_udevd) * [`udev_log`](#udev_log) * [`udev_children_max`](#udev_children_max) * [`udev_exec_delay`](#udev_exec_delay) * [`udev_event_timeout`](#udev_event_timeout) * [`udev_resolve_names`](#udev_resolve_names) * [`udev_timeout_signal`](#udev_timeout_signal) * [`udev_rules`](#udev_rules) * [`manage_logind`](#manage_logind) * [`logind_settings`](#logind_settings) * [`loginctl_users`](#loginctl_users) * [`dropin_files`](#dropin_files) * [`manage_all_network_files`](#manage_all_network_files) * [`network_path`](#network_path) * [`manage_accounting`](#manage_accounting) * [`accounting`](#accounting) * [`purge_dropin_dirs`](#purge_dropin_dirs) ##### `service_limits` Data type: `Hash[String,Hash[String, Any]]` May be passed a resource hash suitable for passing directly into the ``create_resources()`` function as called on ``systemd::service_limits`` ##### `manage_resolved` Data type: `Boolean` Manage the systemd resolver ##### `resolved_ensure` Data type: `Enum['stopped','running']` The state that the ``resolved`` service should be in ##### `dns` Data type: `Optional[Variant[Array[String],String]]` A space-separated list of IPv4 and IPv6 addresses to use as system DNS servers. DNS requests are sent to one of the listed DNS servers in parallel to suitable per-link DNS servers acquired from systemd-networkd.service(8) or set at runtime by external applications. requires puppetlabs-inifile ##### `fallback_dns` Data type: `Optional[Variant[Array[String],String]]` A space-separated list of IPv4 and IPv6 addresses to use as the fallback DNS servers. Any per-link DNS servers obtained from systemd-networkd take precedence over this setting. requires puppetlabs-inifile ##### `domains` Data type: `Optional[Variant[Array[String],String]]` A space-separated list of domains host names or IP addresses to be used systemd-resolved take precedence over this setting. ##### `llmnr` Data type: `Optional[Variant[Boolean,Enum['resolve']]]` Takes a boolean argument or "resolve". ##### `multicast_dns` Data type: `Optional[Variant[Boolean,Enum['resolve']]]` Takes a boolean argument or "resolve". ##### `dnssec` Data type: `Optional[Variant[Boolean,Enum['allow-downgrade']]]` Takes a boolean argument or "allow-downgrade". ##### `dnsovertls` Data type: `Optional[Variant[Boolean,Enum['yes', 'opportunistic', 'no']]]` Takes a boolean argument or one of "yes", "opportunistic" or "no". "true" corresponds to "opportunistic" and "false" (default) to "no". ##### `cache` Data type: `Optional[Variant[Boolean,Enum['no-negative']]]` Takes a boolean argument or "no-negative". ##### `dns_stub_listener` Data type: `Optional[Variant[Boolean,Enum['udp','tcp']]]` Takes a boolean argument or one of "udp" and "tcp". ##### `use_stub_resolver` Data type: `Boolean` Takes a boolean argument. When "false" (default) it uses /run/systemd/resolve/resolv.conf as /etc/resolv.conf. When "true", it uses /run/systemd/resolve/stub-resolv.conf ##### `manage_networkd` Data type: `Boolean` Manage the systemd network daemon ##### `networkd_ensure` Data type: `Enum['stopped','running']` The state that the ``networkd`` service should be in ##### `manage_timesyncd` Data type: `Boolean` Manage the systemd tiemsyncd daemon ##### `timesyncd_ensure` Data type: `Enum['stopped','running']` The state that the ``timesyncd`` service should be in ##### `ntp_server` Data type: `Optional[Variant[Array,String]]` comma separated list of ntp servers, will be combined with interface specific addresses from systemd-networkd. requires puppetlabs-inifile ##### `fallback_ntp_server` Data type: `Optional[Variant[Array,String]]` A space-separated list of NTP server host names or IP addresses to be used as the fallback NTP servers. Any per-interface NTP servers obtained from systemd-networkd take precedence over this setting. requires puppetlabs-inifile ##### `manage_journald` Data type: `Boolean` Manage the systemd journald ##### `journald_settings` Data type: `Systemd::JournaldSettings` Config Hash that is used to configure settings in journald.conf ##### `manage_udevd` Data type: `Boolean` Manage the systemd udev daemon ##### `udev_log` Data type: `Optional[Variant[Integer,String]]` The value of /etc/udev/udev.conf udev_log ##### `udev_children_max` Data type: `Optional[Integer]` The value of /etc/udev/udev.conf children_max ##### `udev_exec_delay` Data type: `Optional[Integer]` The value of /etc/udev/udev.conf exec_delay ##### `udev_event_timeout` Data type: `Optional[Integer]` The value of /etc/udev/udev.conf event_timeout ##### `udev_resolve_names` Data type: `Optional[Enum['early', 'late', 'never']]` The value of /etc/udev/udev.conf resolve_names ##### `udev_timeout_signal` Data type: `Optional[Variant[Integer,String]]` The value of /etc/udev/udev.conf timeout_signal ##### `udev_rules` Data type: `Hash` Config Hash that is used to generate instances of our `udev::rule` define. Default value: `{}` ##### `manage_logind` Data type: `Boolean` Manage the systemd logind ##### `logind_settings` Data type: `Systemd::LogindSettings` Config Hash that is used to configure settings in logind.conf ##### `loginctl_users` Data type: `Hash` Config Hash that is used to generate instances of our type `loginctl_user`. Default value: `{}` ##### `dropin_files` Data type: `Hash` Configure dropin files via hiera with factory pattern Default value: `{}` ##### `manage_all_network_files` Data type: `Boolean` ##### `network_path` Data type: `Stdlib::Absolutepath` where all networkd files are placed in ##### `manage_accounting` Data type: `Boolean` when enabled, the different accounting options (network traffic, IO, CPU util...) are enabled for units ##### `accounting` Data type: `Hash[String,String]` Hash of the different accounting options. This highly depends on the used systemd version. The module provides sane defaults. ##### `purge_dropin_dirs` Data type: `Boolean` When enabled, unused directories for dropin files will be purged ### `systemd::tmpfiles` Update the systemd temp files * **See also** * systemd-tmpfiles(8) #### Parameters The following parameters are available in the `systemd::tmpfiles` class: * [`operations`](#operations) ##### `operations` Data type: `Array[Enum['create','clean','remove']]` The operations to perform on the systemd tempfiles * All operations may be combined but you'll probably only ever want to use ``create`` Default value: `['create']` ## Defined types ### `systemd::dropin_file` Creates a drop-in file for a systemd unit * **See also** * systemd.unit(5) #### Parameters The following parameters are available in the `systemd::dropin_file` defined type: * [`unit`](#unit) * [`filename`](#filename) * [`ensure`](#ensure) * [`path`](#path) * [`selinux_ignore_defaults`](#selinux_ignore_defaults) * [`content`](#content) * [`source`](#source) * [`target`](#target) * [`owner`](#owner) * [`group`](#group) * [`mode`](#mode) * [`show_diff`](#show_diff) * [`notify_service`](#notify_service) ##### `unit` Data type: `Systemd::Unit` the The target unit file to create, the value will be set to the `filename` parameter as well ##### `filename` Data type: `Systemd::Dropin` The target unit file to create Default value: `$name` ##### `ensure` Data type: `Enum['present', 'absent', 'file']` the state of this dropin file Default value: `'present'` ##### `path` Data type: `Stdlib::Absolutepath` The main systemd configuration path Default value: `'/etc/systemd/system'` ##### `selinux_ignore_defaults` Data type: `Boolean` If Puppet should ignore the default SELinux labels. Default value: ``false`` ##### `content` Data type: `Optional[Variant[String,Sensitive[String]]]` The full content of the unit file (Mutually exclusive with `$source`) Default value: ``undef`` ##### `source` Data type: `Optional[String]` The `File` resource compatible `source` Mutually exclusive with ``$content`` Default value: ``undef`` ##### `target` Data type: `Optional[Stdlib::Absolutepath]` If set, will force the file to be a symlink to the given target (Mutually exclusive with both `$source` and `$content` Default value: ``undef`` ##### `owner` Data type: `String` The owner to set on the dropin file Default value: `'root'` ##### `group` Data type: `String` The group to set on the dropin file Default value: `'root'` ##### `mode` Data type: `String` The mode to set on the dropin file Default value: `'0444'` ##### `show_diff` Data type: `Boolean` Whether to show the diff when updating dropin file Default value: ``true`` ##### `notify_service` Data type: `Boolean` Notify a service for the unit, if it exists Default value: ``false`` ### `systemd::network` Creates network config for systemd-networkd #### Parameters The following parameters are available in the `systemd::network` defined type: * [`ensure`](#ensure) * [`path`](#path) * [`content`](#content) * [`source`](#source) * [`target`](#target) * [`owner`](#owner) * [`group`](#group) * [`mode`](#mode) * [`show_diff`](#show_diff) * [`restart_service`](#restart_service) ##### `ensure` Data type: `Enum['file', 'absent']` configure if the file should be configured or deleted Default value: `file` ##### `path` Data type: `Stdlib::Absolutepath` directory where the network configs are stored Default value: `'/etc/systemd/network'` ##### `content` Data type: `Optional[String]` the content of the file Default value: ``undef`` ##### `source` Data type: `Optional[String]` a path to a file that's used as source Default value: ``undef`` ##### `target` Data type: `Optional[Stdlib::Absolutepath]` optional absolute path in case the file should be stored somewhere else Default value: ``undef`` ##### `owner` Data type: `String` the user who owns the file Default value: `'root'` ##### `group` Data type: `String` the group that owns the file Default value: `'root'` ##### `mode` Data type: `String` the mode of the file Default value: `'0444'` ##### `show_diff` Data type: `Boolean` whether the file diff should be shown on modifications Default value: ``true`` ##### `restart_service` Data type: `Boolean` whether systemd-networkd should be restarted on changes, defaults to true. `$systemd::manage_networkd` needs to be true as well Default value: ``true`` ### `systemd::service_limits` Adds a set of custom limits to the service * **See also** * systemd.exec(5) #### Parameters The following parameters are available in the `systemd::service_limits` defined type: * [`name`](#name) * [`ensure`](#ensure) * [`path`](#path) * [`selinux_ignore_defaults`](#selinux_ignore_defaults) * [`limits`](#limits) * [`source`](#source) * [`restart_service`](#restart_service) ##### `name` Data type: `Pattern['^.+\.(service|socket|mount|swap)$']` The name of the service that you will be modifying ##### `ensure` Data type: `Enum['present', 'absent', 'file']` Whether to drop a file or remove it Default value: `'present'` ##### `path` Data type: `Stdlib::Absolutepath` The path to the main systemd settings directory Default value: `'/etc/systemd/system'` ##### `selinux_ignore_defaults` Data type: `Boolean` If Puppet should ignore the default SELinux labels. Default value: ``false`` ##### `limits` Data type: `Optional[Systemd::ServiceLimits]` A Hash of service limits matching the settings in ``systemd.exec(5)`` * Mutually exclusive with ``$source`` Default value: ``undef`` ##### `source` Data type: `Optional[String]` A ``File`` resource compatible ``source`` * Mutually exclusive with ``$limits`` Default value: ``undef`` ##### `restart_service` Data type: `Boolean` Restart the managed service after setting the limits Default value: ``true`` ### `systemd::timer` Create a timer and optionally a service unit to execute with the timer unit * **See also** * https://www.freedesktop.org/software/systemd/man/systemd.timer.html * systemd.timer(5) #### Parameters The following parameters are available in the `systemd::timer` defined type: * [`name`](#name) * [`path`](#path) * [`timer_content`](#timer_content) * [`timer_source`](#timer_source) * [`service_content`](#service_content) * [`service_source`](#service_source) * [`owner`](#owner) * [`group`](#group) * [`mode`](#mode) * [`show_diff`](#show_diff) * [`service_unit`](#service_unit) * [`active`](#active) * [`enable`](#enable) * [`ensure`](#ensure) ##### `name` Data type: `Pattern['^.+\.timer$]` The target of the timer unit to create ##### `path` Data type: `Stdlib::Absolutepath` The main systemd configuration path Default value: `'/etc/systemd/system'` ##### `timer_content` Data type: `Optional[String[1]]` The full content of the timer unit file * Mutually exclusive with ``$timer_source`` Default value: ``undef`` ##### `timer_source` Data type: `Optional[String[1]]` The ``File`` resource compatible ``source`` * Mutually exclusive with ``$timer_content`` Default value: ``undef`` ##### `service_content` Data type: `Optional[String[1]]` The full content of the service unit file * Mutually exclusive with ``$service_source`` Default value: ``undef`` ##### `service_source` Data type: `Optional[String[1]]` The ``File`` resource compatible ``source`` * Mutually exclusive with ``$service_content`` Default value: ``undef`` ##### `owner` Data type: `String[1]` The owner to set on the dropin file Default value: `'root'` ##### `group` Data type: `String[1]` The group to set on the dropin file Default value: `'root'` ##### `mode` Data type: `Stdlib::Filemode` The mode to set on the dropin file Default value: `'0444'` ##### `show_diff` Data type: `Boolean` Whether to show the diff when updating dropin file Default value: ``true`` ##### `service_unit` Data type: `Optional[Systemd::Unit]` If set then the service_unit will have this name. If not set the service unit has the same name as the timer unit with s/.timer/.service/ Default value: ``undef`` ##### `active` Data type: `Optional[Boolean]` If set to true or false the timer service will be maintained. If true the timer service will be running and enabled, if false it will explictly stopped and disabled. Default value: ``undef`` ##### `enable` Data type: `Optional[Variant[Boolean, Enum['mask']]]` If set, will manage the state of the unit. Default value: ``undef`` ##### `ensure` Data type: `Enum['present', 'absent', 'file']` Defines the desired state of the timer Default value: `'present'` ### `systemd::tmpfile` Creates a systemd tmpfile * **See also** * systemd-tmpfiles(8) #### Parameters The following parameters are available in the `systemd::tmpfile` defined type: * [`filename`](#filename) * [`ensure`](#ensure) * [`path`](#path) * [`content`](#content) * [`source`](#source) ##### `filename` Data type: `Systemd::Dropin` The name of the tmpfile to create Default value: `$name` ##### `ensure` Data type: `Enum['present', 'absent', 'file']` Whether to drop a file or remove it Default value: `'file'` ##### `path` Data type: `Stdlib::Absolutepath` The path to the main systemd tmpfiles directory Default value: `'/etc/tmpfiles.d'` ##### `content` Data type: `Optional[String]` The literal content to write to the file * Mutually exclusive with ``$source`` Default value: ``undef`` ##### `source` Data type: `Optional[String]` A ``File`` resource compatible ``source`` * Mutually exclusive with ``$limits`` Default value: ``undef`` ### `systemd::udev::rule` Adds a custom udev rule * **See also** * udev(7) #### Parameters The following parameters are available in the `systemd::udev::rule` defined type: * [`name`](#name) * [`ensure`](#ensure) * [`path`](#path) * [`selinux_ignore_defaults`](#selinux_ignore_defaults) * [`notify_services`](#notify_services) * [`rules`](#rules) ##### `name` Data type: `Pattern['^.+\.rules$']` The name of the udev rules to create ##### `ensure` Data type: `Enum['present', 'absent', 'file']` Whether to drop a file or remove it Default value: `'present'` ##### `path` Data type: `Stdlib::Absolutepath` The path to the main systemd settings directory Default value: `'/etc/udev/rules.d'` ##### `selinux_ignore_defaults` Data type: `Boolean` If Puppet should ignore the default SELinux labels. Default value: ``false`` ##### `notify_services` Data type: `Variant[Array[String[1]], String[1]]` List of services to notify when this rule is updated Default value: `[]` ##### `rules` Data type: `Array` The literal udev rules you want to deploy ### `systemd::unit_file` Creates a systemd unit file * **See also** * systemd.unit(5) #### Parameters The following parameters are available in the `systemd::unit_file` defined type: * [`name`](#name) * [`ensure`](#ensure) * [`path`](#path) * [`content`](#content) * [`source`](#source) * [`target`](#target) * [`owner`](#owner) * [`group`](#group) * [`mode`](#mode) * [`show_diff`](#show_diff) * [`enable`](#enable) * [`active`](#active) * [`restart`](#restart) ##### `name` Data type: `Pattern['^[^/]+\.(service|socket|device|mount|automount|swap|target|path|timer|slice|scope)$']` The target unit file to create ##### `ensure` Data type: `Enum['present', 'absent', 'file']` The state of the unit file to ensure Default value: `'present'` ##### `path` Data type: `Stdlib::Absolutepath` The main systemd configuration path Default value: `'/etc/systemd/system'` ##### `content` Data type: `Optional[Variant[String, Sensitive[String], Deferred]]` The full content of the unit file * Mutually exclusive with ``$source`` Default value: ``undef`` ##### `source` Data type: `Optional[String]` The ``File`` resource compatible ``source`` * Mutually exclusive with ``$content`` Default value: ``undef`` ##### `target` Data type: `Optional[Stdlib::Absolutepath]` If set, will force the file to be a symlink to the given target * Mutually exclusive with both ``$source`` and ``$content`` Default value: ``undef`` ##### `owner` Data type: `String` The owner to set on the unit file Default value: `'root'` ##### `group` Data type: `String` The group to set on the unit file Default value: `'root'` ##### `mode` Data type: `String` The mode to set on the unit file Default value: `'0444'` ##### `show_diff` Data type: `Boolean` Whether to show the diff when updating unit file Default value: ``true`` ##### `enable` Data type: `Optional[Variant[Boolean, Enum['mask']]]` If set, will manage the unit enablement status. Default value: ``undef`` ##### `active` Data type: `Optional[Boolean]` If set, will manage the state of the unit. Default value: ``undef`` ##### `restart` Data type: `Optional[String]` Specify a restart command manually. If left unspecified, a standard Puppet service restart happens. Default value: ``undef`` ## Resource types ### `loginctl_user` An arbitrary name used as the identity of the resource. #### Properties The following properties are available in the `loginctl_user` type. ##### `linger` Valid values: `enabled`, `disabled` Whether linger is enabled for the user. Default value: `disabled` #### Parameters The following parameters are available in the `loginctl_user` type. * [`name`](#name) * [`provider`](#provider) ##### `name` namevar An arbitrary name used as the identity of the resource. ##### `provider` The specific backend to use for this `loginctl_user` resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform. +## Functions + +### `systemd::escape` + +Type: Puppet Language + +Escape strings as systemd-escape does. + +#### Examples + +##### Escaping a string + +```puppet +$result = systemd::escape('foo::bar') +``` + +##### Escaping a path + +```puppet +$result = systemd::escape('/mnt/foobar',true) +``` + +#### `systemd::escape(String[1] $input, Boolean $path = false)` + +The systemd::escape function. + +Returns: `String` String + +##### Examples + +###### Escaping a string + +```puppet +$result = systemd::escape('foo::bar') +``` + +###### Escaping a path + +```puppet +$result = systemd::escape('/mnt/foobar',true) +``` + +##### `input` + +Data type: `String[1]` + +Input string + +##### `path` + +Data type: `Boolean` + +Use path (-p) ornon-path style escaping. + ## Data types ### `Systemd::Dropin` custom datatype that validates filenames/paths for valid systemd dropin files Alias of ```puppet Pattern['^[^/]+\.conf$'] ``` ### `Systemd::JournaldSettings` Matches Systemd journald config Struct Alias of ```puppet Struct[{ Optional['Storage'] => Variant[Enum['volatile','persistent','auto','none'],Systemd::JournaldSettings::Ensure], Optional['Compress'] => Variant[Enum['yes','no'], Pattern[/^[0-9]+(K|M|G)?$/],Systemd::JournaldSettings::Ensure], Optional['Seal'] => Variant[Enum['yes','no'],Systemd::JournaldSettings::Ensure], Optional['SplitMode'] => Variant[Enum['uid','none'],Systemd::JournaldSettings::Ensure], Optional['RateLimitInterval'] => Variant[Pattern[/^[0-9]+(s|min|h|ms|us)?$/],Systemd::JournaldSettings::Ensure], Optional['RateLimitIntervalSec'] => Variant[Pattern[/^[0-9]+(s|min|h|ms|us)?$/],Systemd::JournaldSettings::Ensure], Optional['RateLimitBurst'] => Variant[Integer[0], Pattern[/^[0-9]+$/],Systemd::JournaldSettings::Ensure], Optional['SystemMaxUse'] => Variant[Pattern[/^[0-9]+(K|M|G|T|P|E)?$/],Systemd::JournaldSettings::Ensure], Optional['SystemKeepFree'] => Variant[Pattern[/^[0-9]+(K|M|G|T|P|E)?$/],Systemd::JournaldSettings::Ensure], Optional['SystemMaxFileSize'] => Variant[Pattern[/^[0-9]+(K|M|G|T|P|E)?$/],Systemd::JournaldSettings::Ensure], Optional['SystemMaxFiles'] => Variant[Integer[0], Pattern[/^[0-9]+$/],Systemd::JournaldSettings::Ensure], Optional['RuntimeMaxUse'] => Variant[Pattern[/^[0-9]+(K|M|G|T|P|E)?$/],Systemd::JournaldSettings::Ensure], Optional['RuntimeKeepFree'] => Variant[Pattern[/^[0-9]+(K|M|G|T|P|E)?$/],Systemd::JournaldSettings::Ensure], Optional['RuntimeMaxFileSize'] => Variant[Pattern[/^[0-9]+(K|M|G|T|P|E)?$/],Systemd::JournaldSettings::Ensure], Optional['RuntimeMaxFiles'] => Variant[Integer[0], Pattern[/^[0-9]+$/],Systemd::JournaldSettings::Ensure], Optional['MaxFileSec'] => Variant[Pattern[/^[0-9]+(year|month|week|day|h|m)?$/],Systemd::JournaldSettings::Ensure], Optional['MaxRetentionSec'] => Variant[Pattern[/^[0-9]+(year|month|week|day|h|m)?$/],Systemd::JournaldSettings::Ensure], Optional['SyncIntervalSec'] => Variant[Pattern[/^[0-9]+(year|month|week|day|h|m)?$/],Systemd::JournaldSettings::Ensure], Optional['ForwardToSyslog'] => Variant[Enum['yes','no'],Systemd::JournaldSettings::Ensure], Optional['ForwardToKMsg'] => Variant[Enum['yes','no'],Systemd::JournaldSettings::Ensure], Optional['ForwardToConsole'] => Variant[Enum['yes','no'],Systemd::JournaldSettings::Ensure], Optional['ForwardToWall'] => Variant[Enum['yes','no'],Systemd::JournaldSettings::Ensure], Optional['MaxLevelStore'] => Variant[Enum['emerg','alert','crit','err','warning','notice','info','debug'],Integer[0,7],Systemd::JournaldSettings::Ensure], Optional['MaxLevelSyslog'] => Variant[Enum['emerg','alert','crit','err','warning','notice','info','debug'],Integer[0,7],Systemd::JournaldSettings::Ensure], Optional['MaxLevelKMsg'] => Variant[Enum['emerg','alert','crit','err','warning','notice','info','debug'],Integer[0,7],Systemd::JournaldSettings::Ensure], Optional['MaxLevelConsole'] => Variant[Enum['emerg','alert','crit','err','warning','notice','info','debug'],Integer[0,7],Systemd::JournaldSettings::Ensure], Optional['MaxLevelWall'] => Variant[Enum['emerg','alert','crit','err','warning','notice','info','debug'],Integer[0,7],Systemd::JournaldSettings::Ensure], Optional['ReadKMsg'] => Variant[Enum['yes','no'],Systemd::JournaldSettings::Ensure], Optional['TTYPath'] => Variant[Stdlib::Absolutepath,Systemd::JournaldSettings::Ensure], Optional['LineMax'] => Variant[Pattern[/^[0-9]+(K|M|G|T)?$/],Systemd::JournaldSettings::Ensure], }] ``` ### `Systemd::JournaldSettings::Ensure` defines allowed ensure states for systemd-journald settings Alias of ```puppet Struct[{ 'ensure' => Enum['present','absent'] }] ``` ### `Systemd::LogindSettings` Matches Systemd Login Manager Struct Alias of ```puppet Struct[{ Optional['HandleHibernateKey'] => Variant[Enum['ignore','poweroff','reboot','halt','kexec','suspend','hibernate','hybrid-sleep','suspend-then-hibernate','lock'],Systemd::LogindSettings::Ensure], Optional['HandleLidSwitch'] => Variant[Enum['ignore','poweroff','reboot','halt','kexec','suspend','hibernate','hybrid-sleep','suspend-then-hibernate','lock'],Systemd::LogindSettings::Ensure], Optional['HandleLidSwitchDocked'] => Variant[Enum['ignore','poweroff','reboot','halt','kexec','suspend','hibernate','hybrid-sleep','suspend-then-hibernate','lock'],Systemd::LogindSettings::Ensure], Optional['HandleLidSwitchExternalPower'] => Variant[Enum['ignore','poweroff','reboot','halt','kexec','suspend','hibernate','hybrid-sleep','suspend-then-hibernate','lock'],Systemd::LogindSettings::Ensure], Optional['HandlePowerKey'] => Variant[Enum['ignore','poweroff','reboot','halt','kexec','suspend','hibernate','hybrid-sleep','suspend-then-hibernate','lock'],Systemd::LogindSettings::Ensure], Optional['HandleSuspendKey'] => Variant[Enum['ignore','poweroff','reboot','halt','kexec','suspend','hibernate','hybrid-sleep','suspend-then-hibernate','lock'],Systemd::LogindSettings::Ensure], Optional['HibernateKeyIgnoreInhibited'] => Variant[Enum['yes','no'],Systemd::LogindSettings::Ensure], Optional['HoldoffTimeoutSec'] => Variant[Integer,Systemd::LogindSettings::Ensure], Optional['IdleAction'] => Variant[Enum['ignore','poweroff','reboot','halt','kexec','suspend','hibernate','hybrid-sleep','suspend-then-hibernate','lock'],Systemd::LogindSettings::Ensure], Optional['IdleActionSec'] => Variant[Integer,Systemd::LogindSettings::Ensure], Optional['InhibitDelayMaxSec'] => Variant[Integer,Systemd::LogindSettings::Ensure], Optional['InhibitorsMax'] => Variant[Integer,Systemd::LogindSettings::Ensure], Optional['KillExcludeUsers'] => Variant[Array[String],Systemd::LogindSettings::Ensure], Optional['KillOnlyUsers'] => Variant[Array[String],Systemd::LogindSettings::Ensure], Optional['KillUserProcesses'] => Variant[Enum['yes','no'],Systemd::LogindSettings::Ensure], Optional['LidSwitchIgnoreInhibited'] => Variant[Enum['yes','no'],Systemd::LogindSettings::Ensure], Optional['NAutoVTs'] => Variant[Integer,Systemd::LogindSettings::Ensure], Optional['PowerKeyIgnoreInhibited'] => Variant[Enum['yes','no'],Systemd::LogindSettings::Ensure], Optional['RemoveIPC'] => Variant[Enum['yes','no'],Systemd::LogindSettings::Ensure], Optional['ReserveVT'] => Variant[Integer,Systemd::LogindSettings::Ensure], Optional['RuntimeDirectorySize'] => Variant[Integer,Pattern['^(\d+(K|M|G|T|P|E|%)?)$'],Systemd::LogindSettings::Ensure], Optional['SessionsMax'] => Variant[Integer,Pattern['^(infinity|(\d+(K|M|G|T|P|E|%)?))$'],Systemd::LogindSettings::Ensure], Optional['SuspendKeyIgnoreInhibited'] => Variant[Enum['yes','no'],Systemd::LogindSettings::Ensure], Optional['UserTasksMax'] => Variant[Integer,Pattern['^(infinity|(\d+(K|M|G|T|P|E|%)?))$'],Systemd::LogindSettings::Ensure] }] ``` ### `Systemd::LogindSettings::Ensure` defines allowed ensure states for systemd-logind settings Alias of ```puppet Struct[{ 'ensure' => Enum['present','absent'] }] ``` ### `Systemd::ServiceLimits` Matches Systemd Service Limit Struct Alias of ```puppet Struct[{ Optional['LimitCPU'] => Pattern['^\d+(s|m|h|d|w|M|y)?(:\d+(s|m|h|d|w|M|y)?)?$'], Optional['LimitFSIZE'] => Pattern['^(infinity|((\d+(K|M|G|T|P|E)(:\d+(K|M|G|T|P|E))?)))$'], Optional['LimitDATA'] => Pattern['^(infinity|((\d+(K|M|G|T|P|E)(:\d+(K|M|G|T|P|E))?)))$'], Optional['LimitSTACK'] => Pattern['^(infinity|((\d+(K|M|G|T|P|E)(:\d+(K|M|G|T|P|E))?)))$'], Optional['LimitCORE'] => Pattern['^(infinity|((\d+(K|M|G|T|P|E)(:\d+(K|M|G|T|P|E))?)))$'], Optional['LimitRSS'] => Pattern['^(infinity|((\d+(K|M|G|T|P|E)(:\d+(K|M|G|T|P|E))?)))$'], Optional['LimitNOFILE'] => Variant[Integer[-1],Pattern['^(infinity|\d+(:(infinity|\d+))?)$']], Optional['LimitAS'] => Pattern['^(infinity|((\d+(K|M|G|T|P|E)(:\d+(K|M|G|T|P|E))?)))$'], Optional['LimitNPROC'] => Variant[Integer[-1],Pattern['^(infinity|\d+(:(infinity|\d+))?)$']], Optional['LimitMEMLOCK'] => Pattern['^(infinity|((\d+(K|M|G|T|P|E)(:\d+(K|M|G|T|P|E))?)))$'], Optional['LimitLOCKS'] => Integer[1], Optional['LimitSIGPENDING'] => Integer[1], Optional['LimitMSGQUEUE'] => Pattern['^(infinity|((\d+(K|M|G|T|P|E)(:\d+(K|M|G|T|P|E))?)))$'], Optional['LimitNICE'] => Variant[Integer[0,40], Pattern['^(-\+([0-1]?[0-9]|20))|([0-3]?[0-9]|40)$']], Optional['LimitRTPRIO'] => Integer[0], Optional['LimitRTTIME'] => Pattern['^\d+(ms|s|m|h|d|w|M|y)?(:\d+(ms|s|m|h|d|w|M|y)?)?$'], Optional['CPUAccounting'] => Boolean, Optional['CPUShares'] => Integer[2,262144], Optional['StartupCPUShares'] => Integer[2,262144], Optional['CPUQuota'] => Pattern['^([1-9][0-9]*)%$'], Optional['MemoryAccounting'] => Boolean, Optional['MemoryLow'] => Pattern['^(\d+(K|M|G|T)?)$'], Optional['MemoryHigh'] => Pattern['^(\d+(K|M|G|T)?)$'], Optional['MemoryMax'] => Pattern['^(\d+(K|M|G|T)?)$'], Optional['MemoryLimit'] => Pattern['^(\d+(K|M|G|T)?)$'], Optional['TasksAccounting'] => Boolean, Optional['TasksMax'] => Variant[Integer[1],Pattern['^(infinity|([1-9][0-9]?$|^100)%)$']], Optional['IOAccounting'] => Boolean, Optional['IOWeight'] => Integer[1,10000], Optional['StartupIOWeight'] => Integer[1,10000], Optional['IODeviceWeight'] => Array[Hash[Stdlib::Absolutepath, Integer[1,10000], 1, 1]], Optional['IOReadBandwidthMax'] => Array[Hash[Stdlib::Absolutepath, Pattern['^(\d+(K|M|G|T)?)$'], 1, 1]], Optional['IOWriteBandwidthMax'] => Array[Hash[Stdlib::Absolutepath, Pattern['^(\d+(K|M|G|T)?)$'], 1, 1]], Optional['IOReadIOPSMax'] => Array[Hash[Stdlib::Absolutepath, Pattern['^(\d+(K|M|G|T)?)$'], 1, 1]], Optional['IOWriteIOPSMax'] => Array[Hash[Stdlib::Absolutepath, Pattern['^(\d+(K|M|G|T)?)$'], 1, 1]], Optional['DeviceAllow'] => String[1], Optional['DevicePolicy'] => Enum['auto','closed','strict'], Optional['Slice'] => String[1], Optional['Delegate'] => Boolean, Optional['OOMScoreAdjust'] => Integer[-1000,1000] }] ``` ### `Systemd::Unit` custom datatype that validates different filenames for systemd units Alias of ```puppet Pattern['^[^/]+\.(service|socket|device|mount|automount|swap|target|path|timer|slice|scope)$'] ``` diff --git a/functions/escape.pp b/functions/escape.pp new file mode 100644 index 0000000..2b9dc1d --- /dev/null +++ b/functions/escape.pp @@ -0,0 +1,43 @@ +# @summary Escape strings as systemd-escape does. +# @param input Input string +# @param path Use path (-p) ornon-path style escaping. +# @return String +# @example Escaping a string +# $result = systemd::escape('foo::bar') +# @example Escaping a path +# $result = systemd::escape('/mnt/foobar',true) +function systemd::escape(String[1] $input, Boolean $path = false) >> String { + # Escape method is defined + # https://www.freedesktop.org/software/systemd/man/systemd.unit.html + + # fail path if . on end. + if $path and $input[-1] == '.' { + fail('A path can not end in a \'.\'') + } + + # De-duplicate any `/` and prefix,suffix `/` if file + if $path { + $_chomped = $input.regsubst('/+$','').regsubst('^/+','').regsubst('//+','/') + } else { + $_chomped = $input + } + + # Docs talk of escaping `:` also but seems not to be the case in reality. + # + $_output = $_chomped.map |$_i, $_token | { + case $_token { + '.': { + $_escaped = $_i ? { + 0 => '\x2e', + default => $_token, + } + } + '/': { $_escaped = '-' } + ',': { $_escaped = '\x2c' } + default: { $_escaped = $_token } + } + $_escaped + }.join + + return $_output +} diff --git a/spec/functions/escape_spec.rb b/spec/functions/escape_spec.rb new file mode 100644 index 0000000..f1d49d3 --- /dev/null +++ b/spec/functions/escape_spec.rb @@ -0,0 +1,19 @@ +require 'spec_helper' +describe 'systemd::escape' do + context 'with path false' do + it { is_expected.to run.with_params('foo', false).and_return('foo') } + it { is_expected.to run.with_params('foo/bar/.', false).and_return('foo-bar-.') } + it { is_expected.to run.with_params('/foo/bar/', false).and_return('-foo-bar-') } + it { is_expected.to run.with_params('//foo//bar//', false).and_return('--foo--bar--') } + it { is_expected.to run.with_params('//foo:bar,foo_bar.//', false).and_return('--foo:bar\x2cfoo_bar.--') } + it { is_expected.to run.with_params('.foo', false).and_return('\x2efoo') } + end + context 'with path true' do + it { is_expected.to run.with_params('foo', true).and_return('foo') } + it { is_expected.to run.with_params('foo/bar/.', true).and_raise_error(%r{ path can not end}) } + it { is_expected.to run.with_params('/foo/bar/', true).and_return('foo-bar') } + it { is_expected.to run.with_params('//foo//bar//', true).and_return('foo-bar') } + it { is_expected.to run.with_params('//foo:bar,foo_bar.//', true).and_return('foo:bar\x2cfoo_bar.') } + it { is_expected.to run.with_params('.foo', true).and_return('\x2efoo') } + end +end