diff mbox

[1/2] fstest: add helper _require_fs_feature

Message ID 1499852605-27759-2-git-send-email-amir73il@gmail.com (mailing list archive)
State New, archived
Headers show

Commit Message

Amir Goldstein July 12, 2017, 9:43 a.m. UTC
The helper is used to test if a specific filesystem feature can
be enabled. Currently only implemented testing overlayfs features.

Overalyfs features (e.g. redirect_dir, index) are configurable from
Kconfig (the build default), by module parameter (the system default)
and per mount using the mount option ${feature}=[on|off].

The helper is going to be used by overlay tests, which depend
on the inodes index feature.

Signed-off-by: Amir Goldstein <amir73il@gmail.com>
---
 common/rc | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)

Comments

Eryu Guan July 13, 2017, 12:41 p.m. UTC | #1
On Wed, Jul 12, 2017 at 12:43:24PM +0300, Amir Goldstein wrote:
> The helper is used to test if a specific filesystem feature can
> be enabled. Currently only implemented testing overlayfs features.
> 
> Overalyfs features (e.g. redirect_dir, index) are configurable from
> Kconfig (the build default), by module parameter (the system default)
> and per mount using the mount option ${feature}=[on|off].
> 
> The helper is going to be used by overlay tests, which depend
> on the inodes index feature.
> 
> Signed-off-by: Amir Goldstein <amir73il@gmail.com>
> ---
>  common/rc | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 48 insertions(+)
> 
> diff --git a/common/rc b/common/rc
> index b505365..260b48d 100644
> --- a/common/rc
> +++ b/common/rc
> @@ -3626,6 +3626,54 @@ _get_fs_sysfs_attr()
>  	cat /sys/fs/${FSTYP}/${dname}/${attr}
>  }
>  
> +# Print the value of a filesystem module parameter
> +# at /sys/module/$FSTYP/parameters/$PARAM
> +#
> +# Usage example (FSTYP=overlay):
> +#   _get_fs_module_param index
> +_get_fs_module_param()
> +{
> +	cat /sys/module/${FSTYP}/parameters/${1} 2>/dev/null
> +}
> +
> +# Generic test for specific filesystem feature.
> +# Currently only implemented to test overlayfs features.
> +_require_fs_feature()

I'd think if it should be renamed to _require_scratch_feature, because
it assumes $SCRATCH_DEV is present, and it reminds people it's using
SCRATCH_DEV with "scratch" in the name.

Otherwise looks good to me, it has detailed explanations, thanks a lot!

> +{
> +	local feature=$1
> +
> +	case "$FSTYP" in
> +	    overlay)
> +		# overalyfs features (e.g. redirect_dir, index) are
> +		# configurable from Kconfig (the build default), by module
> +		# parameter (the system default) and per mount by mount
> +		# option ${feature}=[on|off].

I'll fix the indention here, like

	case "$FSTYP" in
	overlay)
		...
		;;
	*)
		;;
	esac

Thanks,
Eryu

