From: Eric Wong <e@80x24.org>
To: meta@public-inbox.org
Subject: [PATCH 20/95] clone: support --dry-run / -n flag
Date: Mon, 28 Nov 2022 05:31:17 +0000 [thread overview]
Message-ID: <20221128053232.291618-21-e@80x24.org> (raw)
In-Reply-To: <20221128053232.291618-1-e@80x24.org>
It still makes HTTP(S) requests to retrieve the manifest or
scrape HTML, but doesn't make permanent changes to the FS
(aside from modifying {acm}time of ${TMPDIR-/tmp}).
---
Documentation/public-inbox-clone.pod | 6 +++++
lib/PublicInbox/LeiMirror.pm | 35 ++++++++++++++--------------
script/public-inbox-clone | 6 ++++-
t/www_listing.t | 6 +++++
4 files changed, 35 insertions(+), 18 deletions(-)
diff --git a/Documentation/public-inbox-clone.pod b/Documentation/public-inbox-clone.pod
index 7e95146e..178d952a 100644
--- a/Documentation/public-inbox-clone.pod
+++ b/Documentation/public-inbox-clone.pod
@@ -65,6 +65,12 @@ When cloning a top-level with multiple inboxes, ignore inboxes and
repositories matching the given wildcard pattern. Supports the same
wildcards as L</--include>
+=item -n
+
+=item --dry-run
+
+Show what would be done, without making any changes.
+
=item -q
=item --quiet
diff --git a/lib/PublicInbox/LeiMirror.pm b/lib/PublicInbox/LeiMirror.pm
index 5e1b1c64..d955ac3b 100644
--- a/lib/PublicInbox/LeiMirror.pm
+++ b/lib/PublicInbox/LeiMirror.pm
@@ -27,10 +27,10 @@ sub _wq_done_wait { # dwaitpid callback (via wq_eof)
my $f = "$mrr->{dst}/mirror.done";
if ($?) {
$lei->child_error($?);
- } elsif (!unlink($f)) {
+ } elsif (!$mrr->{dry_run} && !unlink($f)) {
warn("unlink($f): $!\n") unless $!{ENOENT};
} else {
- if ($lei->{cmd} ne 'public-inbox-clone') {
+ if (!$mrr->{dry_run} && $lei->{cmd} ne 'public-inbox-clone') {
# calls _finish_add_external
$lei->lazy_cb('add-external', '_finish_'
)->($lei, $mrr->{dst});
@@ -107,7 +107,8 @@ sub ft_rename ($$$) {
my @st = stat($dst);
my $mode = @st ? ($st[2] & 07777) : ($open_mode & ~umask);
chmod($mode, $ft) or croak "E: chmod $fn: $!";
- rename($fn, $dst) or croak "E: rename($fn => $ft): $!";
+ require File::Copy;
+ File::Copy::mv($fn, $dst) or croak "E: mv($fn => $ft): $!";
$ft->unlink_on_destroy(0);
}
@@ -123,10 +124,11 @@ sub _get_txt_start { # non-fatal
my $opt = { 0 => $lei->{0}, 1 => $lei->{1}, 2 => $lei->{2} };
my $cmd = $self->{curl}->for_uri($lei, $uri, qw(--compressed -R -o),
$ft->filename);
- $self->{"-get_txt.$endpoint"} = [ $ft, $cmd, $uri ];
my $jobs = $lei->{opt}->{jobs} // 1;
reap_live() while keys(%LIVE) >= $jobs;
$lei->qerr("# @$cmd");
+ return if $self->{dry_run};
+ $self->{"-get_txt.$endpoint"} = [ $ft, $cmd, $uri ];
$LIVE{spawn($cmd, undef, $opt)} =
[ \&_get_txt_done, $self, $endpoint, $fini ];
}
@@ -236,6 +238,7 @@ sub start_clone {
my $jobs = $self->{lei}->{opt}->{jobs} // 1;
reap_live() while keys(%LIVE) >= $jobs;
$self->{lei}->qerr("# @$cmd");
+ return if $self->{dry_run};
$LIVE{spawn($cmd, undef, $opt)} = [ \&reap_clone, $self, $cmd, $fini ];
}
@@ -339,6 +342,7 @@ sub reap_clone { # async, called via SIGCHLD
sub v1_done { # called via OnDestroy
my ($self) = @_;
+ return if $self->{dry_run};
_write_inbox_config($self);
my $dst = $self->{cur_dst} // $self->{dst};
if (defined(my $o = $self->{-ent} ? $self->{-ent}->{owner} : undef)) {
@@ -350,6 +354,7 @@ sub v1_done { # called via OnDestroy
sub v2_done { # called via OnDestroy
my ($self) = @_;
+ return if $self->{dry_run};
_write_inbox_config($self);
require PublicInbox::MultiGit;
my $dst = $self->{cur_dst} // $self->{dst};
@@ -413,7 +418,8 @@ failed to extract epoch number from $src
# filter out the epochs we skipped
$self->{-culled_manifest} = 1 if delete(@$m{@skip});
- -d $dst || File::Path::mkpath($dst);
+ (!$self->{dry_run} && !-d $dst) and File::Path::mkpath($dst);
+
require PublicInbox::Lock;
my $lk = bless { lock_path => "$dst/inbox.lock" }, 'PublicInbox::Lock';
my $fini = PublicInbox::OnDestroy->new($$, \&v2_done, $task);
@@ -421,7 +427,7 @@ failed to extract epoch number from $src
_get_txt_start($task, '_/text/config/raw', $fini);
_get_txt_start($self, 'description', $fini);
- $task->{-locked} = $lk->lock_for_scope($$);
+ $task->{-locked} = $lk->lock_for_scope($$) if !$self->{dry_run};
my @cmd = clone_cmd($lei, my $opt = {});
while (@src_edst && !$lei->{child_error}) {
my $cmd = [ @$pfx, @cmd, splice(@src_edst, 0, 2) ];
@@ -507,17 +513,12 @@ sub try_manifest {
my $path = $uri->path;
chop($path) eq '/' or die "BUG: $uri not canonicalized";
$uri->path($path . '/manifest.js.gz');
- my $pdir = $lei->rel2abs($self->{dst});
- $pdir =~ s!/[^/]+/?\z!!;
- -d $pdir || File::Path::mkpath($pdir);
- my $ft = File::Temp->new(TEMPLATE => 'm-XXXX',
- UNLINK => 1, DIR => $pdir, SUFFIX => '.tmp');
+ my $ft = File::Temp->new(TEMPLATE => '.manifest-XXXX',
+ UNLINK => 1, TMPDIR => 1, SUFFIX => '.tmp');
my $fn = $ft->filename;
- my ($bn) = ($fn =~ m!/([^/]+)\z!);
- my $cmd = $curl->for_uri($lei, $uri, '-R', '-o', $bn);
- my $opt = { -C => $pdir };
- $opt->{$_} = $lei->{$_} for (0..2);
- my $cerr = run_reap($lei, $cmd, $opt);
+ my $cmd = $curl->for_uri($lei, $uri, '-R', '-o', $fn);
+ my %opt = map { $_ => $lei->{$_} } (0..2);
+ my $cerr = run_reap($lei, $cmd, \%opt);
local %LIVE;
if ($cerr) {
return try_scrape($self) if ($cerr >> 8) == 22; # 404 missing
@@ -579,7 +580,7 @@ EOM
}
}
reap_live() while keys(%LIVE);
- return if $self->{lei}->{child_error};
+ return if $self->{lei}->{child_error} || $self->{dry_run};
if (delete $self->{-culled_manifest}) { # set by clone_v2/-I/--exclude
# write the smaller manifest if epochs were skipped so
diff --git a/script/public-inbox-clone b/script/public-inbox-clone
index ce4697f3..22ffc0fc 100755
--- a/script/public-inbox-clone
+++ b/script/public-inbox-clone
@@ -17,12 +17,13 @@ options:
--torsocks VAL whether or not to wrap git and curl commands with
torsocks (default: `auto')
Must be one of: `auto', `no' or `yes'
+ --dry-run | -n show what would be cloned without cloning
--verbose | -v increase verbosity (may be repeated)
--quiet | -q increase verbosity (may be repeated)
-C DIR chdir to specified directory
EOF
GetOptions($opt, qw(help|h quiet|q verbose|v+ C=s@ c=s@ include|I=s@ exclude=s@
- jobs|j=i no-torsocks torsocks=s epoch=s)) or die $help;
+ dry-run|n jobs|j=i no-torsocks torsocks=s epoch=s)) or die $help;
if ($opt->{help}) { print $help; exit };
require PublicInbox::Admin; # loads Config
PublicInbox::Admin::do_chdir(delete $opt->{C});
@@ -54,6 +55,9 @@ my $mrr = bless {
src => $url,
dst => $dst,
}, 'PublicInbox::LeiMirror';
+
+$? = 0;
+$mrr->{dry_run} = 1 if $lei->{opt}->{'dry-run'};
$mrr->do_mirror;
$mrr->can('_wq_done_wait')->([$mrr, $lei], $$);
exit(($lei->{child_error} // 0) >> 8);
diff --git a/t/www_listing.t b/t/www_listing.t
index c13d8f90..45287c7d 100644
--- a/t/www_listing.t
+++ b/t/www_listing.t
@@ -153,6 +153,12 @@ EOM
is(xqx([qw(git config -f), "$tmpdir/incl/alt/config", 'gitweb.owner']),
"lorelei \xc4\x80\n", 'gitweb.owner set by -clone');
+ $clone_err = '';
+ ok(run_script(['-clone', '--dry-run',
+ "http://$host:$port/pfx", "$tmpdir/dry-run" ],
+ undef, $opt), 'clone --dry-run') or diag "clone_err=$clone_err";
+ ok(!-d "$tmpdir/dry-run", 'nothing cloned with --dry-run');
+
undef $td;
open $mh, '<', "$tmpdir/incl/manifest.js.gz" or xbail "open: $!";
next prev parent reply other threads:[~2022-11-28 5:32 UTC|newest]
Thread overview: 96+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-11-28 5:30 [PATCH 00/95] clone: multi-inbox/repo support Eric Wong
2022-11-28 5:30 ` [PATCH 01/95] clone: support multi-inbox clone Eric Wong
2022-11-28 5:30 ` [PATCH 02/95] clone: support --include and --exclude with multi-clone Eric Wong
2022-11-28 5:31 ` [PATCH 03/95] clone: parallelize v2 epoch clones Eric Wong
2022-11-28 5:31 ` [PATCH 04/95] lei_mirror: async config retrieval for v2 w/ manifest Eric Wong
2022-11-28 5:31 ` [PATCH 05/95] lei_mirror: rely on DESTROY to index v2 inbox Eric Wong
2022-11-28 5:31 ` [PATCH 06/95] lei_mirror: rely on global process reaper Eric Wong
2022-11-28 5:31 ` [PATCH 07/95] clone: support parallel v1 clones Eric Wong
2022-11-28 5:31 ` [PATCH 08/95] lei_mirror: default to single job by default Eric Wong
2022-11-28 5:31 ` [PATCH 09/95] lei_mirror: move directory creation to v2-only path Eric Wong
2022-11-28 5:31 ` [PATCH 10/95] lei_mirror: retrieve description text asynchronously, too Eric Wong
2022-11-28 5:31 ` [PATCH 11/95] switch inotify/kevent stuff to v5.12 Eric Wong
2022-11-28 5:31 ` [PATCH 12/95] manifest: update module blurb + v5.12 Eric Wong
2022-11-28 5:31 ` [PATCH 13/95] lei_mirror: simplify _get_txt_start callers Eric Wong
2022-11-28 5:31 ` [PATCH 14/95] lei_mirror: elide description retrieval for v1|coderepo Eric Wong
2022-11-28 5:31 ` [PATCH 15/95] lei_mirror: add a hint for skipped epoch permissions Eric Wong
2022-11-28 5:31 ` [PATCH 16/95] lei_mirror: consolidate clone process management Eric Wong
2022-11-28 5:31 ` [PATCH 17/95] lei_mirror: load File::Path unconditionally Eric Wong
2022-11-28 5:31 ` [PATCH 18/95] lei_mirror: load most modules up-front Eric Wong
2022-11-28 5:31 ` [PATCH 19/95] lei_mirror: set gitweb.owner from manifest Eric Wong
2022-11-28 5:31 ` Eric Wong [this message]
2022-11-28 5:31 ` [PATCH 21/95] lei_mirror: initialize placeholders with "head" " Eric Wong
2022-11-28 5:31 ` [PATCH 22/95] lei_mirror: support {reference} for v1 manifest clones Eric Wong
2022-11-28 5:31 ` [PATCH 23/95] lei_mirror: reduce noise on interrupted clones Eric Wong
2022-11-28 5:31 ` [PATCH 24/95] clone: support --inbox-config option Eric Wong
2022-11-28 5:31 ` [PATCH 25/95] lei_mirror: retrieve v2 description properly Eric Wong
2022-11-28 5:31 ` [PATCH 26/95] lei_mirror: reduce scope of v2 lock Eric Wong
2022-11-28 5:31 ` [PATCH 27/95] lei_mirror: allow --epoch on mixed v1/v2 clones Eric Wong
2022-11-28 5:31 ` [PATCH 28/95] lei_mirror: fix infinite loop in dependency resolution Eric Wong
2022-11-28 5:31 ` [PATCH 29/95] lei_mirror: defend against infinite loops Eric Wong
2022-11-28 5:31 ` [PATCH 30/95] lei_mirror: do not fetch descriptions if using manifest Eric Wong
2022-11-28 5:31 ` [PATCH 31/95] lei_mirror: require PublicInbox::Lock at use Eric Wong
2022-11-28 5:31 ` [PATCH 32/95] lei_mirror: fix glob semantics to match end-of-path Eric Wong
2022-11-28 5:31 ` [PATCH 33/95] lei_mirror: differentiate -entv vs -ent Eric Wong
2022-11-28 5:31 ` [PATCH 34/95] lei_mirror: support manifest {references} for v2 epochs Eric Wong
2022-11-28 5:31 ` [PATCH 35/95] lei_mirror: simplify v2 code paths Eric Wong
2022-11-28 5:31 ` [PATCH 36/95] clone: support --inbox-version Eric Wong
2022-11-28 5:31 ` [PATCH 37/95] lei_mirror: require Perl v5.12+ Eric Wong
2022-11-28 5:31 ` [PATCH 38/95] lei_mirror: ensure curl exits 22 on HTTP 404 responses Eric Wong
2022-11-28 5:31 ` [PATCH 39/95] lei_mirror: cleanup File::Temp OO usage Eric Wong
2022-11-28 5:31 ` [PATCH 40/95] lei_mirror: add `index' target to generated Makefile Eric Wong
2022-11-28 5:31 ` [PATCH 41/95] lei_mirror: do not write Makefile for --inbox-config=never Eric Wong
2022-11-28 5:31 ` [PATCH 42/95] lei_mirror: hoist out dump_manifest sub Eric Wong
2022-11-28 5:31 ` [PATCH 43/95] lei_mirror: avoid convoluted lazy_cb usage Eric Wong
2022-11-28 5:31 ` [PATCH 44/95] lei_mirror: simplify clone_v2_prep Eric Wong
2022-11-28 5:31 ` [PATCH 45/95] lei_mirror: support --objstore and forkgroups Eric Wong
2022-11-28 5:31 ` [PATCH 46/95] lei_mirror: cleanup process reaping logic Eric Wong
2022-11-28 5:31 ` [PATCH 47/95] lei_mirror: ensure git <1.8.5 fallback can use torsocks Eric Wong
2022-11-28 5:31 ` [PATCH 48/95] clone: flesh out --objstore behavior and document Eric Wong
2022-11-28 5:31 ` [PATCH 49/95] lei_mirror: always pack refs for coderepos Eric Wong
2022-11-28 5:31 ` [PATCH 50/95] lei_mirror: set description for non-inboxes, too Eric Wong
2022-11-28 5:31 ` [PATCH 51/95] lei_mirror: force --no-tags when fetching forkgroups Eric Wong
2022-11-28 5:31 ` [PATCH 52/95] lei_mirror: preserve permissions of existing alternates file Eric Wong
2022-11-28 5:31 ` [PATCH 53/95] lei_mirror: do not show ref updates w/o --verbose Eric Wong
2022-11-28 5:31 ` [PATCH 54/95] lei_mirror: drop git <1.8.5 support Eric Wong
2022-11-28 5:31 ` [PATCH 55/95] lei_mirror: make basename more descriptive Eric Wong
2022-11-28 5:31 ` [PATCH 56/95] lei_mirror: fix --dry-run for forkgroups Eric Wong
2022-11-28 5:31 ` [PATCH 57/95] lei_mirror: forkgroups use `git fetch --multiple' Eric Wong
2022-11-28 5:31 ` [PATCH 58/95] clone: move --dry-run handling to lei_mirror Eric Wong
2022-11-28 5:31 ` [PATCH 59/95] clone: drop unnecessary requires Eric Wong
2022-11-28 5:31 ` [PATCH 60/95] clone: use v5.12 Eric Wong
2022-11-28 5:31 ` [PATCH 61/95] clone: require `--objstore=' for default location Eric Wong
2022-11-28 5:31 ` [PATCH 62/95] lei_mirror: shorten remote names Eric Wong
2022-11-28 5:32 ` [PATCH 63/95] fetch: use v5.12 Eric Wong
2022-11-28 5:32 ` [PATCH 64/95] fetch: eliminate File::Temp->filename var Eric Wong
2022-11-28 5:32 ` [PATCH 65/95] lei_mirror: properly pack-refs in non-forkgroup repos Eric Wong
2022-11-28 5:32 ` [PATCH 66/95] lei_mirror: show child error error code Eric Wong
2022-11-28 5:32 ` [PATCH 67/95] on_destroy: support ->cancel callback Eric Wong
2022-11-28 5:32 ` [PATCH 68/95] lei_mirror: support resuming multi-repo clones Eric Wong
2022-11-28 5:32 ` [PATCH 69/95] lei_mirror: check fingerprints before fetching Eric Wong
2022-11-28 5:32 ` [PATCH 70/95] clone: support loading manifest.js.gz from destination Eric Wong
2022-11-28 5:32 ` [PATCH 71/95] lei_mirror: delay configuring forkgroups Eric Wong
2022-11-28 5:32 ` [PATCH 72/95] clone: canonicalize destination path from CLI Eric Wong
2022-11-28 5:32 ` [PATCH 73/95] clone|fetch: support passing --prune(-tags) to `git fetch' Eric Wong
2022-11-28 5:32 ` [PATCH 74/95] lei_mirror: avoid needless FD passing Eric Wong
2022-11-28 5:32 ` [PATCH 75/95] clone: support --keep-going/-k like make(1) Eric Wong
2022-11-28 5:32 ` [PATCH 76/95] lei_mirror: don't warn on missing manifest on initial clone Eric Wong
2022-11-28 5:32 ` [PATCH 77/95] lei_mirror: respect `./' and `../' prefixes for CLI args Eric Wong
2022-11-28 5:32 ` [PATCH 78/95] lei_mirror: --manifest= affects destination, too Eric Wong
2022-11-28 5:32 ` [PATCH 79/95] lei_mirror: update fingerprints when writing local manifest.js.gz Eric Wong
2022-11-28 5:32 ` [PATCH 80/95] lei_mirror: remove janky mirror.done stamp file Eric Wong
2022-11-28 5:32 ` [PATCH 81/95] lei_mirror: simplify most process spawning Eric Wong
2022-11-28 5:32 ` [PATCH 82/95] lei_mirror: run v1_done earlier on forkgroup done Eric Wong
2022-11-28 5:32 ` [PATCH 83/95] lei_mirror: simplify forkgroup-related subs Eric Wong
2022-11-28 5:32 ` [PATCH 84/95] lei_mirror: shorten scope mirror objects Eric Wong
2022-11-28 5:32 ` [PATCH 85/95] lei_mirror: set {head} from manifest Eric Wong
2022-11-28 5:32 ` [PATCH 86/95] lei_mirror: support {symlinks} " Eric Wong
2022-11-28 5:32 ` [PATCH 87/95] lei_mirror: eliminate circular references Eric Wong
2022-11-28 5:32 ` [PATCH 88/95] lei_mirror: use curl -z/--timecond if manifest exists Eric Wong
2022-11-28 5:32 ` [PATCH 89/95] lei_mirror: avoid redundant curl `-f' use Eric Wong
2022-11-28 5:32 ` [PATCH 90/95] lei_mirror: omit trailing slash for git remote.*.url Eric Wong
2022-11-28 5:32 ` [PATCH 91/95] lei_mirror: set info/web/last-modified from manifest Eric Wong
2022-11-28 5:32 ` [PATCH 92/95] lei_mirror: don't clobber inbox.config.example if it exists Eric Wong
2022-11-28 5:32 ` [PATCH 93/95] lei_mirror: break out of fgrp fetch iteration early Eric Wong
2022-11-28 5:32 ` [PATCH 94/95] clone: support --project-list= for cgit Eric Wong
2022-11-28 5:32 ` [PATCH 95/95] lei_mirror: handle forkgroup changes Eric Wong
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://public-inbox.org/README
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20221128053232.291618-21-e@80x24.org \
--to=e@80x24.org \
--cc=meta@public-inbox.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/public-inbox.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).