qrpm 0.1.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 884bb9257c9679db9a55e792de02fe716fc777e8903b1ed003fed768bba51129
-  data.tar.gz: eebed25d75b50ae9f738afebadec366ae22307245be691449cce0ca48f3bab6f
+  metadata.gz: 2a29e53e76de18751fc16a216ae6add03606f98c4d5b26e8dbdce28f5246d5ce
+  data.tar.gz: 30f123b324fb34ac66cd64ee4e2b1c9a292d231485658be1ebb057770392522c
 SHA512:
-  metadata.gz: a12688142eb50b64dbf59324d299f192421675279af2574be1fee9d6df5aba3b0272f9a4196d05dee64165be6ffc19f2769c7954a363e6c705b6b17849be5d93
-  data.tar.gz: bad940c0c5af97d5fa5ec5c809266765b0d3ecd5925a50c726544ea2cc15d7ba434926ba6c6e1b00918c002cfbcf2dd26f1409e93fa01b7bbfb7ffbfe0cac321
+  metadata.gz: f2a572a1f28b482c99b1021ab4a58da87fe0a37faa613e737bc75648796748409d3fd41b7a1cf6901854707c306ce98e70638d2110993fee55811911d1dc1e7b
+  data.tar.gz: 4a6ea425d7bae8cbddabb19f2f34b304354676a625a3390cdcc4f2cfba19f72f978b6c27ed087dfd2522ed6f73eea5f99ccbfa531f725340767e898e6d1ffb4b

data/.ruby-version

@@ -1 +1 @@
-ruby-2.7.1
+ruby-3.1.2

data/NOTES

@@ -0,0 +1,7 @@
+
+Random notes that should make it into the documention
+
+o Directory nodes are top-level array definitions, optionally suffix with a /
+o Only DirectoryNode keys can include a '/'
+o Only DirectoryNode keys can include variables. What about this:
+o DirectoryNodes can't be referenced

data/TODO

