-
Notifications
You must be signed in to change notification settings - Fork 3
/
newmodule.sh
executable file
·1837 lines (1679 loc) · 56.1 KB
/
newmodule.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
#!/bin/sh
################################################################################
# Puppet module creator
#
# Script to create a useful skeleton to start developing a new Puppet module
# based on a boilerplate you choose.
#
# @author Andreas Haerter <[email protected]>
# @license Apache License 2.0 (http://www.apache.org/licenses/LICENSE-2.0)
# @link http://syn-systems.com/
################################################################################
################################################################################
# Configuration
################################################################################
# directory where the Puppet module boilerplates are located, without trailing
# slash!
DIR_BOILERPLATES="$(dirname "${0}")"
# some placeholder strings and/or names used within the boilerplate source codes
STR_PLACEHOLDER_BOILERPLATE='boilerplate'
STR_PLACEHOLDER_AUTHORFULLNAME='John Doe'
STR_PLACEHOLDER_AUTHOREMAIL='[email protected]'
STR_PLACEHOLDER_CURRENTYEAR='YYYY'
STR_PLACEHOLDER_FIXME='FIXME/TODO'
################################################################################
# DO NOT TOUCH ANYTHING BELOW THIS LINE WITHOUT KNOWING WHAT YOU ARE DOING!
################################################################################
################################################################################
# Functions
################################################################################
###
# Recursive file string replace.
#
# Handles all files within a given directory and its sub-directories. Please
# note that this function is designed to handle UTF-8 encoded files only.
#
# @param string The string being searched for ("needle").
# @param string The replacement value ("replace") that replaces found search
# values.
# @param string Directory to search for "haystack" files.
# @param integer (optional) Verbose flag. Controls if the function should
# operate silently (=0, default) or not (=1).
# @return integer 0 if executed successfully, 1 otherwise.
str_rreplace() {
local dir ifs_save lang_save langtmp_ok os replace search touched verbose
# param: search
search="${1}"
if [ -z "${search}" ]
then
printf 'Parameter is invalid: search.\n' 1>&2
return 1
fi
# param: replace
replace="${2}"
# param: directory
dir="${3}"
if [ "${dir}" != '/' ]
then
dir="$(printf '%s' "${dir}" | sed 's,/$,,')" # strip trailing slash
fi
if ! [ -d "${dir}" ]
then
printf 'Could not access directory: "%s"\n' "${dir}" 1>&2
printf 'Please place this script in the same directory as the boilerplates.\n' 1>&2
return 1
fi
# param: verbose flag
if [ -z "${4:-}" ] # ${foo:-} works with set -u
then
verbose='0'
else
verbose="${4}"
fi
if [ "${verbose}" -gt 0 ]
then
verbose='1'
else
verbose='0'
fi
# Change current LANG setting for following operations if needed. This
# prevents issues regarding some commands (e.g. 'sed', 'grep', ...) and the
# UTF-8 encoded files we are going to work with. Q.v.: <http://j.mp/GgQMV>.
lang_save="${LANG}" # copy current locale LANG value.
if ! printf '%s' "${LANG}" | grep -E -q -i -e '*utf-?8$' # current locale is UTF-8 aware?
then
# It is not. Search for an alternative...
langtmp_ok='0'
for RESOURCE in $(locale -a | grep -E -i -e '*\.utf-?8$' | grep -E -i -e '^(en|de|es|fr)_*' | sort)
do
# use it and break loop if a "favorite" (=tested) locale is present
if printf '%s' "${RESOURCE}" | grep -E -q -i -e '^de_(AT|CH|DE)' ||
printf '%s' "${RESOURCE}" | grep -E -q -i -e '^en_(AU|CA|GB|IE|NZ|US)' ||
printf '%s' "${RESOURCE}" | grep -E -q -i -e '^es_(ES|MX|US|VE)' ||
printf '%s' "${RESOURCE}" | grep -E -q -i -e '^fr_(BE|CA|CH|FR|LU)'
then
LANG="${RESOURCE}"
langtmp_ok='1'
break
fi
done
unset RESOURCE
# check if we found something useful...
if [ "${langtmp_ok}" -ne 1 ]
then
LANG="${lang_save}" # restore LANG
printf 'Current locale is not UTF-8 aware: "%s"\n' "${LANG}" 1>&2
return 1
fi
unset langtmp_ok
fi
# inform user
if [ "${verbose}" -eq 1 ]
then
printf '\033[1mReplacing "%s" with "%s"\033[0m\n' "${search}" "${replace}"
fi
# let's work
touched='0'
ifs_save="${IFS}" # copy current IFS (Internal Field Separator)
IFS="$(printf '\n+')"
for RESOURCE in $(grep -R "${search}" "${dir}" | cut -d ":" -f 1 -s | sort | uniq)
do
os="$(bash -c 'printf '\''%s'\'' "${OSTYPE}"')" # FIXME better "GNU vs. BSD sed" detection here. Maybe "uname -o"?
if printf '%s' "${os}" | grep -F -q -i -e 'darwin' || # Mac OS is using BSD sed
printf '%s' "${os}" | grep -F -q -i -e 'freebsd'
then
sed -i '' -e "s/${search}/${replace}/g" "${RESOURCE}" # BSD style
else
sed -i -e "s/${search}/${replace}/g" "${RESOURCE}" # GNU style
fi
if [ $? -ne 0 ]
then
printf 'Replacing "%s" with "%s" in "%s" failed.\n' "${search}" "${replace}" "${RESOURCE}" 1>&2
LANG="${lang_save}" # restore LANG
return 1
elif [ "${verbose}" -eq 1 ]
then
printf 'Changed: "%s"\n' "${RESOURCE}"
fi
touched='1'
done
IFS="${ifs_save}" # restore IFS (Internal Field Separator)
if [ "${verbose}" -eq 1 ] &&
[ "${touched}" -eq 0 ]
then
printf 'Nothing to replace, no file contains "%s".\n' "${search}"
fi
printf '\033[32mDone.\033[0m\n'
LANG="${lang_save}" # restore LANG
return 0
}
###
# Interactive data collection wizard
#
# @return void
wizard_start() {
local data_ok exitprog
wizard_step1_boilerplatetype
wizard_step2_newmodname
wizard_step3_targetdir
wizard_step4_authorfullname
wizard_step5_authoremail
# show overview about the collected data (unless everything was set by parameters)
if [ -z "${OPTION_AUTHORFULLNAME}" ]
[ -z "${OPTION_BOILERPLATE}" ]
[ -z "${OPTION_AUTHOREMAIL}" ]
[ -z "${OPTION_NEWMODNAME}" ]
[ -z "${OPTION_TARGETDIR}" ]
then
data_ok='n'
clear
printf '###############################################################################\n'
printf '# Puppet module creator: data overview\n'
printf '###############################################################################\n'
printf '\033[1mBoilerplate source:\033[0m\n%s\n\n' "${SOURCEDIR}"
printf '\033[1mNew module will be created in:\033[0m\n%s\n\n' "${TARGETDIR}"
printf '\033[1mAuthor/creator of the new module:\033[0m\n%s <%s>\n\n' "${AUTHORFULLNAME}" "${AUTHOREMAIL}"
printf 'Is this correct? [y|n]: '
read data_ok
while [ "${data_ok}" != 'y' ] &&
[ "${data_ok}" != 'Y' ] &&
[ "${data_ok}" != 'j' ] &&
[ "${data_ok}" != 'J' ]
do
exitprog='n'
printf 'Exit program? [y|n]: '
read exitprog
if [ "${exitprog}" = 'y' ] ||
[ "${exitprog}" = 'Y' ] ||
[ "${exitprog}" = 'j' ] ||
[ "${exitprog}" = 'J' ]
then
printf 'Operation canceled by user\n\n'
exit 0
fi
# once more with feeling...
clear
wizard_step1_boilerplatetype
wizard_step2_newmodname
wizard_step3_targetdir
wizard_step4_authorfullname
wizard_step5_authoremail
clear
printf '###############################################################################\n'
printf '# Puppet module creator: data overview\n'
printf '###############################################################################\n'
printf '\033[1mBoilerplate source:\033[0m\n%s\n\n' "${SOURCEDIR}"
printf '\033[1mNew module will be created in:\033[0m\n%s\n\n' "${TARGETDIR}"
printf '\033[1mAuthor/creator of the new module:\033[0m\n%s <%s>\n\n' "${AUTHORFULLNAME}" "${AUTHOREMAIL}"
printf 'Is this correct? [y|n]: '
read data_ok
done
printf '\n'
fi
unset data_ok
}
###
# Let the user decide which type of boilerplate we are going to use
#
# This function is setting the global SOURCEDIR var. It is a helper of the
# wizard_start function.
#
# @return integer 0 if executed successfully, 1 otherwise.
wizard_step1_boilerplatetype() {
local basename choice_ok list choice list_itemcount i ifs_save
printf '\n'
printf 'Please choose the type of boilerplate to use for the new module by typing the\n'
printf 'corresponding number:\n'
printf '\n'
SOURCEDIR='' # init the global var this wizard is for
# show a list the user can choose from
list=''
choice='none'
i='1'
ifs_save="${IFS}" # copy current IFS (Internal Field Separator)
IFS="$(printf '\n+')"
for ITEM in $(find "${DIR_BOILERPLATES}" -maxdepth 1 -type d -not -name '\.git' -not -name '\.hg' | sort)
do
# sort-out non-boilerplate directories
if [ "${ITEM}" = "${DIR_BOILERPLATES}" ] || # containing dir itself
[ ! -f "${ITEM}/manifests/init.pp" ]
then
continue 1
fi
# show the item and its number
basename="$(basename "${ITEM}")"
printf ' \033[1m%2u: %s\033[0m\n' "${i}" "${basename}"
if [ -f "${ITEM}/DESCRIPTION" ]
then
for LINE in $(cat "${ITEM}/DESCRIPTION")
do
printf ' %s\n' "${LINE}"
done
unset LINE
fi
printf '\n'
# pre-select item if specified by parameter
if [ "${OPTION_BOILERPLATE}" = "${basename}" ]
then
choice="${i}"
fi
# store item in list (separated by ":")
list="${list}${ITEM}:"
i="$((${i}+1))"
done
unset ITEM
unset i
IFS="${ifs_save}" # restore IFS (Internal Field Separator)
unset ifs_save
list="$(printf '%s' "${list}" | sed 's,:$,,')" # strip trailing ":" separator
# count list items
list_itemcount="$(printf '%s' "${list}" | sed 's/[^:]//g' | wc -m)" # count number of ":"
list_itemcount="$((list_itemcount+1))"
if [ "${list_itemcount}" -eq 0 ]
then
printf '\n' 1>&2
printf 'Could not find any boilerplates in "%s".\n' "${DIR_BOILERPLATES}" 1>&2
exit 1
fi
# choose list item
printf '\n'
if [ "${list_itemcount}" -eq 1 ]
then
choice="${list_itemcount}"
SOURCEDIR="$(printf '%s' "${list}" | cut -d ':' -f "${choice}")"
printf 'There is only one boilerplate, therefore nothing to choose.\n'
printf 'Using "%s".\n' "$(basename "${SOURCEDIR}")"
elif [ "${choice}" != 'none' ]
then
SOURCEDIR="$(printf '%s' "${list}" | cut -d ':' -f "${choice}")"
printf 'Boilerplate to use was specified by parameter.\n'
printf 'Using "%s".\n' "$(basename "${SOURCEDIR}")"
else
if [ -n "${OPTION_BOILERPLATE}" ] &&
[ "${choice}" = 'none' ]
then
OPTION_BOILERPLATE=''
printf '%s' '-b: ' 1>&2
printf 'invalid value, ignoring it.' 1>&2
fi
printf 'See http://j.mp/X3GnY9 for example modules based on the different boilerplates.\n'
printf 'Number identifying the boilerplate to use? '
read choice
choice_ok='0'
while [ "${choice_ok}" -ne 1 ]
do
if [ -z "${choice}" ] ||
! printf '%s' "${choice}" | grep -E -q -e '^[0-9]*$' ||
[ "${choice}" -gt "${list_itemcount}" ] ||
[ "${choice}" -lt 1 ]
then
printf 'Invalid, try again: '
read choice
continue 1
else
choice_ok='1'
break 1
fi
done
unset choice_ok
SOURCEDIR="$(printf '%s' "${list}" | cut -d ':' -f "${choice}")"
fi
unset list
unset choice
return 0
}
###
# Let the user set the name of the new module
#
# This function is setting the global NEWMODNAME var. It is a helper of the
# wizard_start function.
#
# @return integer 0 if executed successfully, 1 otherwise.
wizard_step2_newmodname() {
local newmodname_ok
NEWMODNAME='' # init the global var this wizard is for
if [ -n "${OPTION_NEWMODNAME}" ]
then
printf '\n'
printf 'Name of the new module was specified by parameter.\n'
printf 'Using "%s".\n' "${OPTION_NEWMODNAME}"
NEWMODNAME="${OPTION_NEWMODNAME}"
else
# inform user about the naming rules, cf. http://j.mp/xuM3Rr and http://j.mp/wZ8quk
printf '\n'
printf '\n'
printf 'NOTE: module names are restricted to lowercase alphanumeric characters and\n'
printf ' underscores, and should begin with a lowercase letter; that is, they\n'
printf ' have to match the pattern "^[a-z][a-z0-9_]*$"\n'
printf '\n'
printf 'Please enter the name for the new module: '
read NEWMODNAME
newmodname_ok='0'
while [ "${newmodname_ok}" -ne 1 ]
do
if [ -z "${NEWMODNAME}" ] ||
! printf '%s' "${NEWMODNAME}" | grep -E -q -e '^[a-z][a-z0-9_]*$' # don't forget to update the parameter check if you change something here!
then
printf 'Invalid, try again: '
read NEWMODNAME
continue 1
else
newmodname_ok='1'
break 1
fi
done
fi
return 0
}
###
# Let the user decide where to put the new module
#
# This function is setting the global TARGETDIR var. It is a helper of the
# wizard_start function.
#
# @return integer 0 if executed successfully, 1 otherwise.
wizard_step3_targetdir() {
local targetdir_ok
TARGETDIR='' # init the global var this wizard is for
if [ -n "${OPTION_TARGETDIR}" ]
then
printf '\n'
printf 'Target directory in which the module shall be copied was specified by parameter.\n'
printf 'Using "%s".\n' "${OPTION_TARGETDIR}"
TARGETDIR="${OPTION_TARGETDIR}"
else
printf '\n'
printf 'Please enter the target directory in which the module shall be copied\n'
printf 'to (just press [ENTER] for "%s"): ' "${HOME}"
read TARGETDIR
if [ "${TARGETDIR}" != '/' ]
then
TARGETDIR="$(printf '%s' "${TARGETDIR}" | sed 's,/$,,')" # strip trailing slash
fi
targetdir_ok='0'
while [ "${targetdir_ok}" -ne 1 ]
do
if [ -z "${TARGETDIR}" ]
then
# use home of current user if user just pressed [ENTER]
TARGETDIR="${HOME}"
fi
# don't forget to update the parameter checks if you change something here!
if [ ! -d "${TARGETDIR}" ]
then
printf 'Could not access target, try again: '
read TARGETDIR
if [ "${TARGETDIR}" != '/' ]
then
TARGETDIR="$(printf '%s' "${TARGETDIR}" | sed 's,/$,,')" # strip trailing slash
fi
continue 1
elif [ -d "${TARGETDIR}/${NEWMODNAME}" ]
then
printf '"%s" is already existing.\n' "${TARGETDIR}/${NEWMODNAME}"
printf 'Target invalid, try again: '
read TARGETDIR
if [ "${TARGETDIR}" != '/' ]
then
TARGETDIR="$(printf '%s' "${TARGETDIR}" | sed 's,/$,,')" # strip trailing slash
fi
continue 1
else
targetdir_ok='1'
break 1
fi
done
fi
TARGETDIR="${TARGETDIR}/${NEWMODNAME}"
return 0
}
###
# Let the user set the authors name
#
# This function is setting the global AUTHORFULLNAME var. It is a helper of the
# wizard_start function.
#
# @return integer 0 if executed successfully, 1 otherwise.
wizard_step4_authorfullname() {
local authorfullname_ok
AUTHORFULLNAME='' # init the global var this wizard is for
if [ -n "${OPTION_AUTHORFULLNAME}" ]
then
printf '\n'
printf 'Name of the author was specified by parameter.\n'
printf 'Using "%s".\n' "${OPTION_AUTHORFULLNAME}"
AUTHORFULLNAME="${OPTION_AUTHORFULLNAME}"
else
printf '\n'
if [ -z "${ENV_AUTHORFULLNAME}" ]
then
printf 'Please enter your full name (source code author info): '
else
printf 'Please enter your full name (source code author info, just press [ENTER]\n'
printf 'for "%s"): ' "${ENV_AUTHORFULLNAME}"
fi
read AUTHORFULLNAME
authorfullname_ok='0'
while [ "${authorfullname_ok}" -ne 1 ]
do
if [ -z "${AUTHORFULLNAME}" ] &&
[ -z "${ENV_AUTHORFULLNAME}" ]
then
printf 'Invalid, try again: '
read AUTHORFULLNAME
continue 1
elif [ -z "${AUTHORFULLNAME}" ] &&
[ -z "${ENV_AUTHORFULLNAME}" ]
then
# use environment variable if user just pressed [ENTER]
AUTHORFULLNAME="${ENV_AUTHORFULLNAME}"
else
authorfullname_ok='1'
break 1
fi
done
fi
return 0
}
###
# Let the user set the email address of the author
#
# This function is setting the global AUTHOREMAIL var. It is a helper of the
# wizard_start function.
#
# @return integer 0 if executed successfully, 1 otherwise.
wizard_step5_authoremail() {
local authoremail_ok
AUTHOREMAIL='' # init the global var this wizard is for
if [ -n "${OPTION_AUTHOREMAIL}" ]
then
printf '\n'
printf 'Email address of the author was specified by parameter.\n'
printf 'Using "%s".\n' "${OPTION_AUTHOREMAIL}"
AUTHOREMAIL="${OPTION_AUTHOREMAIL}"
else
printf '\n'
if [ -z "${ENV_AUTHOREMAIL}" ]
then
printf 'Please enter your email address (source code author info): '
else
printf 'Please enter your email address (source code author info, just press [ENTER]\n'
printf 'for "%s"): ' "${ENV_AUTHOREMAIL}"
fi
read AUTHOREMAIL
authoremail_ok='0'
while [ "${authoremail_ok}" -ne 1 ]
do
if ([ -z "${AUTHOREMAIL}" ] &&
[ -z "${ENV_AUTHOREMAIL}" ]) ||
([ -n "${AUTHOREMAIL}" ] &&
! printf '%s' "${AUTHOREMAIL}" | grep -F -q -e '@') # don't forget to update the parameter and environment variable check if you change something here!
then
printf 'Invalid, try again: '
read AUTHOREMAIL
continue 1
elif [ -z "${AUTHOREMAIL}" ] &&
[ -n "${ENV_AUTHOREMAIL}" ]
then
# use environment variable if user just pressed [ENTER]
AUTHOREMAIL="${ENV_AUTHOREMAIL}"
else
authoremail_ok='1'
break 1
fi
done
fi
return 0
}
###
# Interactive data collection wizard
#
# @return void
repowizard_start() {
local data_ok exitprog
repowizard_step1_service
repowizard_step2_remotename
repowizard_step3_credentials
repowizard_step4_repoaccess
# show overview about the collected data (unless everything was set by parameters)
if [ -z "${OPTION_REPOHOSTINGSERVICE}" ] ||
[ -z "${OPTION_REPOHOSTINGSERVICEPROJECTNAME}" ] ||
[ -z "${OPTION_REPOHOSTINGSERVICEUSERNAME}" ] ||
[ -z "${OPTION_REPOHOSTINGSERVICEPWD}" ] ||
[ -z "${OPTION_REPOHOSTINGSERVICEORGANIZATION}" ] ||
[ -z "${OPTION_REPOHOSTINGSERVICEREPOACCESS}" ]
then
data_ok='n'
clear
printf '###############################################################################\n'
printf '# Puppet module creator: DVCS repository wizard data overview\n'
printf '###############################################################################\n'
printf '\033[1mRepository hosting service:\033[0m\n%s\n\n' "${REPOHOSTINGSERVICE}"
printf '\033[1mRepository/project name:\033[0m\n%s\n\n' "${REPOHOSTINGSERVICEPROJECTNAME}"
printf '\033[1mUsername:\033[0m\n%s (password not shown for security reasons)\n\n' "${REPOHOSTINGSERVICEUSERNAME}"
if [ "${REPOHOSTINGSERVICE}" = 'github' ] ||
[ "${REPOHOSTINGSERVICE}" = 'bitbucket' ]
then
if [ "${REPOHOSTINGSERVICE}" = 'github' ]
then
printf '\033[1mOrganization:\033[0m\n'
else
printf '\033[1mTeam:\033[0m\n'
fi
if [ -z "${REPOHOSTINGSERVICEORGANIZATION}" ]
then
printf '(none)\n'
else
printf '%s\n' "${REPOHOSTINGSERVICEORGANIZATION}"
fi
printf '\n'
fi
printf '\033[1mRepository access:\033[0m\n%s\n\n' "${REPOHOSTINGSERVICEREPOACCESS}"
printf 'Is this correct? [y|n]: '
read data_ok
while [ "${data_ok}" != 'y' ] &&
[ "${data_ok}" != 'Y' ] &&
[ "${data_ok}" != 'j' ] &&
[ "${data_ok}" != 'J' ]
do
exitprog='n'
printf 'Exit program? [y|n]: '
read exitprog
if [ "${exitprog}" = 'y' ] ||
[ "${exitprog}" = 'Y' ] ||
[ "${exitprog}" = 'j' ] ||
[ "${exitprog}" = 'J' ]
then
printf 'Repository creation canceled by user. However, have fun with your new Puppet\n'
printf 'module.\n\n'
exit 0
fi
# once more with feeling...
clear
repowizard_step1_service
repowizard_step2_remotename
repowizard_step3_credentials
repowizard_step4_repoaccess
clear
printf '###############################################################################\n'
printf '# Puppet module creator: DVCS repository wizard data overview\n'
printf '###############################################################################\n'
printf '\033[1mRepository hosting service:\033[0m\n%s\n\n' "${REPOHOSTINGSERVICE}"
printf '\033[1mRepository/project name:\033[0m\n%s\n\n' "${REPOHOSTINGSERVICEPROJECTNAME}"
printf '\033[1mUsername:\033[0m\n%s (password not shown for security reasons)\n\n' "${REPOHOSTINGSERVICEUSERNAME}"
if [ "${REPOHOSTINGSERVICE}" = 'github' ] ||
[ "${REPOHOSTINGSERVICE}" = 'bitbucket' ]
then
if [ "${REPOHOSTINGSERVICE}" = 'github' ]
then
printf '\033[1mOrganization:\033[0m\n'
else
printf '\033[1mTeam:\033[0m\n'
fi
if [ -z "${REPOHOSTINGSERVICEORGANIZATION}" ]
then
printf '(none)\n'
else
printf '%s\n' "${REPOHOSTINGSERVICEORGANIZATION}"
fi
printf '\n'
fi
printf '\033[1mRepository access:\033[0m\n%s\n\n' "${REPOHOSTINGSERVICEREPOACCESS}"
printf 'Is this correct? [y|n]: '
read data_ok
done
printf '\n'
fi
unset data_ok
}
###
# Let the user decide which repository hosting service he want to use
#
# This function is setting the global REPOHOSTINGSERVICE var. It is a helper of
# the repowizard_start function.
#
# @return integer 0 if executed successfully, 1 otherwise.
repowizard_step1_service() {
local choice_ok list list_raw choice list_itemcount i ifs_save item_lower
printf '\n'
printf 'Please choose the service you want to use to host the repository for your\n'
printf 'new module by typing the corresponding number:\n'
printf '\n'
REPOHOSTINGSERVICE='' # init the global var this wizard is for
# show a list the user can choose from
list_raw='Bitbucket:GitHub'
list=''
choice='none'
i='1'
ifs_save="${IFS}" # copy current IFS (Internal Field Separator)
IFS=':'
for ITEM in ${list_raw}
do
# show the item and its number
printf ' %s: %s\n' "${i}" "${ITEM}"
# pre-select item if specified by parameter
item_lower="$(printf '%s' "${ITEM}" | tr A-Z a-z)"
if [ -n "${item_lower}" ] &&
[ "${item_lower}" = "$(printf '%s' "${OPTION_REPOHOSTINGSERVICE}" | tr A-Z a-z)" ]
then
choice="${i}"
fi
# store item in list (separated by ":")
list="${list}${item_lower}:"
i="$((${i}+1))"
done
unset ITEM
unset i
IFS="${ifs_save}" # restore IFS (Internal Field Separator)
unset ifs_save
unset item_lower
list="$(printf '%s' "${list}" | sed 's,:$,,')" # strip trailing ":" separator
# count list items
list_itemcount="$(printf '%s' "${list}" | sed 's/[^:]//g' | wc -m)" # count number of ":"
list_itemcount="$((list_itemcount+1))"
if [ "${list_itemcount}" -eq 0 ]
then
printf '\n' 1>&2
printf 'Could not find any repository hosting services.\n' 1>&2
exit 1
fi
# choose list item
printf '\n'
if [ "${list_itemcount}" -eq 1 ]
then
choice="${list_itemcount}"
REPOHOSTINGSERVICE="$(printf '%s' "${list}" | cut -d ':' -f "${choice}")"
printf 'There is only one repository hosting service, therefore nothing to choose.\n'
printf 'Using "%s".\n' "${REPOHOSTINGSERVICE}"
elif [ "${choice}" != 'none' ]
then
REPOHOSTINGSERVICE="$(printf '%s' "${list}" | cut -d ':' -f "${choice}")"
printf 'Repository hosting service to use was specified by parameter.\n'
printf 'Using "%s".\n' "${REPOHOSTINGSERVICE}"
else
if [ -n "${OPTION_REPOHOSTINGSERVICE}" ] &&
[ "${choice}" = 'none' ]
then
OPTION_REPOHOSTINGSERVICE=''
printf '%s' '-s: ' 1>&2
printf 'invalid value, ignoring it.' 1>&2
fi
printf 'Number identifying the repository hosting service to use? '
read choice
choice_ok='0'
while [ "${choice_ok}" -ne 1 ]
do
if [ -z "${choice}" ] ||
! printf '%s' "${choice}" | grep -E -q -e '^[0-9]*$' ||
[ "${choice}" -gt "${list_itemcount}" ] ||
[ "${choice}" -lt 1 ]
then
printf 'Invalid, try again: '
read choice
continue 1
else
choice_ok='1'
break 1
fi
done
unset choice_ok
REPOHOSTINGSERVICE="$(printf '%s' "${list}" | cut -d ':' -f "${choice}")"
fi
unset list
unset choice
return 0
}
###
# Let the user set the name of the new remote repository ("project name")
#
# This function is setting the global REPOHOSTINGSERVICEPROJECTNAME var. It is
# a helper of the repowizard_start function.
#
# @return integer 0 if executed successfully, 1 otherwise.
repowizard_step2_remotename() {
local repohostingserviceprojectname_ok
REPOHOSTINGSERVICEPROJECTNAME='' # init the global var this wizard is for
if [ -n "${OPTION_REPOHOSTINGSERVICEPROJECTNAME}" ]
then
printf '\n'
printf 'Name of the new remote repository was specified by parameter.\n'
printf 'Using "%s".\n' "${OPTION_REPOHOSTINGSERVICEPROJECTNAME}"
REPOHOSTINGSERVICEPROJECTNAME="${OPTION_REPOHOSTINGSERVICEPROJECTNAME}"
else
REPOHOSTINGSERVICEPROJECTNAME_DEFAULT="puppet-module-${NEWMODNAME}"
printf '\n'
printf '\n'
printf 'NOTE: most hosting services are restricting their project names alphanumeric\n'
printf ' characters, underscores and minus; that is, they have to match the\n'
printf ' pattern '\''^[a-zA-Z0-9_\-]*$'\''\n'
printf '\n'
printf 'Please enter the name for your new %s project (just press [ENTER]\n' "${REPOHOSTINGSERVICE}"
printf 'for "%s"): ' "${REPOHOSTINGSERVICEPROJECTNAME_DEFAULT}"
read REPOHOSTINGSERVICEPROJECTNAME
repohostingserviceprojectname_ok='0'
while [ "${repohostingserviceprojectname_ok}" -ne 1 ]
do
if [ -z "${REPOHOSTINGSERVICEPROJECTNAME}" ]
then
# use default if user just pressed [ENTER]
REPOHOSTINGSERVICEPROJECTNAME="${REPOHOSTINGSERVICEPROJECTNAME_DEFAULT}"
fi
if ! printf '%s' "${REPOHOSTINGSERVICEPROJECTNAME}" | grep -E -q -e '^[a-zA-Z0-9_\-]*$' # don't forget to update the parameter check if you change something here!
then
printf 'Invalid, try again: '
read REPOHOSTINGSERVICEPROJECTNAME
continue 1
else
repohostingserviceprojectname_ok='1'
break 1
fi
done
fi
return 0
}
###
# Let the user set the credentials needed to log into the hosting service to
# create the new remote repository/project
#
# This function is setting the global REPOHOSTINGSERVICEUSERNAME,
# REPOHOSTINGSERVICEPWD and REPOHOSTINGSERVICEORGANIZATION var. It is a helper
# of the repowizard_start function.
#
# @return integer 0 if executed successfully, 1 otherwise.
repowizard_step3_credentials() {
local repohostingserviceusername_ok repohostingservicepwd_ok \
repohostingserviceorganization_ok
# username
REPOHOSTINGSERVICEUSERNAME='' # init the global var this wizard is for
if [ -n "${OPTION_REPOHOSTINGSERVICEUSERNAME}" ]
then
printf '\n'
printf 'Username for repository hosting service authentication was specified by\n'
printf 'parameter. Using "%s".\n' "${OPTION_REPOHOSTINGSERVICEUSERNAME}"
REPOHOSTINGSERVICEUSERNAME="${OPTION_REPOHOSTINGSERVICEUSERNAME}"
else
printf '\n'
printf 'Please enter the username to use to authenticate you on %s: ' "${REPOHOSTINGSERVICE}"
read REPOHOSTINGSERVICEUSERNAME
repohostingserviceusername_ok='0'
while [ "${repohostingserviceusername_ok}" -ne 1 ]
do
if [ -z "${REPOHOSTINGSERVICEUSERNAME}" ]
then
printf 'Invalid, try again: '
read REPOHOSTINGSERVICEUSERNAME
continue 1
else
repohostingserviceusername_ok='1'
break 1
fi
done
fi
# password
REPOHOSTINGSERVICEPWD='' # init the global var this wizard is for
if [ -n "${OPTION_REPOHOSTINGSERVICEPWD}" ]
then
printf '\n'
printf 'Password for repository hosting service authentication was specified by\n'
printf 'parameter. Using "(password not shown for security reasons)".\n'
REPOHOSTINGSERVICEPWD="${OPTION_REPOHOSTINGSERVICEPWD}"
else
printf '\n'
printf 'Please enter the password belonging your username to authenticate you\n'
printf 'on %s (won'\''t be shown for security reasons): ' "${REPOHOSTINGSERVICE}"
stty -echo
read REPOHOSTINGSERVICEPWD
stty echo
printf '\n'
repohostingservicepwd_ok='0'
while [ "${repohostingservicepwd_ok}" -ne 1 ]
do
if [ -z "${REPOHOSTINGSERVICEPWD}" ]
then
printf 'Invalid, try again: '
stty -echo
read REPOHOSTINGSERVICEPWD
stty echo
printf '\n'
continue 1
else
repohostingservicepwd_ok='1'
break 1
fi
done
fi
# organization
REPOHOSTINGSERVICEORGANIZATION='' # init the global var this wizard is for
if [ "${REPOHOSTINGSERVICE}" = 'github' ]
then
if [ -n "${OPTION_REPOHOSTINGSERVICEORGANIZATION}" ]
then
printf '\n'
printf 'GitHub Organization your user belongs to was specified by parameter.\n'
if [ "${OPTION_REPOHOSTINGSERVICEORGANIZATION}" = 'none' ] ||
[ "${OPTION_REPOHOSTINGSERVICEORGANIZATION}" = 'false' ]
then
REPOHOSTINGSERVICEORGANIZATION=''
printf 'Using "(none)" (=no organization is used).\n'
else
REPOHOSTINGSERVICEORGANIZATION="${OPTION_REPOHOSTINGSERVICEORGANIZATION}"
printf 'Using "%s".\n' "${OPTION_REPOHOSTINGSERVICEORGANIZATION}"
fi
else
printf '\n'
printf 'GitHub provides organizations (see http://j.mp/d2PFSw for information). If\n'
printf 'you want to create the new repository in the organization'\''s account instead\n'
printf 'of your personal one, you can enter the organization name here. Leave blank\n'
printf 'for none.\n'
printf '\n'
printf 'Please enter the GitHub organization (press [ENTER] if none): '
read REPOHOSTINGSERVICEORGANIZATION
repohostingserviceorganization_ok='0'
while [ "${repohostingserviceorganization_ok}" -ne 1 ]
do
if [ -n "${REPOHOSTINGSERVICEORGANIZATION}" ] &&
! printf '%s' "${REPOHOSTINGSERVICEORGANIZATION}" | grep -E -q -e '^[a-zA-Z][a-zA-Z0-9\-]*$' # don't forget to update the parameter check if you change something here!
then
printf 'Invalid, try again: '
read REPOHOSTINGSERVICEORGANIZATION
continue 1
else
repohostingserviceorganization_ok='1'
break 1
fi
done
fi
elif [ "${REPOHOSTINGSERVICE}" = 'bitbucket' ]
then
if [ -n "${OPTION_REPOHOSTINGSERVICEORGANIZATION}" ]
then
printf '\n'
printf 'Bitbucket Team your user belongs to was specified by parameter.\n'
if [ "${OPTION_REPOHOSTINGSERVICEORGANIZATION}" = 'none' ] ||
[ "${OPTION_REPOHOSTINGSERVICEORGANIZATION}" = 'false' ]
then
REPOHOSTINGSERVICEORGANIZATION=''
printf 'Using "(none)" (=no team is used).\n'
else
REPOHOSTINGSERVICEORGANIZATION="${OPTION_REPOHOSTINGSERVICEORGANIZATION}"
printf 'Using "%s".\n' "${OPTION_REPOHOSTINGSERVICEORGANIZATION}"
fi
else
printf '\n'
printf 'Bitbucket provides teams (see http://j.mp/LHiSK9 for information). If\n'
printf 'you want to create the new repository in the teams'\''s account instead\n'
printf 'of your personal one, you can enter the team name here. Leave blank\n'
printf 'for none.\n'
printf '\n'
printf 'Please enter the Bitbucket team (press [ENTER] if none): '
read REPOHOSTINGSERVICEORGANIZATION
repohostingserviceorganization_ok='0'
while [ "${repohostingserviceorganization_ok}" -ne 1 ]
do
if [ -n "${REPOHOSTINGSERVICEORGANIZATION}" ] &&
! printf '%s' "${REPOHOSTINGSERVICEORGANIZATION}" | grep -E -q -e '^[a-zA-Z][a-zA-Z0-9\-]*$' # don't forget to update the parameter check if you change something here!
then
printf 'Invalid, try again: '
read REPOHOSTINGSERVICEORGANIZATION
continue 1
else
repohostingserviceorganization_ok='1'
break 1
fi
done
fi
fi
return 0
}