mhoppa opened a new pull request #4379: Rewrite isos to Golang URL: https://github.com/apache/trafficcontrol/pull/4379 <!-- ************ STOP!! ************ If this Pull Request is intended to fix a security vulnerability, DO NOT submit it! Instead, contact the Apache Software Foundation Security Team at [email protected] and follow the guidelines at https://www.apache.org/security/ regarding vulnerability disclosure. --> ## What does this PR (Pull Request) do? <!-- Explain the changes you made here. If this fixes an Issue, identify it by replacing the text in the checkbox item with the Issue number e.g. - [x] This PR fixes #9001 OR is not related to any Issue ^ This will automatically close Issue number 9001 when the Pull Request is merged (The '#' is important). Be sure you check the box properly, see the "The following criteria are ALL met by this PR" section for details. --> - [x] This PR fixes #3801 such that the /isos handler has been rewritten in Go ## Which Traffic Control components are affected by this PR? <!-- Please delete all components from this list that are NOT affected by this Pull Request. Also, feel free to add the name of a tool or script that is affected but not on the list. Additionally, if this Pull Request does NOT affect documentation, please explain why documentation is not required. --> - CDN in a Box - Documentation - Traffic Ops ## What is the best way to verify this PR? <!-- Please include here ALL the steps necessary to test your Pull Request. If it includes tests (and most should), outline here the steps needed to run the tests. If not, lay out the manual testing procedure and please explain why tests are unnecessary for this Pull Request. --> Build TO binary with changes and then generate an iso. ## If this is a bug fix, what versions of Traffic Control are affected? <!-- If this PR fixes a bug, please list here all of the affected versions - to the best of your knowledge. It's also pretty helpful to include a commit hash of where 'master' is at the time this PR is opened (if it affects master), because what 'master' means will change over time. For example, if this PR fixes a bug that's present in master (at commit hash '2697ebac'), in v3.0.0, and in the current 3.0.1 Release candidate (e.g. RC1), then this list would look like: - master (2697ebac) - 3.0.0 - 3.0.1 (RC1) If you don't know what other versions might have this bug, AND don't know how to find the commit hash of 'master', then feel free to leave this section blank (or, preferably, delete it entirely). --> ## The following criteria are ALL met by this PR <!-- Check the boxes to signify that the associated statement is true. To "check a box", replace the space inside of the square brackets with an 'x'. e.g. - [ x] <- Wrong - [x ] <- Wrong - [] <- Wrong - [*] <- Wrong - [x] <- Correct! --> - [x] This PR includes tests OR I have explained why tests are unnecessary - [x] This PR includes documentation OR I have explained why documentation is unnecessary - [x] This PR includes an update to CHANGELOG.md OR such an update is not necessary - [x] This PR includes any and all required license headers - [x] This PR ensures that database migration sequence is correct OR this PR does not include a database migration - [x] This PR **DOES NOT FIX A SERIOUS SECURITY VULNERABILITY** (see [the Apache Software Foundation's security guidelines](https://www.apache.org/security/) for details) ## Additional Information <!-- If you would like to include any additional information on the PR for potential reviewers please put it here. Some examples of this would be: - Before and after screenshots/gifs of the Traffic Portal if it is affected - Links to other dependent Pull Requests - References to relevant context (e.g. new/updates to dependent libraries, mailing list records, blueprints) Feel free to leave this section blank (or, preferably, delete it entirely). --> <!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you 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. --> This PR is based off of #4203 - The Go version of the endpoint attempts to produce the same behavior as the Perl version, with the following exceptions: - The Go endpoint does not support non-streaming downloads. In Perl, non-streaming downloads worked by saving the ISO image to the server's disk and returning to the requesting client a URL that allowed them to download that file at a later time. If a non-streaming request is made to the Go endpoint, it returns an error in the standard JSON response structure. This was discussed on the dev mailing list under the Proposal: Only allow streaming downloads of ISOs subject. It was decided that this is a breaking API change, and therefore the Go API should be a version 2.0 endpoint. - In a number of error cases, the Perl version returns HTML. The Go version returns JSON alerts in these cases, for example when executing the mkisofs command fails. - The Perl version, when streaming the response, would fail silently if the subprocess failed (code). The Go version returns an error to the user in this case. - When creating the mgmt_network.cfg file, the Perl version does not quote the DEVICE value (code), while the Go version does. - This PR adds a new Go library (https://github.com/GehirnInc/crypt). Relevant discussion on the mailing list was under message with subject: Proposal to add GehirnInc/crypt library - The mkisofs package could be added to the TrafficOps Go Docker container as part of ciab. - It's likely that custom generate scripts will use the implantisomd5 program provided on Centos by the isomd5sum package. The mkisofs package is already a requirement of the TrafficOps RPM, so we should considering making isomd5sum a requirement as well. - There's a cronjob (./traffic_ops/etc/cron.d/trafops_clean_isos) that removes stale ISO files. This isn't necessary for the Go version of this endpoint. Once the Perl endpoint becomes obsolete, it can likely be deleted. The Go version does no store copies of the ISO images, therefore there's no cleanup necessary.
---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