> +		#
> +		# If the module parameter does not exist then there is no
> +		# point in checking the mount option.
> +		local default=`_get_fs_module_param ${feature}`
> +		[ "$default" = Y ] || [ "$default" = N ] || \
> +			_notrun "feature '${feature}' not supported by ${FSTYP}"
> +
> +	        _scratch_mkfs > /dev/null 2>&1
> +	        _scratch_mount -o ${feature}=on || \
> +	                _notrun "${FSTYP} feature '${feature}' cannot be enabled on ${SCRATCH_DEV}"
> +		# Check options to be sure. For example, Overlayfs will fallback to
> +		# index=off if underlying fs does not support file handles.
> +		# Overlayfs only displays mount option if it differs from the default.
> +		# Overlayfs may enable the feature, but fallback to read-only mount.
> +		((( [ "$default" = N ] && _fs_options $SCRATCH_DEV | grep -q "${feature}=on" ) || \
> +		  ( [ "$default" = Y ] && ! _fs_options $SCRATCH_DEV | grep -q "${feature}=off" )) && \
> +		    touch $SCRATCH_MNT/foo 2>/dev/null ) || \
> +	                _notrun "${FSTYP} feature '${feature}' cannot be enabled on ${SCRATCH_DEV}"
> +		_scratch_unmount
> +		;;
> +	    *)
> +		_fail "Test for feature '${feature}' of ${FSTYP} is not implemented"
> +		;;
> +	esac
> +}
> +
>  
>  init_rc
>  
> -- 
> 2.7.4
> 
--
To unsubscribe from this list: send the line "unsubscribe fstests" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Amir Goldstein July 13, 2017, 1:10 p.m. UTC | #2
On Thu, Jul 13, 2017 at 3:41 PM, Eryu Guan <eguan@redhat.com> wrote:
> On Wed, Jul 12, 2017 at 12:43:24PM +0300, Amir Goldstein wrote:
>> The helper is used to test if a specific filesystem feature can
>> be enabled. Currently only implemented testing overlayfs features.
>>
>> Overalyfs features (e.g. redirect_dir, index) are configurable from
>> Kconfig (the build default), by module parameter (the system default)
>> and per mount using the mount option ${feature}=[on|off].
>>
>> The helper is going to be used by overlay tests, which depend
>> on the inodes index feature.
>>
>> Signed-off-by: Amir Goldstein <amir73il@gmail.com>
>> ---
>>  common/rc | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
>>  1 file changed, 48 insertions(+)
>>
>> diff --git a/common/rc b/common/rc
>> index b505365..260b48d 100644
>> --- a/common/rc
>> +++ b/common/rc
>> @@ -3626,6 +3626,54 @@ _get_fs_sysfs_attr()
>>       cat /sys/fs/${FSTYP}/${dname}/${attr}
>>  }
>>
>> +# Print the value of a filesystem module parameter
>> +# at /sys/module/$FSTYP/parameters/$PARAM
>> +#
>> +# Usage example (FSTYP=overlay):
>> +#   _get_fs_module_param index
>> +_get_fs_module_param()
>> +{
>> +     cat /sys/module/${FSTYP}/parameters/${1} 2>/dev/null
>> +}
>> +
>> +# Generic test for specific filesystem feature.
>> +# Currently only implemented to test overlayfs features.
>> +_require_fs_feature()
>
> I'd think if it should be renamed to _require_scratch_feature, because
> it assumes $SCRATCH_DEV is present, and it reminds people it's using
> SCRATCH_DEV with "scratch" in the name.

Right. makes sense. Do you need me to re-post or will you fix on commit?

>
> Otherwise looks good to me, it has detailed explanations, thanks a lot!
>
>> +{
>> +     local feature=$1
>> +
>> +     case "$FSTYP" in
>> +         overlay)
>> +             # overalyfs features (e.g. redirect_dir, index) are
>> +             # configurable from Kconfig (the build default), by module
>> +             # parameter (the system default) and per mount by mount
>> +             # option ${feature}=[on|off].
>
> I'll fix the indention here, like
>
>         case "$FSTYP" in
>         overlay)
>                 ...
>                 ;;
>         *)
>                 ;;
>         esac
>
> Thanks,
> Eryu
>
>> +             #
>> +             # If the module parameter does not exist then there is no
>> +             # point in checking the mount option.
>> +             local default=`_get_fs_module_param ${feature}`
>> +             [ "$default" = Y ] || [ "$default" = N ] || \
>> +                     _notrun "feature '${feature}' not supported by ${FSTYP}"
>> +
>> +             _scratch_mkfs > /dev/null 2>&1
>> +             _scratch_mount -o ${feature}=on || \
>> +                     _notrun "${FSTYP} feature '${feature}' cannot be enabled on ${SCRATCH_DEV}"
>> +             # Check options to be sure. For example, Overlayfs will fallback to
>> +             # index=off if underlying fs does not support file handles.
>> +             # Overlayfs only displays mount option if it differs from the default.
>> +             # Overlayfs may enable the feature, but fallback to read-only mount.
>> +             ((( [ "$default" = N ] && _fs_options $SCRATCH_DEV | grep -q "${feature}=on" ) || \
>> +               ( [ "$default" = Y ] && ! _fs_options $SCRATCH_DEV | grep -q "${feature}=off" )) && \
>> +                 touch $SCRATCH_MNT/foo 2>/dev/null ) || \
>> +                     _notrun "${FSTYP} feature '${feature}' cannot be enabled on ${SCRATCH_DEV}"
>> +             _scratch_unmount
>> +             ;;
>> +         *)
>> +             _fail "Test for feature '${feature}' of ${FSTYP} is not implemented"
>> +             ;;
>> +     esac
>> +}
>> +
>>
>>  init_rc
>>
>> --
>> 2.7.4
>>
--
To unsubscribe from this list: send the line "unsubscribe fstests" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Eryu Guan July 14, 2017, 2:54 a.m. UTC | #3
On Thu, Jul 13, 2017 at 04:10:44PM +0300, Amir Goldstein wrote:
> On Thu, Jul 13, 2017 at 3:41 PM, Eryu Guan <eguan@redhat.com> wrote:
> > On Wed, Jul 12, 2017 at 12:43:24PM +0300, Amir Goldstein wrote:
> >> The helper is used to test if a specific filesystem feature can
> >> be enabled. Currently only implemented testing overlayfs features.
> >>
> >> Overalyfs features (e.g. redirect_dir, index) are configurable from
> >> Kconfig (the build default), by module parameter (the system default)
> >> and per mount using the mount option ${feature}=[on|off].
> >>
> >> The helper is going to be used by overlay tests, which depend
> >> on the inodes index feature.
> >>
> >> Signed-off-by: Amir Goldstein <amir73il@gmail.com>
> >> ---
> >>  common/rc | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
> >>  1 file changed, 48 insertions(+)
> >>
> >> diff --git a/common/rc b/common/rc
> >> index b505365..260b48d 100644
> >> --- a/common/rc
> >> +++ b/common/rc
> >> @@ -3626,6 +3626,54 @@ _get_fs_sysfs_attr()
> >>       cat /sys/fs/${FSTYP}/${dname}/${attr}
> >>  }
> >>
> >> +# Print the value of a filesystem module parameter
> >> +# at /sys/module/$FSTYP/parameters/$PARAM
> >> +#
> >> +# Usage example (FSTYP=overlay):
> >> +#   _get_fs_module_param index
> >> +_get_fs_module_param()
> >> +{
> >> +     cat /sys/module/${FSTYP}/parameters/${1} 2>/dev/null
> >> +}
> >> +
> >> +# Generic test for specific filesystem feature.
> >> +# Currently only implemented to test overlayfs features.
> >> +_require_fs_feature()
> >
> > I'd think if it should be renamed to _require_scratch_feature, because
> > it assumes $SCRATCH_DEV is present, and it reminds people it's using
> > SCRATCH_DEV with "scratch" in the name.
> 
> Right. makes sense. Do you need me to re-post or will you fix on commit?