@@ -0,0 +1,30 @@
+o Rule: Symbol keys are variables, String keys are directories
+
+o Use Nodes everywhere -> makes a lot of stuff much easier
+
+o Check "dir: file" vs. "dir:\n  - file"
+
+o Allow shell escapes to return arrays and hashes
+
+o Allow directories within directories:
+    dir/
+      - file
+      - subdir/
+        - element # Oops: Illegal YAML syntax
+
+o What happens if directory declarations maps to the same:
+  dir1: dir
+  dir2: dir
+  $dir1:
+    - file
+  $dir2:
+    - file
+
+o Use same naming everywhere: field vs. value, name vs. path etc.
+  - "fields" are variables that also are RPM fields
+  - "variables" are QRPM variables
+
+o Better references to source in error messages: Read input file(s) in parallel
+  with parsing of the YAML document (doesn't work with YAML merge/include). Maybe
+  decorate strings with lineno/charno and if the YAML module fails we catch the
+  error and remove the decoration from the error message

data/doc/pg.yml

@@ -0,0 +1,37 @@
+
+# Default Redhat Postgres definititions
+pg:
+  name: "postgres" # Name of the package. It is also the default name for package-specific diretories
+  vendor: "redhat"
+  version: null # To be specified explicitly or detected dynamically using detect.pg.version
+  major_version: $(sed 's/\..*//' <<<${{pg.version}})
+  pckdir: pgsql
+  etcdir: $pg.vardir/data
+  vardir: $vardir/$pg.pckdir
+  libdir: $libdir/$pg.pckdir # Assuming libdir points to /usr/lib64
+  extdir: $pg.libdir/extension
+  sharedir: $sharedir/$pg.pckdir
+
+  conf_file: $pg.etcdir/postgresql.conf
+  hba_file: $pg.etcdir/pg_hba.conf
+  ident_file: $pg.etcdir/pg_ident.conf
+
+# Detections
+detect:
+  pg:
+    version: $(pg_config --version | sed 's/^[^0-9]* \([0-9]\+\).*$/\1/')
+
+# pgdg overrides
+pg:
+  name: postgresql$pg.version
+  vendor: "pgdg"
+  version: null
+  vardir: $vardir/$pg.pckdir/$pg.major_version
+  usrdir: /usr/pgsql-$pg.major_version
+  libdir: $pg.usrdir/lib
+  extdir: $pg.libdir/extension
+  sharedir: $pg.usrdir/share
+
+pg.version: $detect.pg.version
+
+

data/doc/qrpm2.rb

@@ -0,0 +1,69 @@
+#!/usr/bin/env ruby
+
+require 'yaml'
+
+p YAML.load(IO.read("t.yml"))
+
+exit
+
+
+
+
+
+require 'indented_io'
+
+s = "member"
+
+s =~ /^(\w+)|\[(\d+)\](?:\.|$)/
+p $1
+p $2
+
+
+__END__
+
+a = "1. $a 2. \\$a 3. \\\\$a 4. \\\\\\$a 5. \\\\\\\\$a rest"
+b = "1. ${a} 2. \\${a} 3. \\\\${a} 4. \\\\\\${a} 5. \\\\\\\\${a} rest"
+c = "1. $(a)"
+d = "1. $a $(b $b ${b} ${{b}}) $c \\"
+
+IDENT_RE = /(?:[\w_][\w\d_.]*)/
+
+# Return an array of prefix/interpolated-variable tuples. The prefix is the
+# string leading up to the variable. $NAME, ${NAME}, and $(COMMAND)
+# interpolations are recognized
+def parse_string(path, string)
+  r = string.scan(/(.*?)(\\*)(\$#{IDENT_RE}|\$\{#{IDENT_RE}\}|\$\(.+\)|$)/).map { 
+      |prefix, backslashes, interpolation|
+    p [prefix, backslashes, interpolation]
+
+
+    str = prefix + '\\' * (backslashes.size / 2)
+    if backslashes.size % 2 == 0
+      var = interpolation
+    else
+      str += '\\' * (backslashes.size % 2) + interpolation
+    end
+    [str, var]
+  }[0..-2]
+  puts
+  r
+end
+
+#parse_string("a", a).each { |e| p e }
+#exit
+
+for s in [a, b, c, d] 
+  puts "\"#{s}\""
+  indent {
+    parse_string("fake", s).each { |a|
+      p a
+    }
+  }
+  puts
+end
+
+#p a.scan(/\S+\s\S+/)
+
+
+exit
+

data/doc/qrpm2.yml

@@ -0,0 +1,55 @@
+# Qrpm with "functions"
+---
+
+# User-code
+#
+pg:
+  vendor: pgdg
+
+$user_dir:
+  - $pg.postgresql_conf
+
+# Standard global variables
+#   platform (redhat/debian/etc)
+#   vendor (only defined for third-party packages)
+#   domain (the network)
+#   host (the host)
+#
+#   The standard variables are ordered
+
+pg:
+  etcdir: $(detect)
+  datadir: $(detect)
+  postgresql_conf: ${pg.etcdir}/postgresql.conf
+  pg_hba_conf: ${pg.etcdir}/pg_hba.conf
+  pg_ident_conf: ${pg.etcdir}/pg_ident.conf
+
+pg(platform=redhat):
+  etcdir: ${pg.datadir}
+  datadir: $pcklidir/data
+
+pg(platform=debian):
+  etcdir: $pcketcdir
+  datadir: /var/lib/pgsql/data
+
+# 'plaform=*' to make this more specific than the default. Not needed if
+# standard variables are ordered
+pg(platform=*,vendor=pgdg):
+  datadir: $pcklibdir/${pg.version}/data
+
+pg(platform=debian,vendor=pgdg):
+  etcdir: $pcketcdir/${pg.version}
+
+pg(platform=redhat,vendor=pgdg):
+  etcdir: ${pg.datadir}
+  
+# nested expressions
+#
+pg(vendor=pgdg):
+  datadir: $pcklibdir/${pg.version}/data
+  platform=redhat:
+    etcdir: ${pg.datadir}
+  platform=debian:
+    etcdir: $pckectdir/${pg.version}
+
+  

data/example/my_package_name.spec

@@ -0,0 +1,49 @@
+
+Name: my_package_name
+Summary: This is a summary of the package
+Version: 1.2.3
+Release: 4
+License: GPL
+Packager: clr
+Requires: ruby
+Requires: httpd
+Requires: postgresql13
+Source: %{name}.tar.gz
+BuildRoot: /tmp/d20220502-22446-8neiew/tmp/%{name}-%{version}
+
+%description
+Optional longer description of the package
+
+%prep
+%setup -n my_package_name
+
+%build
+my_configure; my_make
+
+%install
+mkdir -p %{buildroot}/usr/bin %{buildroot}/usr/sbin %{buildroot}/usr/share/my_package_name %{buildroot}/var/lib
+cp bin/a_file %{buildroot}/usr/bin/a_file
+cp bin/another_file %{buildroot}/usr/bin/another_file
+cp bin/a_file %{buildroot}/usr/bin/an_alias
+cp share/some_data %{buildroot}/usr/share/my_package_name/some_data
+cp share/some_other_data %{buildroot}/var/lib/some_other_data
+touch %{buildroot}/usr/sbin/a_file
+
+%files
+/usr/bin/a_file
+/usr/bin/another_file
+/usr/bin/an_alias
+/usr/share/my_package_name/some_data
+/var/lib/some_other_data
+%ghost /usr/sbin/a_file
+
+%clean
+%if "%{clean}" != ""
+  rm -rf %{_topdir}/BUILD/%{name}
+  [ $(basename %{buildroot}) == "%{name}-%{version}-%{release}.%{_target_cpu}" ] && rm -rf %{buildroot}
+%endif
+
+%post
+
+ln -sf /bin/a_file /usr/sbin/a_file
+

data/example.yml

@@ -1,30 +1,84 @@
 # QRPM configuration file. See https://github.com/clrgit/qrpm
 
+# program ::= directory...
+# directory ::= field... directory...
+# field ::= key '*' value
+# directory ::= array(string)
+#
+# TODO
+#   o Use '@' instead of '$'. Yields @name and @{name} that doesn't interfere
+#     with bash expansion
+#   
+#
+# ${{name}} in $(...)
+#   QRPM dependency check variable definitions and needs to be able to detect
+#   variable usages in $(...) constructs
+
+# @include git-project
+#   -> version: $(cd ${{srcdir}}; git tag | tail -1 | sed 's/^v//')
+#      
+# @include postgres-project prefix: pg_
+#   -> pg_name
+#      pg_version
+#      pg_libdir
+#      pg_sharedir
+#
+# @include postgres-project git@github.com:... commit-id
+#
+# @include redhat/httpd
+# @include redhat/pg
+# @include pgdg
+#
+# pg.version: 14
+# pg: pgdg[14]
+
 name: $pg_name-url_encode
-summary: Adds the url_encode extension to postgres
+summary: Adds the 'url_encode' extension to postgres ${pg.version}
 description: RPM wrapper for the postgres url_encode extension (https://github.com/okbob/url_encode)
-version: $(cd url_encode; git tag | tail -1 | sed 's/^v//')
+version: $(cd ${{srcdir}}; git tag | tail -1 | sed 's/^v//')
+            # ^Oops, hardcoded FIXME: Have a dependency graph and use some standard algorithm
+
+include:
+  - ./qrpm.includes
 
 requires:
   - $pg_name-server
   - $pg_name-libs
 
-pg_name: $(rpm -q -qf '%{NAME}\n' -f $(readlink -f $(which pg_config)))
-pg_version: $(pg_config --version | sed 's/^[^0-9]* \([0-9]\+\).*$/\1/')
-pg_libdir: $(pg_config --libdir)
-pg_extdir: $(pg_config --share)/extension
+a: $b
+b: $c
+c: $a
+# Idea
+#submod: url_encode
+#subdir: url_encode
+#patches:
+# - patch/patch1.patch
+srcdir: url_encode
 
-init:
-  - git submodule init
-  - git submodule update
+root: ""
+
+pg:
+  name: $(rpm -q --qf '%{NAME}\n' -f $(readlink -f $(which pg_config)))
+  version: $(pg_config --version | sed 's/^[^0-9]* \([0-9]\+\).*$/\1/')
+  major: $version
+  libdir: $(pg_config --libdir)
+  sharedir: $(pg_config --sharedir)
+
+#init: # FIXME Doesn't work atm
+# - git submodule init
+# - git submodule update
 
 make:
-  - cd url_encode; make
+  - cd $srcdir; make
+
+${pg.sharedir}/extension:
+  - $srcdir/url_encode.control
+  - $srcdir/sql/url_encode--1.2.sql
 
-$pg_libdir:
-  - url_encode/src/url_encode.so
+${pg.libdir}:
+  - $srcdir/src/url_encode.so
+  - $srcdir/postgresql$version
 
-$pg_extdir:
-  - url_encode/url_encode.control
-  - url_encode/sql/url_encode--1.2.sql
+$root/somedir:
+  - $srcdir/somefile
 

data/exe/qrpm

@@ -7,30 +7,69 @@ require_relative '../lib/qrpm.rb'
 
 require 'yaml'
 require 'shellopts'
-require 'indented_io'
 
 # TODO
 #   o Fix BuildRoot (contains absolute path)
-#   o Enable escape of $
-#   o Separate standard variable from user-variables in dump
+#
+#   + Separate standard variables from user-variables in dump
+#   + Enable escape of $
+#   + Support for $(...) constructs
 
 begin
   SPEC = %(
-    @ Quick RPM builder
+    @ Make simple RPMs simple
 
-    'qrpm' creates a RPM package from a simple YAML specification file
+    -- VARIABLE=VALUE... [QRPM-FILE]
 
-    A template YAML qrpm configuration file can be generated by the --template
-    option.  It is in YAML format with the extension that a single '__END__'
-    terminates the file and that $NAME or ${NAME} are variables that will be
-    expanded. The variables can either be specified in the configuration file
-    or given on the command line in <variable>=<value> format
+    'qrpm' creates a RPM package from a qrpm.yml specification file. It aims at
+    packaging shell scripts or simple executables/libraries with minimum effort
 
-    -- VARIABLE=VALUE... [QRPM-FILE]
+    The qrpm.yml specification file is a YAML file. The simplest qrpm file
+    contains just one line:
 
-    -t,template=OFILE?
-      Generate a template qrpm.yml file in the current directory. Customize it
-      to create RPM packages of your project
+      $bindir: my_executable_script
+
+    Running qrpm using this file will yield a RPM package that installs the
+    script into the standard /usr/bin directory. The name of the package
+    is set to the name of the current directory and version to the latest tag
+    in git (which needs to be present). Other defaults are detailed below
+
+    VARIABLES 
+
+    The configuration file can define and use variables. They are defined by
+    key/value definitions and the value can refer to values of other
+    variables using $NAME or ${NAME}. Variables can also be given on the
+    command line in <variable>=<value> format
+
+    $(...) constructs are commands that are executed by bash(1). The parser
+    considers everything from the opening '$(' to the last ')' on the line as
+    part of the command so only one command is allowed. This restriction keeps
+    the parser simple, it may change in the future
+
+    INCLUDE FILES
+
+    The qrpm file can include other files that are searched for in a list of
+    directories. Relative paths are relative to the directory of the qrpm file
+    (but see the -C option). The search directories can be set on the command
+    line using the -I option
+
+    BUILT-IN VARIABLES
+
+    INSTALLATION DIRECTORIES
+
+    OPTIONS
+
+    -f,force
+      Create package even if repository is dirty. Normally qrpm checks if the
+      current directory is clean
+
+    -C,directory=EDIR
+      Change to directory before doing anything else but include the current
+      directory in the search path. This makes it possible to override parts of
+      a spec file
+
+    +I,include=EDIR
+      Include directory, later definitions are searched first
 
     -s,spec=OFILE?
       Only create the spec file and not the RPM package. Use this option to
@@ -39,65 +78,115 @@ begin
     -S,source
       Create a source RPM file instead of a regular RPM file
 
-    -f,force
-      Create package even if repository is dirty. Normally qrpm checks if the
-      current directory is a Git directory and then if there are no changed
-      files
+    -t,template=OFILE?
+      Generate a QRPM template. It is in YAML format with the extension that a
+      single '__END__' terminates the file immediately. The name of the file
+      defaults to 'qrpm.yml'. It is an error if the file exists
 
-    -C,directory=EDIR
-      Change to directory before doing anything else. Output files are still
-      created in the current directory, though
+    -T,force-template=OFILE?
+      Like --template but overwrites file if it exists
+
+    -b,builddir=NPATH?
+      Use the given path as the RPM build dir, default is 'builddir'. Doesn't
+      remove the directory afterwards. It it is an error if the directory exists
+
+    -B,force-builddir=PATH?
+      Like --builddir but overwrites the directory if it exists beforehand
 
     -d,dump
       Dump internal data and exit. For debug
   )
 
-  opts, args = ShellOpts.process(SPEC, ARGV, verbose: true)
+  opts, args = ShellOpts.process(SPEC, ARGV, verbose: true, quiet: true)
 
-  currdir = Dir.getwd
-  Dir.chdir(opts.directory) if opts.directory?
-
-  if opts.template?
-    outfile = opts.template || Qrpm::QRPM_CONFIG_FILE
+  if opts.template? || opts.force_template?
+    outfile = opts.template || opts.force_template || Qrpm::QRPM_CONFIG_FILE
+    opts.force_template? || !File.exists?(outfile) or ShellOpts.error "Won't overwrite existing file: #{outfile}"
     FileUtils::cp Qrpm::QRPM_CONFIG_FILE_TEMPLATE, outfile
+    puts "Generated #{outfile}" if !opts.quiet?
     exit
   end
 
-  # Collect var=val settings into the dict hash and sets the configuration file
-  # if present
-  dict = {}
+  # Process arguments. The overrides hash is constructed from var=val arguments
+  # on the command line
+  overrides = {}
+  file = nil
   while arg = args.extract(0..1)
     if arg =~ /^(.*?)=(.*)$/
-      dict[$1] = $2
-    else
+      overrides[$1] = $2
+    elsif file.nil?
       file = arg
-      break
+    else
+      args.expect(-1, "More than one file argument")
     end
   end
-  args.empty? or args.expect(0) # Generates an illegal-number-of-arguments error
+  args.expect(0)
+
+  # Compute/normalize currdir and qrpmdir and add them to the dictionary
+  currdir = overrides["currdir"] = File.expand_path(overrides["currdir"] || Dir.getwd)
+  qrpmdir = overrides["qrpmdir"] = File.expand_path(overrides["qrpmdir"] || opts.directory || ".")
+
+  # Compute builddir
+  if opts.builddir? && opts.force_builddir? 
+    ShellOpts.error "Can't use both --builddir and --force-builddir"
+  elsif opts.builddir? || opts.force_builddir? 
+    builddir = opts.builddir || opts.force_builddir || "builddir"
+    opts.force_builddir? || !File.exist?(builddir) or 
+        ShellOpts.error "Build directory 'builddir' exists - use -B to override"
+    builddir = File.expand_path(builddir)
+  else
+    builddir = nil
+  end
+
+  # Check if repository is clean
+  opts.force? || opts.dump? || `git status --porcelain | grep -v '??' 2>/dev/null` == "" or 
+      ShellOpts.error "Repository is dirty"
 
   # Check configuration file
   file ||= Qrpm::QRPM_CONFIG_FILE
-  ::File.exist?(file) or raise "Can't find '#{file}'"
+  ::File.exist?(file) or ShellOpts.error "Can't find '#{file}'"
+
+  # Create lexer
+  lexer = Qrpm::Lexer.new([currdir, qrpmdir].uniq, opts.include.reverse)
 
   # Load the qrpm configuration file
-  yaml = YAML.load(IO.read(file).sub(/^__END__\s*$/m, ""))
+  conf = lexer.lex(File.expand_path file)
+
+  # Change to qrpm directory
+  Dir.chdir(qrpmdir)
 
-  # Parse QRPM file
-  rpm = Qrpm::Parser.parse(dict, yaml)
+  # Parse QRPM configuration file. Include paths are still resolved with the
+  # context of the original directory while filesystem paths are relative to
+  # the source directory
+  compiler = Qrpm::Compiler.new(overrides)
+  qrpm = compiler.compile(conf)
+  rpm = qrpm.rpm
 
   if opts.dump?
-    rpm.dump
+    puts "Compiler"
+    indent { compiler.dump }
+
+    puts "Qrpm"
+    indent { qrpm.dump_parts }
+
+    puts "Rpm"
+    indent { rpm.dump }
+
     exit
   end
 
-  # Check if repository is clean
-  opts.force? || `git status --porcelain 2>/dev/null` == "" or raise "Repository is dirty"
-
+  # Create spec/srpm/rpm file
   target = (opts.spec? ? :spec : (opts.source? ? :srpm : :rpm))
-  rpm.build(target: target, file: opts.spec, verbose: opts.verbose?, destdir: currdir)
+  files = rpm.build(
+      target: target, 
+      file: opts.spec, 
+      verbose: opts.verbose?, 
+      destdir: currdir, 
+      builddir: builddir)
+
+  puts "Built #{files.map { |f| File.basename(f) }.join(" ")}" if !opts.quiet?
 
 rescue RuntimeError => ex
-  ShellOpts.error ex.message
+  ShellOpts.failure ex.message
 end