File Coverage

blib/lib/Devel/CheckOS/Helpers/LinuxOSrelease.pm

Criterion	Covered	Total	%
statement	22	24	91.6
branch	4	8	50.0
condition			n/a
subroutine	7	7	100.0
pod	1	1	100.0
total	34	40	85.0

package Devel::CheckOS::Helpers::LinuxOSrelease;

use strict;
use warnings;
use parent 'Exporter';

use Cwd;
use File::Spec;

our $VERSION   = '1.0';
our @EXPORT_OK = qw(distributor_id);

=pod

=head1 NAME

Devel::CheckOS::Helpers::LinuxOSrelease - functions to deal with /etc/os-release file

=head1 SYNOPSIS

    use Devel::CheckOS::Helpers::LinuxOSrelease 'distributor_id';
    my $id = distributor_id;

=head1 DESCRIPTION

This module exports functions to handle text files related to Debian-like
distributions.

=head1 EXPORTED

The following subs are exported.

=head2 distributor_id

Retrieves and returns the distributor ID from the F file.

It is expected that the file exists, it is readable and have the following
(minimum) content format:

    NAME="Ubuntu"
    VERSION_ID="22.04"
    VERSION="22.04.4 LTS (Jammy Jellyfish)"
    VERSION_CODENAME=jammy
    ID=ubuntu
    ID_LIKE=debian
    HOME_URL="https://www.ubuntu.com/"

This excerpt is from Ubuntu 22.04, but other distributions might have fewer,
more or different fields and values.

It returns the value of C or C, if the conditions are not those
specified above.

=cut

my $file_path = File::Spec->catfile('', 'etc', 'os-release');

sub _set_file { $file_path = File::Spec->catfile(getcwd, @_); }

sub distributor_id {
    if ( -r $file_path ) {
        open my $in, '<', $file_path or die "Cannot read $file_path: $!";
        while (<$in>) {
            chomp;
            if ( $_ =~ /^ID=["']?(.+?)(["']|$)/ ) {
                return $1;
            }
        }
        close($in) or die "Cannot close $file_path: $!";
    }

    return undef;
}

=head1 COPYRIGHT and LICENCE

Copyright 2024 David Cantrell

This software is free-as-in-speech software, and may be used, distributed, and modified under the terms of either the GNU General Public Licence version 2 or the Artistic Licence. It's up to you which one you use. The full text of the licences can be found in the files GPL2.txt and ARTISTIC.txt, respectively.

=cut

1;