/
Rakefile
1393 lines (1211 loc) · 49.6 KB
/
Rakefile
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
# frozen_string_literal: true
require 'English'
$LOAD_PATH.unshift File.expand_path('.')
require 'rake'
require 'net/telnet'
require 'stringio'
require 'fileutils'
require 'open-uri'
require 'git'
require 'find'
include Rake::DSL
Rake.application.instance_variable_set(:@name, 'go')
orig_verbose = verbose
verbose(false)
# The CrazyFun build grammar. There's no magic here, just ruby
require 'rake_tasks/crazy_fun/main'
require 'rake_tasks/selenium_rake/detonating_handler'
require 'rake_tasks/selenium_rake/crazy_fun'
# The CrazyFun builders - Most of these are either partially or fully obsolete
# Note the order here is important - The top 2 are used in inheritance chains
require 'rake_tasks/crazy_fun/mappings/file_copy_hack'
require 'rake_tasks/crazy_fun/mappings/tasks'
require 'rake_tasks/crazy_fun/mappings/rake_mappings'
# Location of all new (non-CrazyFun) methods
require 'rake_tasks/selenium_rake/browsers'
require 'rake_tasks/selenium_rake/checks'
require 'rake_tasks/selenium_rake/cpp_formatter'
require 'rake_tasks/selenium_rake/ie_generator'
require 'rake_tasks/selenium_rake/java_formatter'
require 'rake_tasks/selenium_rake/type_definitions_generator'
# Our modifications to the Rake / Bazel libraries
require 'rake/task'
require 'rake_tasks/rake/task'
require 'rake_tasks/rake/dsl'
require 'rake_tasks/bazel/task'
# These are the final items mixed into the global NS
# These need moving into correct namespaces, and not be globally included
require 'rake_tasks/bazel'
require 'rake_tasks/python'
$DEBUG = orig_verbose != Rake::FileUtilsExt::DEFAULT
$DEBUG = true if ENV['debug'] == 'true'
verbose($DEBUG)
@git = Git.open(__dir__)
def java_version
File.foreach('java/version.bzl') do |line|
return line.split('=').last.strip.tr('"', '') if line.include?('SE_VERSION')
end
end
# The build system used by webdriver is layered on top of rake, and we call it
# "crazy fun" for no readily apparent reason.
# First off, create a new CrazyFun object.
crazy_fun = SeleniumRake::CrazyFun.new
# Secondly, we add the handlers, which are responsible for turning a build
# rule into a (series of) rake tasks. For example if we're looking at a file
# in subdirectory "subdir" contains the line:
#
# java_library(:name => "example", :srcs => ["foo.java"])
#
# we would generate a rake target of "//subdir:example" which would generate
# a Java JAR at "build/subdir/example.jar".
#
# If crazy fun doesn't know how to handle a particular output type ("java_library"
# in the example above) then it will throw an exception, stopping the build
CrazyFun::Mappings::RakeMappings.new.add_all(crazy_fun)
# Finally, find every file named "build.desc" in the project, and generate
# rake tasks from them. These tasks are normal rake tasks, and can be invoked
# from rake.
# FIXME: the rules for the targets were removed and build files won't load
# crazy_fun.create_tasks(Dir['**/build.desc'])
# If it looks like a bazel target, build it with bazel
rule(%r{//.*}) do |task|
task.out = Bazel.execute('build', %w[], task.name)
end
# Spoof tasks to get CI working with bazel
task '//java/test/org/openqa/selenium/environment/webserver:webserver:uber' => [
'//java/test/org/openqa/selenium/environment:webserver'
]
# Java targets required for release. These should all be java_export targets.
# Generated from: bazel query 'kind(maven_publish, set(//java/... //third_party/...))' | sort
JAVA_RELEASE_TARGETS = %w[
//java/src/org/openqa/selenium/chrome:chrome.publish
//java/src/org/openqa/selenium/chromium:chromium.publish
//java/src/org/openqa/selenium/devtools/v122:v122.publish
//java/src/org/openqa/selenium/devtools/v123:v123.publish
//java/src/org/openqa/selenium/devtools/v124:v124.publish
//java/src/org/openqa/selenium/devtools/v85:v85.publish
//java/src/org/openqa/selenium/edge:edge.publish
//java/src/org/openqa/selenium/firefox:firefox.publish
//java/src/org/openqa/selenium/grid/sessionmap/jdbc:jdbc.publish
//java/src/org/openqa/selenium/grid/sessionmap/redis:redis.publish
//java/src/org/openqa/selenium/grid:bom-dependencies.publish
//java/src/org/openqa/selenium/grid:bom.publish
//java/src/org/openqa/selenium/grid:grid.publish
//java/src/org/openqa/selenium/ie:ie.publish
//java/src/org/openqa/selenium/json:json.publish
//java/src/org/openqa/selenium/manager:manager.publish
//java/src/org/openqa/selenium/os:os.publish
//java/src/org/openqa/selenium/remote/http:http.publish
//java/src/org/openqa/selenium/remote:remote.publish
//java/src/org/openqa/selenium/safari:safari.publish
//java/src/org/openqa/selenium/support:support.publish
//java/src/org/openqa/selenium:client-combined.publish
//java/src/org/openqa/selenium:core.publish
].freeze
# Notice that because we're using rake, anything you can do in a normal rake
# build can also be done here. For example, here we set the default task
task default: [:grid]
task all: [
:'selenium-java',
'//java/test/org/openqa/selenium/environment:webserver'
]
task tests: [
'//java/test/org/openqa/selenium/htmlunit:htmlunit',
'//java/test/org/openqa/selenium/firefox:test-synthesized',
'//java/test/org/openqa/selenium/ie:ie',
'//java/test/org/openqa/selenium/chrome:chrome',
'//java/test/org/openqa/selenium/edge:edge',
'//java/test/org/openqa/selenium/support:small-tests',
'//java/test/org/openqa/selenium/support:large-tests',
'//java/test/org/openqa/selenium/remote:small-tests',
'//java/test/org/openqa/selenium/remote/server/log:test',
'//java/test/org/openqa/selenium/remote/server:small-tests'
]
task chrome: ['//java/src/org/openqa/selenium/chrome']
task grid: [:'selenium-server-standalone']
task ie: ['//java/src/org/openqa/selenium/ie']
task firefox: ['//java/src/org/openqa/selenium/firefox']
task remote: %i[remote_server remote_client]
task remote_client: ['//java/src/org/openqa/selenium/remote']
task remote_server: ['//java/src/org/openqa/selenium/remote/server']
task safari: ['//java/src/org/openqa/selenium/safari']
task selenium: ['//java/src/org/openqa/selenium:core']
task support: ['//java/src/org/openqa/selenium/support']
desc 'Build the standalone server'
task 'selenium-server-standalone' => '//java/src/org/openqa/selenium/grid:executable-grid'
task test_javascript: [
'//javascript/atoms:test-chrome:run',
'//javascript/webdriver:test-chrome:run',
'//javascript/selenium-atoms:test-chrome:run',
'//javascript/selenium-core:test-chrome:run'
]
task test_chrome: ['//java/test/org/openqa/selenium/chrome:chrome:run']
task test_edge: ['//java/test/org/openqa/selenium/edge:edge:run']
task test_chrome_atoms: [
'//javascript/atoms:test-chrome:run',
'//javascript/chrome-driver:test-chrome:run',
'//javascript/webdriver:test-chrome:run'
]
task test_htmlunit: [
'//java/test/org/openqa/selenium/htmlunit:htmlunit:run'
]
task test_grid: [
'//java/test/org/openqa/grid/common:common:run',
'//java/test/org/openqa/grid:grid:run',
'//java/test/org/openqa/grid/e2e:e2e:run',
'//java/test/org/openqa/selenium/remote:remote-driver-grid-tests:run'
]
task test_ie: [
'//cpp/iedriverserver:win32',
'//cpp/iedriverserver:x64',
'//java/test/org/openqa/selenium/ie:ie:run'
]
task test_jobbie: [:test_ie]
task test_firefox: ['//java/test/org/openqa/selenium/firefox:marionette:run']
task test_remote_server: [
'//java/test/org/openqa/selenium/remote/server:small-tests:run',
'//java/test/org/openqa/selenium/remote/server/log:test:run'
]
task test_remote: [
'//java/test/org/openqa/selenium/json:small-tests:run',
'//java/test/org/openqa/selenium/remote:common-tests:run',
'//java/test/org/openqa/selenium/remote:client-tests:run',
'//java/test/org/openqa/selenium/remote:remote-driver-tests:run',
:test_remote_server
]
task test_safari: ['//java/test/org/openqa/selenium/safari:safari:run']
task test_support: [
'//java/test/org/openqa/selenium/support:small-tests:run',
'//java/test/org/openqa/selenium/support:large-tests:run'
]
task :test_java_webdriver do
if SeleniumRake::Checks.windows?
Rake::Task['test_ie'].invoke
elsif SeleniumRake::Checks.chrome?
Rake::Task['test_chrome'].invoke
elsif SeleniumRake::Checks.edge?
Rake::Task['test_edge'].invoke
else
Rake::Task['test_htmlunit'].invoke
Rake::Task['test_firefox'].invoke
Rake::Task['test_remote_server'].invoke
end
end
task test_java: [
'//java/test/org/openqa/selenium/atoms:test:run',
:test_java_small_tests,
:test_support,
:test_java_webdriver,
:test_selenium,
'test_grid'
]
task test_java_small_tests: [
'//java/test/org/openqa/selenium:small-tests:run',
'//java/test/org/openqa/selenium/json:small-tests:run',
'//java/test/org/openqa/selenium/support:small-tests:run',
'//java/test/org/openqa/selenium/remote:common-tests:run',
'//java/test/org/openqa/selenium/remote:client-tests:run',
'//java/test/org/openqa/grid/selenium/node:node:run',
'//java/test/org/openqa/grid/selenium/proxy:proxy:run',
'//java/test/org/openqa/selenium/remote/server:small-tests:run',
'//java/test/org/openqa/selenium/remote/server/log:test:run'
]
task :test do
if SeleniumRake::Checks.python?
Rake::Task['test_py'].invoke
else
Rake::Task['test_javascript'].invoke
Rake::Task['test_java'].invoke
end
end
task test_py: [:py_prep_for_install_release, 'py:marionette_test']
task build: %i[all firefox remote selenium tests]
desc 'Clean build artifacts.'
task :clean do
rm_rf 'build/'
rm_rf 'java/build/'
rm_rf 'dist/'
end
# Create a new IEGenerator instance
ie_generator = SeleniumRake::IEGenerator.new
# Generate a C++ Header file for mapping between magic numbers and #defines
# in the C++ code.
ie_generator.generate_type_mapping(
name: 'ie_result_type_cpp',
src: 'cpp/iedriver/result_types.txt',
type: 'cpp',
out: 'cpp/iedriver/IEReturnTypes.h'
)
desc 'Generate Javadocs'
task javadocs: %i[//java/src/org/openqa/selenium/grid:all-javadocs] do
rm_rf 'build/docs/api/java'
mkdir_p 'build/docs/api/java'
out = 'bazel-bin/java/src/org/openqa/selenium/grid/all-javadocs.jar'
cmd = %(cd build/docs/api/java && jar xf "../../../../#{out}" 2>&1)
cmd = cmd.tr('/', '\\').tr(':', ';') if SeleniumRake::Checks.windows?
ok = system(cmd)
ok or raise 'could not unpack javadocs'
File.open('build/docs/api/java/stylesheet.css', 'a') do |file|
file.write(<<~STYLE
/* Custom selenium-specific styling */
.blink {
animation: 2s cubic-bezier(0.5, 0, 0.85, 0.85) infinite blink;
}
@keyframes blink {
50% {
opacity: 0;
}
}
STYLE
)
end
end
file 'cpp/iedriver/sizzle.h' => ['//third_party/js/sizzle:sizzle:header'] do
cp 'build/third_party/js/sizzle/sizzle.h', 'cpp/iedriver/sizzle.h'
end
task sizzle_header: ['cpp/iedriver/sizzle.h']
task ios_driver: [
'//javascript/atoms/fragments:get_visible_text:ios',
'//javascript/atoms/fragments:click:ios',
'//javascript/atoms/fragments:back:ios',
'//javascript/atoms/fragments:forward:ios',
'//javascript/atoms/fragments:submit:ios',
'//javascript/atoms/fragments:xpath:ios',
'//javascript/atoms/fragments:xpaths:ios',
'//javascript/atoms/fragments:type:ios',
'//javascript/atoms/fragments:get_attribute:ios',
'//javascript/atoms/fragments:clear:ios',
'//javascript/atoms/fragments:is_selected:ios',
'//javascript/atoms/fragments:is_enabled:ios',
'//javascript/atoms/fragments:is_shown:ios',
'//javascript/atoms/fragments:stringify:ios',
'//javascript/atoms/fragments:link_text:ios',
'//javascript/atoms/fragments:link_texts:ios',
'//javascript/atoms/fragments:partial_link_text:ios',
'//javascript/atoms/fragments:partial_link_texts:ios',
'//javascript/atoms/fragments:get_interactable_size:ios',
'//javascript/atoms/fragments:scroll_into_view:ios',
'//javascript/atoms/fragments:get_effective_style:ios',
'//javascript/atoms/fragments:get_element_size:ios',
'//javascript/webdriver/atoms/fragments:get_location_in_view:ios'
]
desc 'Create zipped assets for Java for uploading to GitHub'
task :'java-release-zip' do
Bazel.execute('build', ['--stamp'], '//java/src/org/openqa/selenium:client-zip')
Bazel.execute('build', ['--stamp'], '//java/src/org/openqa/selenium/grid:server-zip')
Bazel.execute('build', ['--stamp'], '//java/src/org/openqa/selenium/grid:executable-grid')
mkdir_p 'build/dist'
Dir.glob('build/dist/*{java,server}*').each { |file| FileUtils.rm_f(file) }
FileUtils.copy('bazel-bin/java/src/org/openqa/selenium/grid/server-zip.zip',
"build/dist/selenium-server-#{java_version}.zip")
FileUtils.chmod(0666, "build/dist/selenium-server-#{java_version}.zip")
FileUtils.copy('bazel-bin/java/src/org/openqa/selenium/client-zip.zip',
"build/dist/selenium-java-#{java_version}.zip")
FileUtils.chmod(0666, "build/dist/selenium-java-#{java_version}.zip")
FileUtils.copy('bazel-bin/java/src/org/openqa/selenium/grid/selenium',
"build/dist/selenium-server-#{java_version}.jar")
FileUtils.chmod(0777, "build/dist/selenium-server-#{java_version}.jar")
end
task 'release-java': %i[java-release-zip publish-maven]
def read_m2_user_pass
# First check env vars, then the settings.xml config inside .m2
user = nil
pass = nil
if ENV['SEL_M2_USER'] && ENV['SEL_M2_PASS']
puts 'Fetching m2 user and pass from environment variables.'
user = ENV['SEL_M2_USER']
pass = ENV['SEL_M2_PASS']
return [user, pass]
end
settings = File.read("#{Dir.home}/.m2/settings.xml")
found_section = false
settings.each_line do |line|
if !found_section
found_section = line.include? '<id>sonatype-nexus-staging</id>'
elsif user.nil? && line.include?('<username>')
user = line.split('<username>')[1].split('</')[0]
elsif pass.nil? && line.include?('<password>')
pass = line.split('<password>')[1].split('</')[0]
end
end
[user, pass]
end
desc 'Publish all Java jars to Maven as stable release'
task 'publish-maven': JAVA_RELEASE_TARGETS do
creds = read_m2_user_pass
JAVA_RELEASE_TARGETS.each do |p|
Bazel.execute('run',
['--stamp',
'--define',
'maven_repo=https://oss.sonatype.org/service/local/staging/deploy/maven2',
'--define',
"maven_user=#{creds[0]}",
'--define',
"maven_password=#{creds[1]}",
'--define',
'gpg_sign=true'],
p)
end
end
desc 'Publish all Java jars to Maven as nightly release'
task 'publish-maven-snapshot': JAVA_RELEASE_TARGETS do
creds = read_m2_user_pass
if java_version.end_with?('-SNAPSHOT')
JAVA_RELEASE_TARGETS.each do |p|
Bazel.execute('run',
['--stamp',
'--define',
'maven_repo=https://oss.sonatype.org/content/repositories/snapshots',
'--define',
"maven_user=#{creds[0]}",
'--define',
"maven_password=#{creds[1]}",
'--define',
'gpg_sign=false'],
p)
end
else
puts 'No SNAPSHOT version configured. Targets will not be pushed to the snapshot repo in SonaType.'
end
end
desc 'Install jars to local m2 directory'
task :'maven-install' do
JAVA_RELEASE_TARGETS.each do |p|
Bazel.execute('run',
['--stamp',
'--define',
"maven_repo=file://#{Dir.home}/.m2/repository",
'--define',
'gpg_sign=false'],
p)
end
end
desc 'Build the selenium client jars'
task 'selenium-java' => '//java/src/org/openqa/selenium:client-combined'
desc 'Update AUTHORS file'
task :authors do
sh "(git log --use-mailmap --format='%aN <%aE>' ; cat .OLD_AUTHORS) | sort -uf > AUTHORS"
end
namespace :side do
task atoms: [
'//javascript/atoms/fragments:find-element'
] do
# TODO: move directly to IDE's directory once the repositories are merged
mkdir_p 'build/javascript/atoms'
atom = 'bazel-bin/javascript/atoms/fragments/find-element.js'
name = File.basename(atom)
puts "Generating #{atom} as #{name}"
File.open(File.join(baseDir, name), 'w') do |f|
f << "// GENERATED CODE - DO NOT EDIT\n"
f << 'module.exports = '
f << File.read(atom).strip
f << ";\n"
end
end
end
def node_version
File.foreach('javascript/node/selenium-webdriver/package.json') do |line|
return line.split(':').last.strip.tr('",', '') if line.include?('version')
end
end
namespace :node do
atom_list = %w[
//javascript/atoms/fragments:find-elements
//javascript/atoms/fragments:is-displayed
//javascript/webdriver/atoms:get-attribute
]
task atoms: atom_list do
base_dir = 'javascript/node/selenium-webdriver/lib/atoms'
mkdir_p base_dir
['bazel-bin/javascript/atoms/fragments/is-displayed.js',
'bazel-bin/javascript/webdriver/atoms/get-attribute.js',
'bazel-bin/javascript/atoms/fragments/find-elements.js'].each do |atom|
name = File.basename(atom)
puts "Generating #{atom} as #{name}"
File.open(File.join(base_dir, name), 'w') do |f|
f << "// GENERATED CODE - DO NOT EDIT\n"
f << 'module.exports = '
f << File.read(atom).strip
f << ";\n"
end
end
end
desc 'Build Node npm package'
task :build, [:args] do |_task, arguments|
args = Array(arguments[:args]) || []
Bazel.execute('build', args, '//javascript/node/selenium-webdriver')
end
task :'dry-run' do
Bazel.execute('run', ['--stamp'], '//javascript/node/selenium-webdriver:selenium-webdriver.publish -- --dry-run=true')
end
desc 'Release Node npm package'
task :release do
Bazel.execute('run', ['--stamp'], '//javascript/node/selenium-webdriver:selenium-webdriver.publish')
end
desc 'Release Node npm package'
task deploy: :release
desc 'Generate Node documentation — currently not working'
task :docs, [:skip_update] do |_task, arguments|
puts "WARNING — Cannot currently update API Docs for JavaScript bindings"
end
desc 'Update JavaScript changelog'
task :changelog do
header = "## #{node_version}"
update_changelog(node_version, 'javascript', 'javascript/node/selenium-webdriver/', 'javascript/node/selenium-webdriver/CHANGES.md', header)
end
desc 'Update Node version'
task :version, [:version] do |_task, arguments|
bump_nightly = arguments[:version] === 'nightly'
old_version = node_version
new_version = nil
# There are three cases we want to deal with:
# 1. Switching from a release build to a nightly one
# 2. Updating a nightly build for the next nightly build
# 3. Switching from nightlies to a release build.
if bump_nightly && old_version.include?('-nightly')
# This is the case where we are updating a nightly build to the next nightly build.
# This change is usually done by the CI system and never committed.
# The "-nightlyYmdHM" is removed to add a new timestamp.
new_version = old_version.gsub(/\-nightly\d+$/, '') + "-nightly#{Time.now.strftime("%Y%m%d%H%M")}"
elsif bump_nightly
# This is the case after a production release and the version number is configured
# to start doing nightly builds.
new_version = old_version + "-nightly#{Time.now.strftime("%Y%m%d%H%M")}"
else
if old_version.include?('-nightly')
# From a nightly build to a release build.
new_version = old_version.gsub(/\-nightly\d+$/, '')
else
# From a release build to a nightly build. We use npm version for this.
new_version = updated_version(old_version.gsub(/\-nightly\d+$/, ''), arguments[:version])
new_version = new_version + "-nightly#{Time.now.strftime("%Y%m%d%H%M")}"
end
end
['javascript/node/selenium-webdriver/package.json',
'package-lock.json',
'javascript/node/selenium-webdriver/BUILD.bazel'].each do |file|
text = File.read(file).gsub(old_version, new_version)
File.open(file, "w") { |f| f.puts text }
end
Rake::Task['node:changelog'].invoke unless new_version.include?('-nightly') || bump_nightly
end
end
def python_version
File.foreach('py/BUILD.bazel') do |line|
return line.split('=').last.strip.tr('"', '') if line.include?('SE_VERSION')
end
end
namespace :py do
desc 'Build Python wheel and sdist with optional arguments'
task :build, [:args] do |_task, arguments|
args = Array(arguments[:args]) || []
Bazel.execute('build', args, '//py:selenium-wheel')
Bazel.execute('build', args, '//py:selenium-sdist')
end
desc 'Release Python wheel and sdist to pypi'
task :release, [:args] do |_task, arguments|
args = Array(arguments[:args]) || ['--stamp']
Bazel.execute('run', args, '//py:selenium-release')
end
desc 'generate and copy files required for local development'
task :local_dev do
Bazel.execute('build', [], '//py:selenium')
Rake::Task['grid'].invoke
FileUtils.rm_rf('py/selenium/webdriver/common/devtools/')
FileUtils.cp_r('bazel-bin/py/selenium/webdriver/.', 'py/selenium/webdriver', remove_destination: true)
end
desc 'Update generated Python files for local development'
task :clean do
Bazel.execute('build', [], '//py:selenium')
bazel_bin_path = 'bazel-bin/py/selenium/webdriver'
lib_path = 'py/selenium/webdriver'
dirs = %w[devtools linux mac windows]
dirs.each { |dir| FileUtils.rm_rf("#{lib_path}/common/#{dir}") }
Find.find(bazel_bin_path) do |path|
if File.directory?(path) && dirs.any? {|dir| path.include?("common/#{dir}")}
Find.prune
next
end
next if File.directory?(path)
target_file = File.join(lib_path, path.sub(/^#{bazel_bin_path}\//, ''))
if File.exist?(target_file)
puts "Removing target file: #{target_file}"
FileUtils.rm(target_file)
end
end
end
desc 'Generate Python documentation'
task :docs, [:skip_update] do |_task, arguments|
FileUtils.rm_rf('build/docs/api/py/')
FileUtils.rm_rf('build/docs/doctrees/')
begin
sh 'tox -c py/tox.ini -e docs', verbose: true
rescue StandardError
puts 'Ensure that tox is installed on your system'
raise
end
unless arguments[:skip_update]
puts "Updating Python documentation"
puts update_gh_pages ? "Python Docs updated!" : "Python Doc update cancelled"
end
end
desc 'Install Python wheel locally'
task :install do
Bazel.execute('build', [], '//py:selenium-wheel')
begin
sh 'pip install bazel-bin/py/selenium-*.whl'
rescue StandardError
puts 'Ensure that Python and pip are installed on your system'
raise
end
end
desc 'Update Python changelog'
task :changelog do
header = "Selenium #{python_version}"
update_changelog(python_version, 'py', 'py/selenium/webdriver', 'py/CHANGES', header)
end
desc 'Update Python version'
task :version, [:version] do |_task, arguments|
bump_nightly = arguments[:version] === 'nightly'
old_version = python_version
new_version = nil
# There are three cases we want to deal with:
# 1. Switching from a release build to a nightly one
# 2. Updating a nightly build for the next nightly build
# 3. Switching from nightlies to a release build.
if bump_nightly && old_version.include?('.dev')
# This is the case where we are updating a nightly build to the next nightly build.
# This change is usually done by the CI system and never committed.
# The ".dev" is removed to have the pushed package in TestPyPi be shown as latest.
new_version = old_version.gsub(/\.dev\d+$/, '') + + ".#{Time.now.strftime("%Y%m%d%H%M")}"
elsif bump_nightly
# This is the case after a production release and the version number is configured
# to start doing nightly builds.
new_version = old_version + ".dev#{Time.now.strftime("%Y%m%d%H%M")}"
else
if old_version.include?('.dev')
new_version = old_version.gsub(/\.dev\d+$/, '')
else
new_version = updated_version(old_version.gsub(/\.dev\d+$/, ''), arguments[:version])
new_version = new_version + ".dev#{Time.now.strftime("%Y%m%d%H%M")}"
end
end
['py/setup.py',
'py/BUILD.bazel',
'py/selenium/__init__.py',
'py/selenium/webdriver/__init__.py',
'py/docs/source/conf.py'].each do |file|
text = File.read(file).gsub(old_version, new_version)
File.open(file, "w") { |f| f.puts text }
end
old_short_version = old_version.split('.')[0..1].join('.')
new_short_version = new_version.split('.')[0..1].join('.')
text = File.read('py/docs/source/conf.py').gsub(old_short_version, new_short_version)
File.open('py/docs/source/conf.py', "w") { |f| f.puts text }
Rake::Task['py:changelog'].invoke unless new_version.include?('.dev') || bump_nightly
end
desc 'Update Python Syntax'
task :lint do
sh 'tox -c py/tox.ini -e linting'
end
namespace :test do
desc 'Python unit tests'
task :unit do
Rake::Task['py:clean'].invoke
Bazel.execute('test', ['--test_size_filters=small'], '//py/...')
end
%i[chrome edge firefox safari].each do |browser|
desc "Python #{browser} tests"
task browser do
Rake::Task['py:clean'].invoke
Bazel.execute('test', [],"//py:common-#{browser}")
Bazel.execute('test', [],"//py:test-#{browser}")
end
end
desc "Python Remote tests with Firefox"
task :remote do
Rake::Task['py:clean'].invoke
Bazel.execute('test', [],"//py:test-remote")
end
end
namespace :test do
desc 'Python unit tests'
task :unit do
Rake::Task['py:clean'].invoke
Bazel.execute('test', ['--test_size_filters=small'], '//py/...')
end
%i[chrome edge firefox safari].each do |browser|
desc "Python #{browser} tests"
task browser do
Rake::Task['py:clean'].invoke
Bazel.execute('test', %w[--test_output all],"//py:common-#{browser}")
Bazel.execute('test', %w[--test_output all],"//py:test-#{browser}")
end
end
end
end
def ruby_version
File.foreach('rb/lib/selenium/webdriver/version.rb') do |line|
return line.split('=').last.strip.tr("'", '') if line.include?('VERSION')
end
end
namespace :rb do
desc 'Generate Ruby gems'
task :build, [:args] do |_task, arguments|
args = Array(arguments[:args]) || []
webdriver = args.reject! { |item| item == 'webdriver' }
devtools = args.reject! { |item| item == 'devtools' }
Bazel.execute('build', args, '//rb:selenium-webdriver') if webdriver
Bazel.execute('build', args, '//rb:selenium-devtools') if devtools
end
desc 'Update generated Ruby files for local development'
task :local_dev do
Bazel.execute('build', [], '@bundle//:bundle')
Rake::Task['rb:build'].invoke
Rake::Task['grid'].invoke
end
desc 'Push Ruby gems to rubygems'
task :release, [:args] do |_task, arguments|
args = Array(arguments[:args]) || ['--stamp']
Bazel.execute('run', args, '//rb:selenium-webdriver-release')
Bazel.execute('run', args, '//rb:selenium-devtools-release')
end
desc 'Generate Ruby documentation'
task :docs, [:skip_update] do |_task, arguments|
FileUtils.rm_rf('build/docs/api/rb/')
Bazel.execute('run', [], '//rb:docs')
FileUtils.mkdir_p('build/docs/api')
FileUtils.cp_r('bazel-bin/rb/docs.sh.runfiles/_main/docs/api/rb/.', 'build/docs/api/rb')
unless arguments[:skip_update]
puts "Updating Ruby documentation"
puts update_gh_pages ? "Ruby Docs updated!" : "Ruby Doc update cancelled"
end
end
desc 'Update Ruby changelog'
task :changelog do
header = "#{ruby_version} (#{Time.now.strftime("%Y-%m-%d")})\n========================="
update_changelog(ruby_version, 'rb', 'rb/lib/', 'rb/CHANGES', header)
end
desc 'Update Ruby version'
task :version, [:version] do |_task, arguments|
old_version = ruby_version
new_version = updated_version(old_version, arguments[:version])
new_version += '.nightly' unless old_version.include?('nightly')
file = 'rb/lib/selenium/webdriver/version.rb'
text = File.read(file).gsub(old_version, new_version)
File.open(file, "w") { |f| f.puts text }
Rake::Task['rb:changelog'].invoke unless new_version.include?('nightly')
sh 'cd rb && bundle --version && bundle update'
end
desc 'Update Ruby Syntax'
task :lint do
`cd rb && bundle exec rubocop -a`
end
end
def dotnet_version
File.foreach('dotnet/selenium-dotnet-version.bzl') do |line|
return line.split('=').last.strip.tr('"', '') if line.include?('SE_VERSION')
end
end
namespace :dotnet do
desc 'Build nupkg files'
task :build, [:args] do |_task, arguments|
args = Array(arguments[:args]) || []
Bazel.execute('build', args, '//dotnet:all')
end
desc 'Create zipped assets for .NET for uploading to GitHub'
task :zip_assets, [:args] do |_task, arguments|
args = Array(arguments[:args]) || ['--stamp']
Rake::Task['dotnet:build'].invoke(args)
mkdir_p 'build/dist'
FileUtils.rm_f('build/dist/*dotnet*')
FileUtils.copy('bazel-bin/dotnet/release.zip', "build/dist/selenium-dotnet-#{dotnet_version}.zip")
FileUtils.chmod(0666, "build/dist/selenium-dotnet-#{dotnet_version}.zip")
FileUtils.copy('bazel-bin/dotnet/strongnamed.zip', "build/dist/selenium-dotnet-strongnamed-#{dotnet_version}.zip")
FileUtils.chmod(0666, "build/dist/selenium-dotnet-strongnamed-#{dotnet_version}.zip")
end
desc 'Upload nupkg files to Nuget'
task :release, [:args] do |_task, arguments|
args = Array(arguments[:args]) || ['--stamp']
Rake::Task['dotnet:build'].invoke(args)
Rake::Task['dotnet:zip_assets'].invoke(args)
release_version = dotnet_version
api_key = ENV.fetch('NUGET_API_KEY', nil)
push_destination = 'https://api.nuget.org/v3/index.json'
if release_version.include?('-nightly')
# Nightly builds are pushed to GitHub NuGet repository
# This commands will run in GitHub Actions
api_key = ENV.fetch('GITHUB_TOKEN', nil)
github_push_url = 'https://nuget.pkg.github.com/seleniumhq/index.json'
push_destination = 'github'
sh "dotnet nuget add source --username seleniumhq --password #{api_key} --store-password-in-clear-text --name #{push_destination} #{github_push_url}"
end
["./bazel-bin/dotnet/src/webdriver/Selenium.WebDriver.#{dotnet_version}.nupkg",
"./bazel-bin/dotnet/src/support/Selenium.Support.#{dotnet_version}.nupkg"].each do |asset|
sh "dotnet nuget push #{asset} --api-key #{api_key} --source #{push_destination}"
end
end
desc 'Generate .NET documentation'
task :docs, [:skip_update] do |_task, arguments|
FileUtils.rm_rf('build/docs/api/dotnet/')
begin
sh 'dotnet tool update -g docfx'
rescue StandardError
puts 'Please ensure that .NET SDK is installed.'
raise
end
begin
sh 'docfx dotnet/docs/docfx.json'
rescue StandardError
case $CHILD_STATUS.exitstatus
when 127
raise 'Ensure the dotnet/tools directory is added to your PATH environment variable (e.g., `~/.dotnet/tools`)'
when 255
puts '.NET documentation build failed, likely because of DevTools namespacing. This is ok; continuing'
else
raise
end
end
unless arguments[:skip_update]
puts "Updating .NET documentation"
puts update_gh_pages ? ".NET Docs updated!" : ".NET Doc update cancelled"
end
end
desc 'Update .NET changelog'
task :changelog do
header = "v#{dotnet_version}\n======"
update_changelog(dotnet_version, 'dotnet', 'dotnet/src/', 'dotnet/CHANGELOG', header)
end
desc 'Update .NET version'
task :version, [:version] do |_task, arguments|
bump_nightly = arguments[:version] === 'nightly'
old_version = dotnet_version
new_version = nil
# There are three cases we want to deal with:
# 1. Switching from a release build to a nightly one
# 2. Updating a nightly build for the next nightly build
# 3. Switching from nightlies to a release build.
if bump_nightly && old_version.include?('-nightly')
# This is the case where we are updating a nightly build to the next nightly build.
# This change is usually done by the CI system and never committed.
# The "-nightlyYmdHM" is removed to add a new timestamp.
new_version = old_version.gsub(/\-nightly\d+$/, '') + "-nightly#{Time.now.strftime("%Y%m%d%H%M")}"
elsif bump_nightly
# This is the case after a production release and the version number is configured
# to start doing nightly builds.
new_version = old_version + "-nightly#{Time.now.strftime("%Y%m%d%H%M")}"
else
if old_version.include?('-nightly')
new_version = old_version.gsub(/\-nightly\d+$/, '')
else
new_version = updated_version(old_version.gsub(/\-nightly\d+$/, ''), arguments[:version])
new_version = new_version + "-nightly#{Time.now.strftime("%Y%m%d%H%M")}"
end
end
file = 'dotnet/selenium-dotnet-version.bzl'
text = File.read(file).gsub(old_version, new_version)
File.open(file, "w") { |f| f.puts text }
Rake::Task['dotnet:changelog'].invoke unless new_version.include?('-nightly') || bump_nightly
end
end
namespace :java do
desc 'Build Java Client Jars'
task :build, [:args] do |_task, arguments|
args = Array(arguments[:args]) || []
Bazel.execute('build', args, '//java/src/org/openqa/selenium:client-combined')
end
desc 'Build Grid Jar'
task :grid, [:args] do |_task, arguments|
args = Array(arguments[:args]) || []
Bazel.execute('build', args, '//java/src/org/openqa/selenium/grid:grid')
end
desc 'Package Java bindings and grid into releasable packages'
task :package, [:args] do |_task, arguments|
args = Array(arguments[:args]) || []
Rake::Task['java:build'].invoke(args)
Rake::Task['java-release-zip'].invoke
end
desc 'Deploy all jars to Maven'
task :release, [:args] do |_task, arguments|
args = Array(arguments[:args]) || ['--stamp']
Rake::Task['java:package'].invoke(args)
Rake::Task['publish-maven'].invoke
end
desc 'Install jars to local m2 directory'
task install: :'maven-install'
desc 'Generate Java documentation'
task :docs, [:skip_update] do |_task, arguments|
Rake::Task['javadocs'].invoke
unless arguments[:skip_update]
puts "Updating Java documentation"
puts update_gh_pages ? "Java Docs updated!" : "Java Doc update cancelled"
end
end
desc 'Update Maven dependencies'
task :update do
# Make sure things are in a good state to start with
args = ['--action_env=RULES_JVM_EXTERNAL_REPIN=1']
Bazel.execute('run', args, '@unpinned_maven//:pin')
file_path = 'MODULE.bazel'
content = File.read(file_path)
# For some reason ./go wrapper is not outputting from Open3, so cannot use Bazel class directly
output = `bazel run @maven//:outdated`
output.scan(/\S+ \[\S+-alpha\]/).each do |match|
puts "WARNING — Cannot automatically update alpha version of: #{match}"
end
versions = output.scan(/(\S+) \[\S+ -> (\S+)\]/).to_h
versions.each do |artifact, version|
if artifact.match?('graphql')
puts "WARNING — Cannot automatically update graphql"
next
end
replacement = artifact.include?('googlejavaformat') ? "#{artifact}:jar:#{version}" : "#{artifact}:#{version}"
content.gsub!(/#{artifact}:(jar:)?\d+\.\d+[^\\"]+/, replacement)
end
File.write(file_path, content)
args = ['--action_env=RULES_JVM_EXTERNAL_REPIN=1']
Bazel.execute('run', args, '@unpinned_maven//:pin')
end