-
Notifications
You must be signed in to change notification settings - Fork 45
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add a NtpSetup installation dialog #791
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
12819ba
Add the `NtpServer` widget
dgdavid 22fa5d4
Add the `NtpSetup` dialog
dgdavid 191472e
Add yast2-ntp-client build dependency
dgdavid 829f8d2
Update textdomains
dgdavid 9b739bb
Update version and changelog
dgdavid d4f91a4
Update from code review
lslezak 64d781f
Travis fix
lslezak f90b25e
Merge remote-tracking branch 'origin/master' into feature/ntp-setup
lslezak File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,4 @@ | ||
FROM registry.opensuse.org/yast/head/containers/yast-ruby:latest | ||
RUN zypper --non-interactive in --no-recommends yast2-ntp-client | ||
COPY . /usr/src/app | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
require "yast" | ||
|
||
require "installation/dialogs/ntp_setup" | ||
|
||
::Installation::Dialogs::NtpSetup.run |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,121 @@ | ||
# encoding: utf-8 | ||
|
||
# ------------------------------------------------------------------------------ | ||
# Copyright (c) 2019 SUSE LLC | ||
# | ||
# | ||
# This program is free software; you can redistribute it and/or modify it under | ||
# the terms of version 2 of the GNU General Public License as published by the | ||
# Free Software Foundation. | ||
# | ||
# This program is distributed in the hope that it will be useful, but WITHOUT | ||
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS | ||
# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. | ||
# | ||
# You should have received a copy of the GNU General Public License along with | ||
# this program; if not, contact SUSE. | ||
# | ||
# To contact SUSE about this file by physical or electronic mail, you may find | ||
# current contact information at www.suse.com. | ||
# ------------------------------------------------------------------------------ | ||
|
||
require "yast" | ||
require "cwm/dialog" | ||
require "installation/widgets/ntp_server" | ||
|
||
module Installation | ||
module Dialogs | ||
# Simple dialog for settings the NTP server names | ||
class NtpSetup < CWM::Dialog | ||
def initialize | ||
textdomain "installation" | ||
|
||
Yast.import "Lan" | ||
Yast.import "LanItems" | ||
Yast.import "Product" | ||
Yast.import "ProductFeatures" | ||
|
||
super | ||
end | ||
|
||
# The dialog title | ||
# | ||
# @return [String] the title | ||
def title | ||
# TRANSLATORS: dialog title | ||
_("NTP Setup") | ||
end | ||
|
||
def contents | ||
return @content if @content | ||
|
||
@content = HSquash( | ||
MinWidth( | ||
50, | ||
# preselect the servers from the DHCP response | ||
Widgets::NtpServer.new(ntp_servers) | ||
) | ||
) | ||
end | ||
|
||
private | ||
|
||
# Propose the NTP servers from the DHCP response, fallback to a random | ||
# machine from the ntp.org pool if enabled in control.xml. | ||
# | ||
# @return [Array<String>] proposed NTP servers, empty if nothing suitable found | ||
def ntp_servers | ||
# TODO: use Yast::NtpClient.ntp_conf if configured | ||
# to better handle going back | ||
servers = dhcp_ntp_servers | ||
servers = [ntp_fallback] if servers.empty? && default_ntp_setup_enabled? | ||
|
||
servers | ||
end | ||
|
||
# List of NTP servers from DHCP | ||
# | ||
# @return [Array<String>] List of servers (IP or host names), empty if not provided | ||
def dhcp_ntp_servers | ||
# When proposing NTP servers we need to know | ||
# | ||
# 1) list of (dhcp) interfaces | ||
# 2) network service in use | ||
# | ||
# We can either use networking submodule for network service handling and get list of | ||
# interfaces e.g. using a bash command or initialize whole networking module. | ||
Yast::Lan.ReadWithCacheNoGUI | ||
|
||
Yast::LanItems.dhcp_ntp_servers.values.flatten.uniq | ||
end | ||
|
||
# Whether the a default (fallback) NTP setup is enabled in the control.xml | ||
# | ||
# @return [Boolean] | ||
def default_ntp_setup_enabled? | ||
Yast::ProductFeatures.GetBooleanFeature("globals", "default_ntp_setup") | ||
end | ||
|
||
# The fallback servers for NTP configuration | ||
# | ||
# It propose a random pool server in range 0..3 | ||
# | ||
# @return [String] the fallback servers | ||
def ntp_fallback | ||
"#{rand(4)}.#{ntp_host}.pool.ntp.org" | ||
end | ||
|
||
def ntp_host | ||
# copied from timezone/dialogs.rb: | ||
base_products = Yast::Product.FindBaseProducts | ||
|
||
if base_products.any? { |p| p["name"] =~ /openSUSE/i } | ||
"opensuse" | ||
else | ||
# TODO: use a SUSE server when available in the future | ||
schubi2 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
"novell" | ||
end | ||
end | ||
end | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,143 @@ | ||
# encoding: utf-8 | ||
|
||
# ------------------------------------------------------------------------------ | ||
# Copyright (c) 2019 SUSE LLC | ||
# | ||
# | ||
# This program is free software; you can redistribute it and/or modify it under | ||
# the terms of version 2 of the GNU General Public License as published by the | ||
# Free Software Foundation. | ||
# | ||
# This program is distributed in the hope that it will be useful, but WITHOUT | ||
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS | ||
# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. | ||
# | ||
# You should have received a copy of the GNU General Public License along with | ||
# this program; if not, contact SUSE. | ||
# | ||
# To contact SUSE about this file by physical or electronic mail, you may find | ||
# current contact information at www.suse.com. | ||
# ------------------------------------------------------------------------------ | ||
|
||
require "yast" | ||
require "cwm/widget" | ||
require "installation/system_role" | ||
|
||
Yast.import "CWM" | ||
Yast.import "Popup" | ||
Yast.import "Label" | ||
Yast.import "IP" | ||
Yast.import "Hostname" | ||
Yast.import "NtpClient" | ||
|
||
module Installation | ||
module Widgets | ||
# This widget is responsible of validating and storing the NTP server to use. | ||
class NtpServer < CWM::InputField | ||
extend Yast::I18n | ||
|
||
# @return [Array<String>] List of default servers | ||
attr_reader :default_servers | ||
|
||
# Constructor | ||
# | ||
# @param default_servers [Array<String>] List of servers | ||
def initialize(default_servers = []) | ||
textdomain "installation" | ||
|
||
@default_servers = default_servers | ||
end | ||
|
||
# @return [String] Widget's label | ||
def label | ||
# TRANSLATORS: input field label | ||
_("N&TP Servers (comma or space separated)") | ||
end | ||
|
||
# Store the value of the input field if validates | ||
def store | ||
if servers.empty? | ||
# we need to reset the previous settings after going back | ||
Yast::NtpClient.ntp_selected = false | ||
Yast::NtpClient.modified = false | ||
|
||
return | ||
end | ||
|
||
Yast::NtpClient.ntp_selected = true | ||
Yast::NtpClient.modified = true | ||
Yast::NtpClient.ntp_conf.clear_pools | ||
servers.each { |server| Yast::NtpClient.ntp_conf.add_pool(server) } | ||
# run NTP as a service (not via cron) | ||
Yast::NtpClient.run_service = true | ||
Yast::NtpClient.synchronize_time = false | ||
end | ||
|
||
# Initializes the widget's value | ||
def init | ||
saved_servers = (role && role["ntp_servers"]) || default_servers | ||
self.value = saved_servers.join(" ") | ||
end | ||
|
||
NOT_VALID_SERVERS_MESSAGE = N_("Not valid location for the NTP servers:\n%{servers}" \ | ||
"\n\nPlease, enter a valid IP or Hostname").freeze | ||
# Validate input | ||
# | ||
# * All specified IPs or hostnames should be valid | ||
# * If no server is specified, ask the user whether proceed with installation or not | ||
# | ||
# @return [Boolean] true if value is valid; false otherwise. | ||
def validate | ||
return skip_ntp_server? if servers.empty? | ||
invalid_servers = servers.reject { |v| Yast::IP.Check(v) || Yast::Hostname.CheckFQ(v) } | ||
return true if invalid_servers.empty? | ||
Yast::Popup.Error( | ||
format(_(NOT_VALID_SERVERS_MESSAGE), servers: invalid_servers.join(", ")) | ||
) | ||
|
||
false | ||
end | ||
|
||
def help | ||
# TRANSLATORS: a help text for the NTP server input field | ||
_("<h3>NTP Servers</h3>") + | ||
# TRANSLATORS: a help text for the NTP server input field | ||
_("<p>Enter the host name or the IP address of the NTP server which will be used for " \ | ||
"synchronizing the time on this machine</p>") + | ||
# TRANSLATORS: a help text for the NTP server input field | ||
_("<p>Use comma (,) or space to separate multiple values.</p>") | ||
end | ||
|
||
private | ||
|
||
# Parse the widget's value an return the potential list of hostnames/addresses | ||
# | ||
# @return [Array<String>] List of hostnames/addresses | ||
def servers | ||
value.to_s.tr(",", " ").split(" ") | ||
end | ||
|
||
# Check if the user wants to intentionally skip the NTP server configuration | ||
# | ||
# @return [Boolean] true if user wants to skip it; false otherwise. | ||
def skip_ntp_server? | ||
Yast::Popup.AnyQuestion( | ||
_("NTP Servers"), | ||
# TRANSLATORS: error message for invalid ntp server name/address | ||
_("You have not configured an NTP server. This may lead to\n" \ | ||
"your system not functioning properly.\n" \ | ||
"Proceed with caution and at your own risk.\n\n" \ | ||
"Would you like to continue with the installation?"), | ||
Yast::Label.YesButton, | ||
Yast::Label.NoButton, | ||
:yes | ||
) | ||
end | ||
|
||
# Return the current role | ||
def role | ||
::Installation::SystemRole.current_role | ||
end | ||
end | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
#! /usr/bin/env rspec | ||
|
||
require_relative "../test_helper.rb" | ||
require "cwm/rspec" | ||
|
||
require "installation/dialogs/ntp_setup" | ||
|
||
Yast.import "CWM" | ||
Yast.import "Lan" | ||
Yast.import "Wizard" | ||
|
||
describe ::Installation::Dialogs::NtpSetup do | ||
describe "#run" do | ||
let(:ntp_servers) { [] } | ||
|
||
before do | ||
allow(Yast::Wizard).to receive(:CreateDialog) | ||
allow(Yast::Wizard).to receive(:CloseDialog) | ||
allow(Yast::CWM).to receive(:show).and_return(:next) | ||
allow(Yast::Lan).to receive(:ReadWithCacheNoGUI) | ||
allow(Yast::LanItems).to receive(:dhcp_ntp_servers).and_return({}) | ||
allow(Yast::ProductFeatures).to receive(:GetBooleanFeature) | ||
end | ||
|
||
include_examples "CWM::Dialog" | ||
|
||
context "when some NTP server is detected via DHCP" do | ||
let(:ntp_servers) { ["ntp.example.com"] } | ||
|
||
it "proposes to use it by default" do | ||
expect(Yast::LanItems).to receive(:dhcp_ntp_servers).and_return("eth0" => ntp_servers) | ||
expect(::Installation::Widgets::NtpServer).to receive(:new) | ||
.with(ntp_servers).and_call_original | ||
subject.run | ||
end | ||
end | ||
|
||
context "no NTP server set in DHCP and default NTP is enabled in control.xml" do | ||
before do | ||
allow(Yast::ProductFeatures).to receive(:GetBooleanFeature) | ||
.with("globals", "default_ntp_setup").and_return(true) | ||
allow(Yast::Product).to receive(:FindBaseProducts) | ||
.and_return(["name" => "openSUSE-Tumbleweed-Kubic"]) | ||
end | ||
|
||
it "proposes to use a random openSUSE pool server" do | ||
expect(::Installation::Widgets::NtpServer).to receive(:new).and_wrap_original do |original, arg| | ||
expect(arg.first).to match(/\A[0-3]\.opensuse\.pool\.ntp\.org\z/) | ||
original.call(arg) | ||
end | ||
subject.run | ||
end | ||
end | ||
end | ||
end |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I do not understand this
TODO
comment. I mean, it is not clear to me if we can do what it is stated there or simply keep the current behavior and also deTODO
comment.@lslezak it seems that you wrote it originally. Any suggestion?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IIRC that value is set in the time zone configuration (if you go to the details and configure the NTP server there), so there a small duplication.
For now I'd just move it without further changes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So, keep it as it is, right?