add ww-update script to call OPL-update and build-search-json.pl

Author: pstaabp

.gitignore

@@ -36,7 +36,6 @@ htdocs/themes/*
 DATA/*
 !DATA/uploads
 DATA/uploads/*
-!htdocs/DATA/search.json
 !*README*
 
 docker-compose.yml

bin/dev_scripts/build-search-json.pl bin/build-search-json.plbin/dev_scripts/build-search-json.pl renamed to bin/build-search-json.pl

@@ -49,21 +49,24 @@ =head1 DESCRIPTION
 # These are the default sample problem directory and JSON file.
 my $sample_prob_dir = "tutorial/sample-problems";
 my $json_file       = "htdocs/DATA/search.json";
-my $verbose         = 0;
+my ($verbose, $show_warnings)         = (1,0);
 
 GetOptions(
 	'p|pg-root=s'         => \$pg_root,
 	'f|json-file=s'       => \$json_file,
 	's|sample-prob-dir=s' => \$sample_prob_dir,
 	'b|build=s'           => \$build,
+	'w|show-warnings' => \$show_warnings,
 	'v|verbose+'          => \$verbose
 );
 
 die "The build options must be one of (all, macros, samples). The value $build is not valid."
 	if ((grep { $_ eq $build } qw/all macros samples/) != 1);
 
 my $ww_root = $ENV{WW_ROOT};
-$ww_root = Mojo::File->new(curfile->dirname, "..", "..")->realpath unless defined($ww_root);
+$ww_root = Mojo::File->curfile->dirname->dirname->realpath unless defined($ww_root);
+
+say $ww_root;
 
 die "ww_root: $ww_root is not a directory" unless -d $ww_root;
 
@@ -73,6 +76,7 @@ =head1 DESCRIPTION
 my $json_dir = $json_file->dirname;
 $json_dir->make_path unless -d $json_dir;
 
+
 if ($verbose) {
 	say "Running script build-search-data with the following options:";
 	say "    pg-root: $pg_root";
@@ -99,7 +103,7 @@ =head1 DESCRIPTION
 my @files;
 my $index = 1;    # set an index for each file.
 
-sub processFile {
+sub processPGfile {
 	return unless $_ =~ /\.pg$/;
 	say "Processing $_" if $verbose;
 	my $filename = $_;
@@ -192,11 +196,11 @@ sub extractPODNode {
 	my ($filename, $root, $title) = @_;
 	my @index = grep { ref($root->[$_]) eq 'ARRAY' && $root->[$_][2] =~ /$title/ } 0 .. scalar(@$root) - 1;
 	if (@index == 0) {
-		warn "In $filename: The section named $title is not found in the POD.";
+		warn "In $filename: The section named $title is not found in the POD." if $show_warnings;
 		return;
 	}
 	if (@index > 1) {
-		warn "In $filename: There are more than one section named $title in the POD.";
+		warn "In $filename: There are more than one section named $title in the POD." if $show_warnings;
 		return;
 	}
 	# start at index 2 and extract all text
@@ -225,9 +229,12 @@ sub parseHead2 {
 # process a macro file's POD
 sub processMacro {
 	return unless $_ =~ /\.pl$/;
-	say "Processing $_" if $verbose;
 	my $file = Mojo::File->new($File::Find::name);
-	return if $file->dirname =~ /deprecated/;
+	if ($file->dirname =~ /deprecated/){
+		say "Skipping $_.  This is deprecated." if $verbose;
+		return;
+	}
+	say "Processing $_" if $verbose;
 
 	my $parser      = Pod::Simple::SimpleTree->new();
 	my $root        = $parser->parse_file("$file")->root;
@@ -245,7 +252,7 @@ sub processMacro {
 }
 
 # Process the sample problems in $sample_prob_dir.
-find({ wanted => \&processFile }, "$sample_prob_dir") if (grep { $build eq $_ } qw/all samples/);
+find({ wanted => \&processPGfile }, "$sample_prob_dir") if (grep { $build eq $_ } qw/all samples/);
 
 # Process the POD within the macros dir.
 find({ wanted => \&processMacro }, "$pg_root/macros") if (grep { $build eq $_ } qw/all macros/);

bin/download-OPL-metadata-release.pl

@@ -80,8 +80,12 @@ BEGIN
 die "The directory $libraryDirectory does not exist or is not writable."
 	if (!-d $libraryDirectory || !-w $libraryDirectory);
 
+warn $ENV{OPL_GIT_REPOSITORY};
+
+my $git_repo = $ENV{OPL_GIT_REPOSITORY} // 'origin';
+
 # Checkout the release tag in the library clone if it hasn't already been done.
-`$ce->{externalPrograms}{git} -C $libraryDirectory fetch --tags origin`;
+`$ce->{externalPrograms}{git} -C $libraryDirectory fetch --tags $git_repo`;
 `$ce->{externalPrograms}{git} -C $libraryDirectory show-ref refs/heads/$releaseTag -q`;
 if ($?) {
 	say "Switching OPL clone in $libraryDirectory to new branch of release tag $releaseTag.";

bin/update-ww.pl

@@ -4,15 +4,67 @@ =head1 NAME
 
 update-ww.pl -- run all needed scripts when webwork is updated.
 
+=head1 SYNOPSIS
+
+update-ww.pl [options]
+
+ Options:
+   -a|--all                  Run both OPL-update and build-search-json.pl
+
+   -b|--build-sample-probs   Run the build-search-json.pl script with the 'all' flag.
+                             The other options are 'samples' and 'macros' if not all
+                             are desired.
+   -o|--opl-update           Run the OPL-update script.  By default the upload-opl-statistics
+                             part of the script is not run.  See the upload-opl-stats flags
+                             to change this.
+   -s|--sample-probs         Run the sample-probs part of the script.
+
+   -v|--verbose              Setting this flag provides details as the script runs.
+
 =cut
 
 use strict;
 use warnings;
 use feature 'say';
 
-use Mojo::File qw(curfile);
+use Mojo::File;
+use Getopt::Long qw(:config bundling);
+
+# BEGIN {
+# 	use Env        qw(WEBWORK_ROOT);
+# }
+
+my $ww_root = Mojo::File->curfile->dirname->dirname->realpath;
+
+my $build    = 'all';
+my $git_repo = 'origin';
+my $all      = 1;
+my ($verbose, $opl_update, $sample_probs, $upload_opl_stats) = (0, 0, 0, 0);
+
+GetOptions(
+	'a|all'                  => \$all,
+	'b|build-sample-probs=s' => \$build,
+	'o|opl-update'           => \$opl_update,
+	'g|git-opl-repository=s' => \$git_repo,
+	's|sample-probs'         => \$sample_probs,
+	'u|upload-opl-stats'     => \$upload_opl_stats,
+	'v|verbose+'             => \$verbose
+);
 
-my $ww_root = Mojo::File->new(curfile->dirname, "..")->realpath;
+my $v = $verbose ? '-v' : '';
+if ($all || $sample_probs) {
+	say 'Rebuilding the sample problem and macro POD file.';
+	my $search_output = `perl $ww_root/bin/build-search-json.pl $v -b $build`;
+	say $search_output if $verbose;
+}
 
-`perl $ww_root/bin/dev_scripts/build-search-json.pl -b all`;
+if ($all || $opl_update) {
+	say 'Running the OPL-update script.';
+	$ENV{SKIP_UPLOAD_OPL_STATISTICS} = 1 unless $upload_opl_stats;
+	$ENV{OPL_GIT_REPOSITORY}         = $git_repo;
+	say "Running the OPL upate script" if $verbose;
+	my $opl_output = `perl $ww_root/bin/OPL-update`;
+	say $opl_output if $verbose;
+}
 
+1;