-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add ExposedPort class with port/protocol fields, move exposed port co…
…nfig-related parsing to frontend class (#449)
- Loading branch information
Showing
12 changed files
with
272 additions
and
138 deletions.
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
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
54 changes: 54 additions & 0 deletions
54
jib-core/src/main/java/com/google/cloud/tools/jib/configuration/PortWithProtocol.java
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,54 @@ | ||
| /* | ||
| * Copyright 2018 Google LLC. All rights reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); you may not | ||
| * use this file except in compliance with the License. You may obtain a copy of | ||
| * the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT | ||
| * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the | ||
| * License for the specific language governing permissions and limitations under | ||
| * the License. | ||
| */ | ||
|
|
||
| package com.google.cloud.tools.jib.configuration; | ||
|
|
||
| /** Holds port number and protocol for an exposed port. */ | ||
| public class PortWithProtocol { | ||
|
|
||
| /** Represents the protocol portion of the port. */ | ||
| public enum Protocol { | ||
| TCP("tcp"), | ||
| UDP("udp"); | ||
|
|
||
| private final String stringRepresentation; | ||
|
|
||
| Protocol(String stringRepresentation) { | ||
| this.stringRepresentation = stringRepresentation; | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return stringRepresentation; | ||
| } | ||
| } | ||
|
|
||
| private final int port; | ||
| private final Protocol protocol; | ||
|
|
||
| public PortWithProtocol(int port, Protocol protocol) { | ||
| this.port = port; | ||
| this.protocol = protocol; | ||
| } | ||
|
|
||
| public int getPort() { | ||
| return port; | ||
| } | ||
|
|
||
| public Protocol getProtocol() { | ||
| return protocol; | ||
| } | ||
| } |
98 changes: 98 additions & 0 deletions
98
jib-core/src/main/java/com/google/cloud/tools/jib/frontend/ExposedPortsParser.java
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,98 @@ | ||
| /* | ||
| * Copyright 2018 Google LLC. All rights reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); you may not | ||
| * use this file except in compliance with the License. You may obtain a copy of | ||
| * the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT | ||
| * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the | ||
| * License for the specific language governing permissions and limitations under | ||
| * the License. | ||
| */ | ||
|
|
||
| package com.google.cloud.tools.jib.frontend; | ||
|
|
||
| import com.google.cloud.tools.jib.builder.BuildLogger; | ||
| import com.google.cloud.tools.jib.configuration.PortWithProtocol; | ||
| import com.google.common.annotations.VisibleForTesting; | ||
| import com.google.common.base.Strings; | ||
| import com.google.common.collect.ImmutableList; | ||
| import java.util.List; | ||
| import java.util.regex.Matcher; | ||
| import java.util.regex.Pattern; | ||
|
|
||
| public class ExposedPortsParser { | ||
|
|
||
| /** | ||
| * Pattern used for parsing information out of exposed port configurations. | ||
| * | ||
| * <p>Examples: 100, 200-210, 1000/tcp, 2000/udp, 500-600/tcp | ||
| */ | ||
| private static final Pattern portPattern = Pattern.compile("(\\d+)(?:-(\\d+))?(/tcp|/udp)?"); | ||
|
|
||
| /** | ||
| * TODO: Return list of {@link PortWithProtocol}s instead of strings | ||
| * | ||
| * <p>Converts/validates a list of ports with ranges to an expanded form without ranges. | ||
| * | ||
| * <p>Example: {@code ["1000/tcp", "2000-2002/tcp"] -> ["1000/tcp", "2000/tcp", "2001/tcp", | ||
| * "2002/tcp"]} | ||
| * | ||
| * @param ports the list of port numbers/ranges | ||
| * @param buildLogger used to log warning messages | ||
| * @return the ports as a list of integers | ||
| * @throws NumberFormatException if any of the ports are in an invalid format or out of range | ||
| */ | ||
| @VisibleForTesting | ||
| public static ImmutableList<String> parse(List<String> ports, BuildLogger buildLogger) | ||
| throws NumberFormatException { | ||
| ImmutableList.Builder<String> result = new ImmutableList.Builder<>(); | ||
|
|
||
| for (String port : ports) { | ||
| Matcher matcher = portPattern.matcher(port); | ||
|
|
||
| if (!matcher.matches()) { | ||
| throw new NumberFormatException( | ||
| "Invalid port configuration: '" | ||
| + port | ||
| + "'. Make sure the port is a single number or a range of two numbers separated " | ||
| + "with a '-', with or without protocol specified (e.g. '<portNum>/tcp' or " | ||
| + "'<portNum>/udp')."); | ||
| } | ||
|
|
||
| // Parse protocol | ||
| int min = Integer.parseInt(matcher.group(1)); | ||
| int max = min; | ||
| if (!Strings.isNullOrEmpty(matcher.group(2))) { | ||
| max = Integer.parseInt(matcher.group(2)); | ||
| } | ||
| String protocol = matcher.group(3); | ||
|
|
||
| // Error if configured as 'max-min' instead of 'min-max' | ||
| if (min > max) { | ||
| throw new NumberFormatException( | ||
| "Invalid port range '" + port + "'; smaller number must come first."); | ||
| } | ||
|
|
||
| // Warn for possibly invalid port numbers | ||
| if (min < 1 || max > 65535) { | ||
| // TODO: Add details/use HelpfulSuggestions for these warnings | ||
| buildLogger.warn("Port number '" + port + "' is out of usual range (1-65535)."); | ||
| } | ||
|
|
||
| // Add all numbers in range to list | ||
| String portString = (protocol == null ? "" : protocol); | ||
| for (int portNum = min; portNum <= max; portNum++) { | ||
| result.add(portNum + portString); | ||
| } | ||
| } | ||
|
|
||
| return result.build(); | ||
| } | ||
|
|
||
| private ExposedPortsParser() {} | ||
| } |
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
Oops, something went wrong.