-
Notifications
You must be signed in to change notification settings - Fork 1
/
metadata.sh
1195 lines (1082 loc) · 40.8 KB
/
metadata.sh
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#
# Subroutines for management of "floxmeta" environment metadata repo.
#
# This module provides functions to manage the user's environment metadata
# repository in conjunction with the generational links pointing to the flox
# environment packages in the store.
#
# The profile metadata repository contains copies of all source files required
# to create each generation in a subdirectory corresponding with the generation
# number. This includes a flake.{nix,lock} pair which enables the directory to
# be built as a standalone package if desired.
#
# There is one metadata repository per user and each profile is represented
# as a separate branch. See https://github.com/flox/flox/issues/14.
#
# Example hierarchy (temporary during refactoring):
# .
# ├── limeytexan (x86_64-linux.default branch)
# │ ├── 1
# │ │ ├── manifest.toml
# │ │ └── manifest.json
# │ └── metadata.json
# ├── limeytexan (x86_64-linux.toolbox branch)
# │ ├── 1
# │ │ ├── manifest.toml
# │ │ └── manifest.json
# │ ├── 2
# │ │ ├── manifest.toml
# │ │ └── manifest.json
# │ └── metadata.json
# └── tomberek (aarch64-darwin.default branch)
# ├── 1
# │ ├── manifest.toml
# │ └── manifest.json
# ├── 2
# │ ├── manifest.toml
# │ └── manifest.json
# ├── 3
# │ ├── manifest.toml
# │ └── manifest.json
# └── metadata.json
# Example hierarchy (unification):
# .
# ├── limeytexan (x86_64-linux.default branch)
# │ ├── 1
# │ │ ├── flake.lock
# │ │ ├── flake.nix
# │ │ └── pkgs
# │ │ └── default
# │ │ ├── catalog.json
# │ │ └── flox.nix
# │ └── metadata.json
# ├── limeytexan (x86_64-linux.toolbox branch)
# │ ├── 1
# │ │ ├── flake.lock
# │ │ ├── flake.nix
# │ │ └── pkgs
# │ │ └── default
# │ │ ├── catalog.json
# │ │ └── flox.nix
# │ ├── 2
# │ │ ├── flake.lock
# │ │ ├── flake.nix
# │ │ └── pkgs
# │ │ └── default
# │ │ ├── catalog.json
# │ │ └── flox.nix
# │ └── metadata.json
# └── tomberek (aarch64-darwin.default branch)
# ├── 1
# │ ├── flake.lock
# │ ├── flake.nix
# │ └── pkgs
# │ └── default
# │ ├── catalog.json
# │ └── flox.nix
# ├── 2
# │ ├── flake.lock
# │ ├── flake.nix
# │ └── pkgs
# │ └── default
# │ ├── catalog.json
# │ └── flox.nix
# ├── 3
# │ ├── flake.lock
# │ ├── flake.nix
# │ └── pkgs
# │ └── default
# │ ├── catalog.json
# │ └── flox.nix
# └── metadata.json
#
# "Public" functions exposed by this module:
#
# * syncEnvironment(): reconciles/updates profile data from metadata repository
# * pullMetadata(): pulls metadata updates from upstream to local cache
# * pushMetadata(): pushes metadata updates from local cache to upstream
# * metaGit(): provides access to git commands for metadata repo
# * metaGitShow(): used to print file contents without checking out branch
#
# Many git conventions employed here are borrowed from Nix's own
# src/libfetchers/git.cc file.
#
snipline="------------------------ >8 ------------------------"
declare protoManifestToml
protoManifestToml=$($_cat <<EOF
# This is a prototype profile declarative manifest in TOML format,
# supporting comments and the ability to invoke "shellHook" commands
# upon profile activation. See the flox(1) man page for more details.
# [environment]
# LANG = "en_US.UTF-8"
# LC_ALL = "\$LANG"
#
# [aliases]
# gg = "git grep"
#
# [hooks]
# sayhi = """
# echo "Supercharged by flox!" 1>&2
# """
#
# Edit below the "--- >8 ---" delimiter to define the list of packages to
# be installed, but note that comments and the ordering of packages will
# *not* be preserved with updates.
# $snipline
EOF
)
#
# gitInitFloxmeta($repoDir,$defaultBranch)
#
declare defaultBranch="floxmain"
function gitInitFloxmeta() {
trace "$@"
local repoDir="$1"; shift
# Set initial branch with `-c init.defaultBranch=` instead of
# `--initial-branch=` to stay compatible with old version of
# git, which will ignore unrecognized `-c` options.
$invoke_git -c init.defaultBranch="${defaultBranch}" init --quiet "$repoDir"
$invoke_git -C "$repoDir" config pull.rebase true
$invoke_git -C "$repoDir" config receive.denyCurrentBranch updateInstead
# A commit is needed in order to make the branch visible.
$invoke_git -C "$repoDir" commit --quiet --allow-empty \
-m "$USER created repository"
}
# XXX TEMPORARY function to convert old-style "1.json" -> "1/manifest.json"
# **Delete after 20221215**
function temporaryAssert007Schema {
trace "$@"
local repoDir="$1"; shift
# Use the presence of manifest.toml in the top directory as
# an indication that the repository has NOT been converted.
[ -e "$repoDir/manifest.toml" ] || return 0
# Prompt user to confirm they want to change the format.
warn "floxmeta repository ($repoDir) using deprecated (<=0.0.6) format."
$invoke_gum confirm "Convert to latest (>=0.0.7) format?"
# Rename/move each file.
for file in $($_git -C "$repoDir" ls-files); do
case "$file" in
[0-9]*.json)
local gen
gen=$($_basename "$file" .json)
$invoke_mkdir -p "$repoDir/${gen}"
$invoke_git -C "$repoDir" mv "$file" "${gen}/manifest.json"
# Constructing the manifest.toml is not as straightforward.
# The pre-0.0.7 format didn't include a generation-specific
# manifest.toml, but rather forced you to go back to a previous
# git commit to find the corresponding version. Worse than that,
# when doing rollbacks and other generation flips the top half
# of the manifest.toml didn't change, which was arguably wrong
# (although appreciated as a feature by some).
#
# To create the old generation-specific manifest start by
# including everything up to the snipline.
$invoke_git -C "$repoDir" show "HEAD:manifest.toml" | \
$_awk "{if (/$snipline/) {exit} else {print}}" > "$repoDir/$gen/manifest.toml"
# Then use the current generation's manifest.json to create
# the rest.
echo "# $snipline" >> "$repoDir/$gen/manifest.toml"
manifest "$repoDir/$gen/manifest.json" listEnvironmentTOML >> "$repoDir/$gen/manifest.toml"
$invoke_git -C "$repoDir" add "$gen/manifest.toml"
;;
manifest.json)
$invoke_git -C "$repoDir" rm "$file" ;;
manifest.toml)
$invoke_git -C "$repoDir" rm "$file" ;;
metadata.json)
: leave intact ;;
*)
error "unknown file \"$file\" in $repoDir repository" < /dev/null
;;
esac
done
# Commit, reading commit message from STDIN.
$invoke_git -C "$repoDir" commit \
--quiet -m "$USER converted to 0.0.7 floxmeta schema"
$invoke_git -C $repoDir push --quiet
warn "Conversion complete. Please re-run command."
exit 0
}
# /XXX
# XXX TEMPORARY function to convert nix-profile-style "1/manifest.toml" -> "1/pkgs/default/flox.nix"
# **Delete after 20230222**
function temporaryAssert008Schema {
trace "$@"
local environment="$1"; shift
local repoDir="$1"; shift
# set $branchName,$floxNixDir,$environment{Name,Alias,Owner,System,BaseDir,BinDir,ParentDir,MetaDir}
eval $(decodeEnvironment "$environment")
local currentGen
currentGen=$($_readlink $workDir/current || :)
local nextGen
nextGen=$($_readlink $workDir/next)
local currentGenDir="$repoDir/$currentGen"
local nextGenDir="$repoDir/$nextGen"
# Use the presence of manifest.toml in the current generation as
# an indication that the repository has NOT been converted.
[ -e "$currentGenDir/manifest.toml" ] || return 0
# Prompt user to confirm they want to change the format.
warn "floxmeta repository ($currentGenDir) using deprecated (<=0.0.7) format."
$invoke_gum confirm "Convert to latest (>=0.0.8) format?"
# Copy the template flox environment into the next generation.
# Files in the Nix store are read-only.
$_cp --no-preserve=mode -rT $_lib/templateFloxEnv $nextGenDir
# otherwise Nix build won't be able to find any of the files
$_git -C $workDir add $nextGen
# Use nix-editor to transfer packages from the current manifest.json file.
local tmpScript
tmpScript=$(mkTempFile)
manifest $currentGenDir/manifest.json convert007to008 $_nix_editor $nextGenDir/pkgs/default/flox.nix > $tmpScript
# Similarly use nix-editor to transfer aliases and env vars from manifest.toml.
# jq outputs something like 'value'. Arguments to nix-editor have to be double quoted, so wrap with
# '"', resulting in '"''value''"'
$invoke_dasel -w json -f $currentGenDir/manifest.toml | \
$invoke_jq -r --arg dq "'\"'" --arg nixEditor $_nix_editor --arg file $nextGenDir/pkgs/default/flox.nix \
'(.aliases//{}) | to_entries | map(($dq+(.value|@sh)+$dq) as $quotedValue | "\($nixEditor) -i \($file) shell.aliases.\(.key) -v \($quotedValue)")[]' >> $tmpScript
$invoke_dasel -w json -f $currentGenDir/manifest.toml | \
$invoke_jq -r --arg dq "'\"'" --arg nixEditor $_nix_editor --arg file $nextGenDir/pkgs/default/flox.nix \
'(.environment//{}) | to_entries | map(($dq+(.value|@sh)+$dq) as $quotedValue | "\($nixEditor) -i \($file) environmentVariables.\(.key) -v \($quotedValue)")[]' >> $tmpScript
if [ $verbose -gt 0 ]; then
( set -x && source $tmpScript )
else
source $tmpScript
fi
# Hooks are different. Nix editor doesn't know how to poke those in-between '' blocks.
local hookScript
hookScript=$(mkTempFile)
local tmpFloxNix
tmpFloxNix=$(mkTempFile)
$invoke_dasel -w json -f $currentGenDir/manifest.toml | \
$invoke_jq -r '(.hooks//{}) | to_entries | map(.value | gsub("\n"; "; "))[]' > $hookScript
$invoke_awk "{print} /hook = / {system(\"cat $hookScript\")}" $nextGenDir/pkgs/default/flox.nix > $tmpFloxNix
$_mv -f $tmpFloxNix $nextGenDir/pkgs/default/flox.nix
$_git -C $repoDir add $nextGen/pkgs/default/flox.nix
local envPackage
if ! envPackage=$($invoke_nix build --impure --no-link --print-out-paths "$nextGenDir#.floxEnvs.$environmentSystem.default"); then
error "failed to install packages: ${pkgArgs[@]}" < /dev/null
fi
$_jq . --sort-keys $envPackage/catalog.json > $nextGenDir/pkgs/default/catalog.json
$_jq . --sort-keys $envPackage/manifest.json > $nextGenDir/manifest.json
$_git -C $repoDir add $nextGen/pkgs/default/catalog.json
$_git -C $repoDir add $nextGen/manifest.json
local resultCommitTransaction
result=$(commitTransaction $environment $repoDir $envPackage \
"$USER converted to 0.0.8 floxmeta schema" 2 \
"$me automatic conversion")
warn "Conversion complete. Please re-run command."
exit 0
}
# /XXX
# XXX TEMPORARY function to rename "$name{,-*-link}" -> "$system.$name{,-*-link}"
# **Delete after 20230222**
function temporaryAssert009LinkLayout() {
trace "$@"
local environment="$1"; shift
# set $branchName,$floxNixDir,$environment{Name,Alias,Owner,System,BaseDir,BinDir,ParentDir,MetaDir}
eval $(decodeEnvironment "$environment")
# The alias is either "owner/name" or "name" based on the owner, so
# we can't use that. Instead construct our own fully-qualified
# name by removing the system from environmentName.
local environmentBasename="${environmentName/$environmentSystem\./}"
for i in ${environmentParentDir}/${environmentBasename} ${environmentParentDir}/${environmentBasename}-*-link; do
if [ -L "$i" ]; then
local x
x=$($_readlink "$i")
case "$x" in
$environmentSystem.$environmentBasename*)
# Already renamed, all good.
: ;;
$environmentBasename-*-link|/nix/store/*)
# Old link - rename and leave forwarding link in its place.
local y="${environmentSystem}.$($_basename $i)"
if [ -L "${environmentParentDir}/$y" ]; then
$_rm "$i"
else
$_mv "$i" "${environmentParentDir}/$y"
fi
$_ln -s "$y" "$i"
;;
*)
warn "cruft detected - please remove: '$i'"
;;
esac
fi
done
}
# /XXX
#
# gitCheckout($repoDir,$branch)
#
function gitCheckout() {
trace "$@"
local repoDir="$1"; shift
local branch="$1"; shift
[ -d "$repoDir" ] || gitInitFloxmeta "$repoDir"
# Confirm or checkout the desired branch.
local currentBranch=
if [ -d "$repoDir" ]; then
currentBranch=$($_git -C "$repoDir" branch --show-current)
fi
[ "$currentBranch" = "$branch" ] || {
if $_git -C "$repoDir" show-ref --quiet refs/heads/"$branch"; then
$_git -C "$repoDir" checkout --quiet "$branch"
else
$_git -C "$repoDir" checkout --quiet --orphan "$branch"
$_git -C "$repoDir" ls-files | $_xargs --no-run-if-empty $_git -C "$repoDir" rm --quiet -f
# A commit is needed in order to make the branch visible.
$_git -C "$repoDir" commit --quiet --allow-empty \
-m "$USER created profile"
fi
}
}
# githubHelperGit()
#
# Invokes git in provided directory with github helper configured.
function githubHelperGit() {
trace "$@"
# For github.com specifically, set authentication helper.
$invoke_git \
-c "credential.https://github.com.helper=!$_gh auth git-credential" "$@"
}
function metaGit() {
trace "$@"
local environment="$1"; shift
# set $branchName,$floxNixDir,$environment{Name,Alias,Owner,System,BaseDir,BinDir,ParentDir,MetaDir}
eval $(decodeEnvironment "$environment")
# First verify that the clone is not out of date and check
# out requested branch.
gitCheckout "$environmentMetaDir" "$branchName"
githubHelperGit -C "$environmentMetaDir" "$@"
}
# Performs a 'git show branch:file' for the purpose of fishing
# out a file revision without checking out the branch.
function metaGitShow() {
trace "$@"
local environment="$1"; shift
local filename="$1"; shift
# set $branchName,$floxNixDir,$environment{Name,Alias,Owner,System,BaseDir,BinDir,ParentDir,MetaDir}
eval $(decodeEnvironment "$environment")
# First assert the relevant branch exists.
if $_git -C "$environmentMetaDir" show-ref --quiet refs/heads/"$branchName"; then
$invoke_git -C "$environmentMetaDir" show "${branchName}:${filename}"
else
error "environment '$environmentOwner/$environmentName' not found for system '$environmentSystem'" < /dev/null
fi
}
#
# syncEnvironment($environment)
#
function syncEnvironment() {
trace "$@"
local environment="$1"; shift
# set $branchName,$floxNixDir,$environment{Name,Alias,Owner,System,BaseDir,BinDir,ParentDir,MetaDir}
eval $(decodeEnvironment "$environment")
local environmentRealDir
environmentRealDir=$($_readlink -f $environmentParentDir)
# Create shared clone for performing work.
local workDir
workDir=$(mkTempDir)
beginTransaction "$environment" "$workDir" 0
# Run snippet to generate links using data from metadata repo.
$_mkdir -v -p "$environmentRealDir" 2>&1 | $_sed -e "s/[^:]*:/${me}:/"
# Invoking the following autogenerated code snippet will:
# 1. build all the packages in a [nix] profile
# 2. build the [nix] profile package itself
# 3. create the GCroot symlinks and top generational symlink
local snippet
snippet=$(environmentRegistry "$workDir" "$environment" syncGenerations)
eval "$snippet" || true
# FIXME REFACTOR based on detecting actual change.
[ -z "$_cline" ] || metaGit "$environment" add "metadata.json"
}
function commitMessage() {
trace "$@"
local environment="$1"; shift
local -i startGen=$1; shift
local -i endGen=$1; shift
local logMessage="$1"; shift
local invocation="${@}"
# set $branchName,$floxNixDir,$environment{Name,Alias,Owner,System,BaseDir,BinDir,ParentDir,MetaDir}
eval $(decodeEnvironment "$environment")
#
# Now we'd like to include a "diff" of the closures for the log.
# Nix has rich functionality in this regard but with awkward usage:
#
# 1. `nix store diff-closures` has the right usage semantics because
# it allows you to specify two profile paths, but it reports more
# detail than we're looking for.
# 2. `nix profile history` gives us the information we're looking for
# but expects a linear progression of generations only and won't
# report differences between arbitrary generations. It also embeds
# color characters in the output and doesn't honor the (mandatory)
# `--no-colors` flag. And ... it gives flake references that we
# need to convert back to floxpkgs package names.
#
# ... so, we mock up a tmpDir with the qualities of #2 above.
# Not fun but better than nothing.
#
local tmpDir
tmpDir=$(mkTempDir)
# `nix profile history` requires generations to be in sequential
# order, so for the purpose of this invocation we set the generations
# as 1 and 2 if both are defined, or 1 if there is only one generation.
local myEndGen=
if [ $startGen -gt 0 ]; then
local startGenPath
startGenPath=$($_readlink "${environment}-${startGen}-link")
if [ -n "$startGenPath" ]; then
$invoke_ln -s $startGenPath $tmpDir/${environmentName}-1-link
myEndGen=2
else
warn "generation link not found: ${environment}-${startGen}-link"
myEndGen=1
fi
else
myEndGen=1
fi
$invoke_ln -s $($_readlink "${environment}-${endGen}-link") $tmpDir/${environmentName}-${myEndGen}-link
$invoke_ln -s ${environmentName}-${myEndGen}-link $tmpDir/${environmentName}
local _cline
$_nix profile history --profile $tmpDir/${environmentName} | $_ansifilter --text | \
$_awk '\
BEGIN {p=0} \
/^ flake:/ {if (p==1) {print $0}} \
/^Version '${myEndGen}' / {p=1}' | \
while read _cline
do
local flakeref
flakeref=$(echo "$_cline" | $_cut -d: -f1,2)
local detail
detail=$(echo "$_cline" | $_cut -d: -f3-)
local floxpkg
floxpkg=$(manifest $environment/manifest.json flakerefToFloxpkg "$flakeref")
echo " ${floxpkg}:${detail}"
done > $tmpDir/commitMessageBody
if [[ "$logMessage" =~ " upgraded "$ ]]; then
# When doing an upgrade of everything we don't know what we're
# upgrading until after its finished. Take this opportunity to
# replace that message.
logMessage="${logMessage}$($_cut -d: -f1 $tmpDir/commitMessageBody | $_xargs)"
fi
# Actually print log message out to STDOUT.
cat <<EOF
$logMessage
${invocation[@]}
EOF
$_cat $tmpDir/commitMessageBody
# Clean up.
$_rm -f \
$tmpDir/"${environmentName}-1-link" \
$tmpDir/"${environmentName}-2-link" \
$tmpDir/"${environmentName}" \
$tmpDir/commitMessageBody
$_rmdir $tmpDir
}
function checkGhAuth {
trace "$@"
local hostname="$1"; shift
# Repeat login attempts until we're successfully logged in.
while ! $_gh auth status -h $hostname >/dev/null 2>&1; do
initialGreeting
warn "Invoking 'gh auth login -h $hostname'"
$_gh auth login -h $hostname
info ""
done
}
function getUsernameFromGhAuth {
trace "$@"
local hostname="$1"; shift
# Get github username from gh data, if known.
[ -s "$XDG_CONFIG_HOME/gh/hosts.yml" ]
$_dasel -f "$XDG_CONFIG_HOME/gh/hosts.yml" "${hostname//./\\.}.user"
}
#
# promptMetaOrigin()
#
# Guides user through the process of prompting for and/or creating
# an origin for their floxmeta repository.
#
function promptMetaOrigin() {
trace "$@"
local server organization defaultOrigin origin
echo 1>&2
echo "flox uses git to store and exchange metadata between users and machines." 1>&2
server=$(
multChoice "Where would you like to host your 'floxmeta' repository?" \
"git server" "github.com" "gitlab.com" "bitbucket.org" "other"
)
case "$server" in
github.com)
echo "Great, let's start by getting you logged into $server." 1>&2
# For github.com only, use the `gh` CLI to make things easy.
checkGhAuth $server
if organization=$(getUsernameFromGhAuth $server); then
echo "Success! You are logged into $server as $organization." 1>&2
else
echo "Hmmm ... could not log you into $server. No problem, we can find another way." 1>&2
fi
;;
other)
read -e -p "git server for storing profile metadata: " server
;;
esac
[ -n "$organization" ] ||
read -e -p "organization (or username) on $server for creating the 'floxmeta' repository: " organization
local protocol
protocol=$(
multChoice "What is your preferred protocol for Git operations?" \
"protocol" "https" "ssh+git"
)
case "$protocol" in
https)
defaultURL="https://$server/"
;;
ssh+git)
defaultURL="git+ssh://git@$server/"
;;
esac
echo "$defaultURL$organization/floxmeta"
}
#
# rewriteURLs()
#
# Function to inspect the entirety of a floxmeta repository and rewrite
# any/all URLs that reference the local disk to instead point to the new
# git remote home.
#
function rewriteURLs() {
trace "$@"
# TODO once we've finalised the self-referential TOML->environment renderer.
# Manifests won't contain any references to the floxmeta repository until then.
return 0
}
#
# getSetOrigin($environment)
#
function getSetOrigin() {
trace "$@"
local environment="$1"; shift
# set $branchName,$floxNixDir,$environment{Name,Alias,Owner,System,BaseDir,BinDir,ParentDir,MetaDir}
eval $(decodeEnvironment "$environment")
# Check to see if the origin is already set.
local origin
origin=$([ -d "$environmentMetaDir" ] && $_git -C "$environmentMetaDir" \
"config" "--get" "remote.origin.url" || true)
if [ -z "$origin" ]; then
# Infer/set origin using a variety of information.
if [ "$environmentOwner" == "flox" -o "$environmentOwner" == "flox-examples" ]; then
# We got this.
origin="https://github.com/$environmentOwner/floxmeta"
elif [ $interactive -eq 1 ]; then
local defaultOrigin
if [ "$environmentOwner" == "local" ]; then
defaultOrigin=$(promptMetaOrigin)
else
# Strange to have a profile on disk in a named without a
# remote origin. Prompt user to confirm floxmeta repo on
# github.
defaultOrigin="${git_base_url/+ssh/}$environmentOwner/floxmeta"
fi
echo 1>&2
read -e \
-p "confirm git URL for storing profile metadata: " \
-i "$defaultOrigin" origin
else
if [ "$environmentOwner" == "local" ]; then
# Used primarily for testing; provide default floxmeta origin
# based on GitHub handle observed by `gh` client.
local ghAuthHandle
if ghAuthHandle=$($_gh auth status |& $_awk '/Logged in to github.com as/ {print $7}'); then
origin="${git_base_url/+ssh/}$ghAuthHandle/floxmeta"
else
# No chance to discover origin; just create repo and return empty origin.
[ -d "$environmentMetaDir" ] || gitInitFloxmeta "$environmentMetaDir"
return 0
fi
else
origin="${git_base_url/+ssh/}$environmentOwner/floxmeta"
fi
fi
# A few final cleanup steps.
if [ "$environmentOwner" == "local" ]; then
local newEnvironmentOwner
newEnvironmentOwner=$($_dirname $origin); newEnvironmentOwner=${newEnvironmentOwner/*[:\/]/} # XXX hack
# rename .cache/flox/meta/{local -> owner} &&
# replace with symlink from local -> owner
# use .cache/flox/meta/owner as environmentMetaDir going forward (only for this function though!)
if [ -d "$FLOX_META/$newEnvironmentOwner" ]; then
warn "moving profile metadata directory $FLOX_META/$newEnvironmentOwner out of the way"
$invoke_mv --verbose $FLOX_META/$newEnvironmentOwner{,.$$}
fi
if [ -d "$FLOX_META/local" ]; then
$invoke_mv "$FLOX_META/local" "$FLOX_META/$newEnvironmentOwner"
fi
$invoke_ln -s -f $newEnvironmentOwner "$FLOX_META/local"
environmentMetaDir="$FLOX_META/$newEnvironmentOwner"
# rename .local/share/flox/environments/{local -> owner}
# replace with symlink from local -> owner
if [ -d "$FLOX_ENVIRONMENTS/$newEnvironmentOwner" ]; then
warn "moving environment directory $FLOX_ENVIRONMENTS/$newEnvironmentOwner out of the way"
$invoke_mv --verbose $FLOX_ENVIRONMENTS/$newEnvironmentOwner{,.$$}
fi
if [ -d "$FLOX_ENVIRONMENTS/local" ]; then
$invoke_mv "$FLOX_ENVIRONMENTS/local" "$FLOX_ENVIRONMENTS/$newEnvironmentOwner"
fi
$invoke_ln -s -f $newEnvironmentOwner "$FLOX_ENVIRONMENTS/local"
# perform single commit rewriting all URL references to refer to new home of floxmeta repo
rewriteURLs "$FLOX_ENVIRONMENTS/local" "$origin"
fi
[ -d "$environmentMetaDir" ] || gitInitFloxmeta "$environmentMetaDir"
$invoke_git -C "$environmentMetaDir" "remote" "add" "origin" "$origin"
fi
ensureGHRepoExists "$origin" private "https://github.com/flox/floxmeta-template.git"
echo "$origin"
}
#
# beginTransaction($environment, $workDir, $createBranch)
#
# This function creates an ephemeral clone for staging commits to
# a floxmeta repository.
#
function beginTransaction() {
trace "$@"
local environment="$1"; shift
local workDir="$1"; shift
local -i createBranch="$1"; shift
# set $branchName,$floxNixDir,$environment{Name,Alias,Owner,System,BaseDir,BinDir,ParentDir,MetaDir}
eval $(decodeEnvironment "$environment")
# If this is a project environment there will be no $environmentMetaDir.
# Create a simulated generation environment so that we don't have to
# create project-specific versions of all the calling functions.
if [ -z "$environmentMetaDir" ]; then
# Create a fake environmentMetaDir.
environmentMetaDir=$(mkTempDir)
gitInitFloxmeta "$environmentMetaDir"
# Create an ephemeral clone in $workDir.
$invoke_git clone --quiet --shared "$environmentMetaDir" $workDir
# Use registry function to initialize metadata.json.
registry "$workDir/metadata.json" 1 set currentGen 1
registry "$workDir/metadata.json" 1 setNumber generations 1 version 2
if [ -L "$environmentBaseDir" ]; then
local oldEnvironmentPath="$($_readlink "$environmentBaseDir")"
registry "$workDir/metadata.json" 1 set generations 1 path "$oldEnvironmentPath"
fi
# Copy existing flox.nix or create from templateFloxEnv.
$_mkdir "$workDir/1"
$invoke_ln -s 1 "$workDir/current"
$_mkdir "$workDir/current/pkgs"
if [ -f "$floxNixDir/flox.nix" ]; then
$_mkdir "$workDir/current/pkgs/default"
$_cp "$floxNixDir/flox.nix" "$workDir/current/pkgs/default/flox.nix"
[ ! -f "$floxNixDir/catalog.json" ] ||
$_cp "$floxNixDir/catalog.json" "$workDir/current/pkgs/default/catalog.json"
$_cp --no-preserve=mode $_lib/templateFloxEnv/pkgs/default/default.nix "$workDir/current/pkgs/default/default.nix"
else
$_cp --no-preserve=mode -rT $_lib/templateFloxEnv "$workDir/current/."
fi
# Link next generation.
$_mkdir -p "$workDir/2"; $_ln -s 2 "$workDir/next"
# Simulation complete; bid a hasty retreat.
return 0
fi
# Verify that $environmentMetaDir/local exists either as a directory
# or as a symlink to another directory.
if [ ! -d "$environmentMetaDir" ]; then
if [ -L "$environmentMetaDir" ]; then
error "damaged symbolic link: $environmentMetaDir" < /dev/null
else
gitInitFloxmeta "$environmentMetaDir"
fi
fi
# Perform a fetch to get remote data into sync.
if $invoke_git -C "$environmentMetaDir" show-ref --quiet refs/remotes/origin/HEAD; then
githubHelperGit -C "$environmentMetaDir" fetch origin
fi
# Create an ephemeral clone.
$invoke_git clone --quiet --shared "$environmentMetaDir" $workDir
# Check out the relevant branch. Can be complicated in the event
# that this is the first pull of a brand-new branch.
if $invoke_git -C "$workDir" show-ref --quiet refs/heads/"$branchName"; then
$invoke_git -C "$workDir" checkout --quiet "$branchName"
elif $invoke_git -C "$workDir" show-ref --quiet refs/remotes/origin/"$branchName"; then
$invoke_git -C "$workDir" checkout --quiet --track origin/"$branchName"
elif [ $createBranch -eq 1 ]; then
$invoke_git -C "$workDir" checkout --quiet --orphan "$branchName"
$invoke_git -C "$workDir" ls-files | $_xargs --no-run-if-empty $_git -C "$workDir" rm --quiet -f
# A commit is needed in order to make the branch visible.
$invoke_git -C "$workDir" commit --quiet --allow-empty \
-m "$USER created environment $environmentName ($environmentSystem)"
else
error "environment $environmentAlias ($environmentSystem) does not exist" < /dev/null
fi
# XXX Temporary covering transition from 0.0.6 -> 0.0.7
temporaryAssert007Schema "$workDir"
# /XXX
# Any function calling this one will probably be wanting to make
# some sort of change that will generate a new generation, so take
# this opportunity to identify the current and next generations
# and drop in helper symlinks pointing to the "current" and "next"
# generations to make it easy for calling functions to make changes.
# (But don't add them to the git index.)
# Record starting generation.
local -i startGen
startGen=$(registry "$workDir/metadata.json" 1 currentGen)
if [ $startGen -gt 0 ]; then
$invoke_ln -s $startGen "$workDir/current"
fi
# Calculate next available generation. Note this is _not_ just
# (startGen + 1), but rather (max(generations) + 1) as recorded
# in the environment registry. (We're no longer using symlinks
# to record this in the floxmeta repo.)
local -i nextGen
nextGen=$(registry "$workDir/metadata.json" 1 nextGen)
$invoke_mkdir -p $workDir/$nextGen
$invoke_ln -s $nextGen $workDir/next
# XXX Temporary covering transition from 0.0.7 -> 0.0.8
temporaryAssert008Schema "$environment" "$workDir"
# /XXX
}
#
# cmpV1Environments(env1, env2)
#
# Examines two V1 environments to determine if they are different.
# Like cmp(1) itself, will return nonzero when there are changes
# or 0 when they are substantively the same.
#
function cmpV1Environments() {
local env1="$1"; shift
local env2="$1"; shift
# $env1 (the new gen) has been determined to be a V1, but $env2
# that it is replacing may be any version, which may or may not
# have a manifest.json file to inspect. First test that both
# environments have manifest.json files to be compared.
if [ -f "$env1/manifest.json" -a -f "$env2/manifest.json" ]; then
$invoke_jq -n -f $_lib/diff-manifests.jq \
--slurpfile m1 "$env1/manifest.json" \
--slurpfile m2 "$env2/manifest.json" || return 1
else
return 1
fi
return 0
}
#
# cmpEnvironments(version, env1, env2)
#
function cmpEnvironments() {
trace "$@"
local version="$1"; shift
local env1="$1"; shift
local env2="$1"; shift
[ "$env1" = "$env2" ] || case $version in
1)
cmpV1Environments "$env1" "$env2" || return 1
;;
2)
# floxEnv environments are referenced by way of helper symlinks.
# Use realpath to follow those links and compare the packages.
local realpathEnv1
realpathEnv1=$($_realpath "$env1")
local realpathEnv2
realpathEnv2=$($_realpath "$env2")
[ "$realpathEnv1" = "$realpathEnv2" ] || return 1
;;
esac
return 0
}
#
# commitTransaction($environment, $workDir, $logMessage)
#
# This function completes the process of committing updates to
# a floxmeta repository from an ephemeral clone.
#
function commitTransaction() {
trace "$@"
local environment="$1"; shift
local workDir="$1"; shift
local environmentPackage="$1"; shift
local logMessage="$1"; shift
local nextGenVersion="$1"; shift
local invocation="${@}"
local result=""
# set $branchName,$floxNixDir,$environment{Name,Alias,Owner,System,BaseDir,BinDir,ParentDir,MetaDir}
eval $(decodeEnvironment "$environment")
# If this is a project environment there will be no $environmentMetaDir,
# and correspondingly nothing to commit or push. The only thing we need
# to do in this instance is update the activation link and bid a hasty
# retreat.
if [ -z "$environmentMetaDir" ]; then
if $_cmp -s "$workDir/next/pkgs/default/flox.nix" "$protoPkgDir/flox.nix";
then
result="project-environment-no-changes"
else
result="project-environment-modified"
fi
$invoke_nix_store --add-root "$environmentBaseDir" -r $environmentPackage >/dev/null
$invoke_cp "$workDir/next/pkgs/default/flox.nix" "$floxNixDir/flox.nix"
$invoke_cp "$workDir/next/pkgs/default/catalog.json" "$floxNixDir/catalog.json"
echo -n $result
return 0
fi
# Glean current and next generations from clone.
local -i currentGen
currentGen=$($_readlink $workDir/current || echo 0)
local -i nextGen
nextGen=$($_readlink $workDir/next)
# XXX temporary: as we change to version 0.0.9 the layout of environment
# links changes to embed the system type. Take this opportunity to rename
# those links if they exist.
temporaryAssert009LinkLayout "$environment"
# Activate the new generation just as Nix would have done.
# First check to see if the environment has actually changed,
# and if not then return immediately.
local oldEnvPackage
if [ -e "$environment" ]; then
oldEnvPackage=$($_realpath $environment)
fi
# Check to see if there has been a change.
if [ -n "$oldEnvPackage" ] && cmpEnvironments $nextGenVersion "$environmentPackage" "$oldEnvPackage"; then
if [ $verbose -ge 1 ]; then
warn "No environment changes detected .. exiting"
fi
echo -n "named-environment-no-changes"
return 0
fi
# Update the floxmeta registry to record the new generation.
registry "$workDir/metadata.json" 1 set currentGen $nextGen
# Figure out if we're creating or switching to an existing generation.
local createdOrSwitchedTo="created"
if $invoke_jq -e --arg gen $nextGen '.generations | has($gen)' $workDir/metadata.json >/dev/null; then
result="named-environment-switch-to-generation"
createdOrSwitchedTo="switched to"
else
result="named-environment-created-generation"
# Update environment metadata with new end generation information.
registry "$workDir/metadata.json" 1 set generations \
${nextGen} path $environmentPackage
registry "$workDir/metadata.json" 1 addArray generations \
${nextGen} logMessage "$logMessage"
registry "$workDir/metadata.json" 1 setNumber generations \
${nextGen} created "$now"
registry "$workDir/metadata.json" 1 setNumber generations \
${nextGen} lastActive "$now"
registry "$workDir/metadata.json" 1 setNumber generations \
${nextGen} version $nextGenVersion
fi
# Also update lastActive time for current generation, if known.
[ $currentGen -eq 0 ] || \
registry "$workDir/metadata.json" 1 setNumber generations \
$currentGen lastActive "$now"
# Mark the metadata.json file to be included with the commit.
$invoke_git -C $workDir add "metadata.json"
# Now that metadata is recorded, actually put the change
# into effect. Must be done before calling commitMessage().
if [ "$createdOrSwitchedTo" = "created" ]; then
$invoke_nix_store --add-root "${environment}-${nextGen}-link" \
-r $environmentPackage >/dev/null
fi
$invoke_rm -f $environment
$invoke_ln -s "${environmentName}-${nextGen}-link" $environment
# Detect version and act accordingly.
local -i currentGenVersion
if ! currentGenVersion=$(registry $workDir/metadata.json 1 get generations "$currentGen" version); then
currentGenVersion=1
fi
# Unification TODO: use catalog.json instead of relying on manifest.json
local message
message=$(commitMessage \
"$environment" $currentGen $nextGen \
"$logMessage" "${invocation[@]}")
$invoke_git -C $workDir commit -m "$message" --quiet
$invoke_git -C $workDir push --quiet --set-upstream origin $branchName
# Tom's feature: teach a man to fish with (-v|--verbose)
if [ $verbose -ge 1 -a $currentGenVersion -eq 2 -a $nextGenVersion -eq 2 ]; then
$invoke_git -C $workDir diff HEAD:{$currentGen,$nextGen}/pkgs/default/flox.nix
warn "$createdOrSwitchedTo generation $nextGen"
fi
echo -n $result
}