You've acked it, I can fix it myself :)

Thanks,
Eryu
--
To unsubscribe from this list: send the line "unsubscribe fstests" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox

Patch

diff --git a/common/rc b/common/rc
index b505365..260b48d 100644
--- a/common/rc
+++ b/common/rc
@@ -3626,6 +3626,54 @@  _get_fs_sysfs_attr()
 	cat /sys/fs/${FSTYP}/${dname}/${attr}
 }
 
+# Print the value of a filesystem module parameter
+# at /sys/module/$FSTYP/parameters/$PARAM
+#
+# Usage example (FSTYP=overlay):
+#   _get_fs_module_param index
+_get_fs_module_param()
+{
+	cat /sys/module/${FSTYP}/parameters/${1} 2>/dev/null
+}
+
+# Generic test for specific filesystem feature.
+# Currently only implemented to test overlayfs features.
+_require_fs_feature()
+{
+	local feature=$1
+
+	case "$FSTYP" in
+	    overlay)
+		# overalyfs features (e.g. redirect_dir, index) are
+		# configurable from Kconfig (the build default), by module
+		# parameter (the system default) and per mount by mount
+		# option ${feature}=[on|off].
+		#
+		# If the module parameter does not exist then there is no
+		# point in checking the mount option.
+		local default=`_get_fs_module_param ${feature}`
+		[ "$default" = Y ] || [ "$default" = N ] || \
+			_notrun "feature '${feature}' not supported by ${FSTYP}"
+
+	        _scratch_mkfs > /dev/null 2>&1
+	        _scratch_mount -o ${feature}=on || \
+	                _notrun "${FSTYP} feature '${feature}' cannot be enabled on ${SCRATCH_DEV}"
+		# Check options to be sure. For example, Overlayfs will fallback to
+		# index=off if underlying fs does not support file handles.
+		# Overlayfs only displays mount option if it differs from the default.
+		# Overlayfs may enable the feature, but fallback to read-only mount.
+		((( [ "$default" = N ] && _fs_options $SCRATCH_DEV | grep -q "${feature}=on" ) || \
+		  ( [ "$default" = Y ] && ! _fs_options $SCRATCH_DEV | grep -q "${feature}=off" )) && \
+		    touch $SCRATCH_MNT/foo 2>/dev/null ) || \
+	                _notrun "${FSTYP} feature '${feature}' cannot be enabled on ${SCRATCH_DEV}"
+		_scratch_unmount
+		;;
+	    *)
+		_fail "Test for feature '${feature}' of ${FSTYP} is not implemented"
+		;;
+	esac
+}
+
 
 init_rc